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

Consultar status de movimentações

/v1/movimentacoes

*Tracking* passivo do status das movimentações cadastrais enviadas previamente. > **USE A CONSULTA POR PROTOCOLO.** Verificado em 16/07/2026 (inclusive > direto no Orquestrador, sem a fachada): o backend só aplica o filtro > por **código da movimentação** (protocolo). O filtro `cpf` é > **ignorado** e a consulta sem filtro retorna um registro default > antigo. Fluxo correto: guarde o `protocolo` retornado na > inclusão/exclusão e consulte `GET /v1/movimentacoes/{protocolo}`. > Os demais filtros abaixo constam do contrato mas **não são aplicados > pelo upstream** hoje.

Query Parameters

apolicestring

Número da apólice/contrato.

empresastring

CNPJ/identificador da empresa estipulante.

cpfstring

CPF do titular.

cpfDependentestring

CPF de um dependente específico.

dataMovimentacaostring

Data (ou início do período) da movimentação (YYYY-MM-DD).

statusstring

Filtra por status da movimentação.

Headers

X-Cnpj-Provedorstringrequired

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

ex: 01685053000156

Responses

200

Resposta traduzida do Orquestrador no shape `MovimentacaoResultado` (**não há paginação**). Como o upstream não aplica os filtros desta rota, o conteúdo pode não corresponder ao CPF consultado; use a consulta por protocolo.

object

Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.

statusinteger

Código HTTP resultante do processamento na operadora.

protocolostring

Protocolo de rastreio gerado pela operadora.

statusMovimentacaostring
beneficiarioobject

Resumo do beneficiário afetado. Campos conforme respostas reais capturadas em 16/07/2026; cada operação popula um subconjunto.

codigostring
codigoMovimentacaostring

Igual ao `protocolo`.

tipoMovimentacaostring

INCLUSAO, EXCLUSAO, ...

cpfstring
carteirinhastring

Emitida quando a movimentação é liberada pela operadora.

matriculaFuncionariostring
matriculaFamiliastring
matriculaProvedorstring

Matrícula na operadora. GUARDE (exigida na exclusão como `matriculaEmpresa`).

sequencialstring
statusstring
nomestring
descricaostring
codigoBeneficiarioNoProvedorstring
validacoesarray

Validações/avisos retornados pela operadora.

items

object
nomeBeneficiariostring
matriculaFuncionariostring
sequencialinteger
codigostring
mensagemstring
criticasarray

Erros críticos de regra de negócio.

items

object

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

codigostring
campostring
mensagemstring
requestURIstring

URI exata da operadora chamada (auditoria).

requestJsonobject

Payload exato enviado à operadora (auditoria/troubleshooting).

responseContentobject

Retorno cru (raw) devolvido pela API da operadora.

400

Requisição malformada (campos obrigatórios ausentes/ inválidos).

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
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