MDSAPI Portal/IZII MDS — Orquestrador de Benefícios (REST)
get

Obter status de uma movimentação

/v1/movimentacoes/{id}

Retorna o status atual de uma movimentação pelo seu protocolo/ID.

Path Parameters

idstringrequired

Protocolo/ID da movimentação.

Headers

X-Cnpj-Provedorstringrequired

CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.

Responses

200

Movimentação encontrada.

object

Status/histórico de uma movimentação cadastral.

idstring
protocolostring

Protocolo/ID de rastreio gerado pela operadora.

nomestring
cpfstring
tipoMovimentostring

Inclusão, Alteração, Exclusão, Troca de Plano, Reativação.

dataMovimentacaostringdate-time
statusMovimentacaostring

Status traduzido (ex. "Processado com Sucesso", "Rejeitado").

numeroCarteirinhastring
criticasarray

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring
401

Token ausente, expirado ou inválido.

object

Estrutura padronizada de erro.

statusinteger

Código HTTP do erro.

codigostring

Código interno do erro.

mensagemstring

Descrição legível do erro.

criticasarray

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring
404

Recurso não encontrado.

object

Estrutura padronizada de erro.

statusinteger

Código HTTP do erro.

codigostring

Código interno do erro.

mensagemstring

Descrição legível do erro.

criticasarray

items

object

Crítica/erro de validação devolvido pela operadora.

codigostring
campostring
mensagemstring