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

Listar / buscar beneficiários

/v1/beneficiarios

Consulta o cadastro de beneficiários (vidas) na operadora de destino. Equivale ao movimento `C` (Consulta) do contrato legado. > **INSTÁVEL NO AMBIENTE DEV (verificado em 16/07/2026):** o backend > (`buscar-beneficiarios` do Orquestrador) está retornando erro 400 > interno de forma persistente. Os filtros abaixo constam do contrato, > mas **não foram homologados** (não há evidência de que o upstream os > aplique). Pendência aberta com a Izii.

Query Parameters

cpfstring

CPF do titular para filtrar.

cpfDependentestring

CPF de um dependente específico.

nomestring

Nome (ou parte) do beneficiário.

apolicestring

Número da apólice/contrato.

empresastring

CNPJ ou identificador da empresa estipulante.

carteirinhastring

Número da carteirinha.

ufstring

UF para filtrar.

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 do Orquestrador traduzida pela fachada. **Shape não homologado** (endpoint instável no dev; não há resposta de sucesso capturada para documentar). Não assuma paginação.

object

Não homologado; será documentado quando o upstream estabilizar.

Ver schema bruto / exemplo JSON
{
  "type": "object",
  "description": "Não homologado; será documentado quando o upstream estabilizar."
}
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