Obter beneficiário
/v1/beneficiarios/{id}Retorna os dados cadastrais de um beneficiário específico.
Path Parameters
idstringrequired
Identificador do beneficiário. Aceita o `guidProdutoBeneficiario`, o CPF ou a matrícula, conforme suportado pela operadora.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
Responses
Beneficiário encontrado.
Representação cadastral de um beneficiário.
Situação cadastral na operadora (ex. Ativo, Inativo).
Dados do plano/produto contratado.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.
Recurso não encontrado.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.
Obter beneficiário
/v1/beneficiarios/{id}Retorna os dados cadastrais de um beneficiário específico.
Path Parameters
idstringrequired
Identificador do beneficiário. Aceita o `guidProdutoBeneficiario`, o CPF ou a matrícula, conforme suportado pela operadora.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
Responses
Beneficiário encontrado.
Representação cadastral de um beneficiário.
Situação cadastral na operadora (ex. Ativo, Inativo).
Dados do plano/produto contratado.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.
Recurso não encontrado.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica/erro de validação devolvido pela operadora.