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

Consultar status de movimentações

/v1/movimentacoes

*Tracking* passivo do status e histórico das movimentações cadastrais (inclusões, alterações, exclusões) enviadas previamente. O Orquestrador consulta a operadora e traduz o retorno para um formato unificado. Recomenda-se executar movimentações e buscas de forma **intercalada**, respeitando o tempo de processamento da operadora.

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.

paginainteger

Página (paginação). Inicia em 1.

quantidadePorPaginainteger

Quantidade de itens por página.

Headers

X-Cnpj-Provedorstringrequired

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

Responses

200

Lista paginada de movimentações com status.

object
dataarray

items

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
paginacaoobject
paginainteger
quantidadePorPaginainteger
totalinteger
totalPaginasinteger
Ver schema bruto / exemplo JSON
{
  "data": [
    {
      "id": "mov-1",
      "protocolo": "888999900001111",
      "nome": "João da Silva",
      "cpf": "12345678900",
      "tipoMovimento": "Inclusão",
      "dataMovimentacao": "2026-04-01T10:30:00Z",
      "statusMovimentacao": "Processado com Sucesso",
      "numeroCarteirinha": "888999900001111",
      "criticas": []
    },
    {
      "id": "mov-2",
      "protocolo": null,
      "nome": "Maria da Silva (Dependente)",
      "cpf": "09876543211",
      "tipoMovimento": "Inclusão",
      "dataMovimentacao": "2026-04-01T10:30:00Z",
      "statusMovimentacao": "Rejeitado",
      "numeroCarteirinha": null,
      "criticas": [
        {
          "codigo": "VAL-031",
          "campo": "dataNascimento",
          "mensagem": "Data de nascimento incompatível com o grau de parentesco informado."
        }
      ]
    }
  ],
  "paginacao": {
    "pagina": 1,
    "quantidadePorPagina": 50,
    "total": 2,
    "totalPaginas": 1
  }
}
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