Excluir beneficiário (movimento E)
/v1/beneficiarios/{id}**Exclusão** da vida na operadora de destino. Equivale ao movimento `E`. O motivo e a data de exclusão são informados via query params.
Path Parameters
idstringrequired
Identificador do beneficiário. Aceita o `guidProdutoBeneficiario`, o CPF ou a matrícula, conforme suportado pela operadora.
Query Parameters
motivoExclusaostringrequired
Motivo da exclusão (ex. "Desligamento").
dataExclusaostringrequired
Data de exclusão (YYYY-MM-DD).
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
Responses
Exclusã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.
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.
Excluir beneficiário (movimento E)
/v1/beneficiarios/{id}**Exclusão** da vida na operadora de destino. Equivale ao movimento `E`. O motivo e a data de exclusão são informados via query params.
Path Parameters
idstringrequired
Identificador do beneficiário. Aceita o `guidProdutoBeneficiario`, o CPF ou a matrícula, conforme suportado pela operadora.
Query Parameters
motivoExclusaostringrequired
Motivo da exclusão (ex. "Desligamento").
dataExclusaostringrequired
Data de exclusão (YYYY-MM-DD).
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino — atua como **chave de roteamento** (padrão Mediator). Ex.: SulAmérica `01685053000156`.
Responses
Exclusã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.
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.