Alterar beneficiário (movimento A)
/v1/beneficiarios/{id}**Alteração** parcial de dados cadastrais. Equivale ao movimento `A`. Envie **apenas os campos alterados** — os demais permanecem inalterados.
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`.
Request Body
application/jsonrequired
Campos a alterar (enviar apenas os modificados).
Dados do plano/produto contratado.
Ver schema bruto / exemplo JSON
{
"dataEvento": "2026-06-10",
"endereco": {
"cep": "04567000",
"logradouro": "Rua Nova",
"numero": "55",
"municipio": "São Paulo",
"uf": "SP"
},
"contato": {
"email": "joao.novo@empresa.com"
}
}Responses
Alteração processada.
Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado.
Validações/avisos retornados pela operadora.
items
Erros críticos de regra de negócio.
items
Crítica/erro de validação devolvido pela operadora.
URI exata da operadora chamada (auditoria).
Payload exato enviado à operadora (auditoria/troubleshooting).
Retorno cru (raw) devolvido pela API da operadora.
Requisição malformada (campos obrigatórios ausentes/ inválidos).
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.
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.
A operadora rejeitou a movimentação por uma regra de negócio (ex. "CPF inválido", "Beneficiário inativo", "Fora da vigência"). Os detalhes vêm em `criticas` / `validacoes`.
Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado.
Validações/avisos retornados pela operadora.
items
Erros críticos de regra de negócio.
items
Crítica/erro de validação devolvido pela operadora.
URI exata da operadora chamada (auditoria).
Payload exato enviado à operadora (auditoria/troubleshooting).
Retorno cru (raw) devolvido pela API da operadora.
Alterar beneficiário (movimento A)
/v1/beneficiarios/{id}**Alteração** parcial de dados cadastrais. Equivale ao movimento `A`. Envie **apenas os campos alterados** — os demais permanecem inalterados.
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`.
Request Body
application/jsonrequired
Campos a alterar (enviar apenas os modificados).
Dados do plano/produto contratado.
Ver schema bruto / exemplo JSON
{
"dataEvento": "2026-06-10",
"endereco": {
"cep": "04567000",
"logradouro": "Rua Nova",
"numero": "55",
"municipio": "São Paulo",
"uf": "SP"
},
"contato": {
"email": "joao.novo@empresa.com"
}
}Responses
Alteração processada.
Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado.
Validações/avisos retornados pela operadora.
items
Erros críticos de regra de negócio.
items
Crítica/erro de validação devolvido pela operadora.
URI exata da operadora chamada (auditoria).
Payload exato enviado à operadora (auditoria/troubleshooting).
Retorno cru (raw) devolvido pela API da operadora.
Requisição malformada (campos obrigatórios ausentes/ inválidos).
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.
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.
A operadora rejeitou a movimentação por uma regra de negócio (ex. "CPF inválido", "Beneficiário inativo", "Fora da vigência"). Os detalhes vêm em `criticas` / `validacoes`.
Retorno padronizado de uma operação de escrita (`ResponseBaseSuccess`). Consolida o resultado, validações de negócio e dados de auditoria.
Código HTTP resultante do processamento na operadora.
Protocolo de rastreio gerado pela operadora.
Resumo do beneficiário afetado.
Validações/avisos retornados pela operadora.
items
Erros críticos de regra de negócio.
items
Crítica/erro de validação devolvido pela operadora.
URI exata da operadora chamada (auditoria).
Payload exato enviado à operadora (auditoria/troubleshooting).
Retorno cru (raw) devolvido pela API da operadora.