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. Os filtros disponíveis dependem da operadora; os mais comuns estão abaixo.

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.

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 beneficiários.

object
dataarray

items

object

Representação cadastral de um beneficiário.

idstring
nomestring
cpfstring
dataNascimentostringdate
grauParentescostring
sexostring
estadoCivilstring
numeroCarteirinhastring
statusstring

Situação cadastral na operadora (ex. Ativo, Inativo).

dataAdesaostringdate
enderecoobject
cepstring
logradourostring
numerostring
complementostring
bairrostring
municipiostring
codMunicipiostring
ufstring
contatoobject
emailstring
dddCelularstring
celularstring
dddTelefone1string
telefone1string
produtoobject

Dados do plano/produto contratado.

contratostring
carteirinhastring
subContratostring
codigostring
codigoRDPstring
dataAlteracaoPlanostring
dataInicioContratostring
motivoAlteracaostring
apoliceobject
ciastring
numerostring
subfaturastring
tipoProdutostring
paginacaoobject
paginainteger
quantidadePorPaginainteger
totalinteger
totalPaginasinteger
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