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** (o `protocolo`/`codigoMovimentacao` devolvido na inclusão/exclusão). **Este é o caminho oficial de tracking** (verificado em 16/07/2026: é o único filtro que o Orquestrador aplica). O `statusMovimentacao` evolui com o processamento (ex.: `"1"` = em processamento, `"Liberada"` = aprovada pela operadora, com carteirinha emitida).

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

ex: 01685053000156

Responses

200

Movimentação encontrada.

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.

Ver schema bruto / exemplo JSON
{
  "status": 200,
  "protocolo": "2190831",
  "statusMovimentacao": "Liberada",
  "beneficiario": {
    "codigoMovimentacao": "2190831",
    "tipoMovimentacao": "INCLUSAO",
    "cpf": "36442421430",
    "carteirinha": "56788888484229630016",
    "matriculaFamilia": "484229630",
    "sequencial": "01",
    "status": "Liberada",
    "nome": "TESTE MARCOS FLUXO"
  }
}
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