beneficiaries.read
Visualiza a listagem de vidas, históricos cadastrais e resumos de cobertura.
Rota /beneficiaries
Cadastro de Beneficiários (Vidas).
A base de vidas gerencia todas as pessoas físicas atendidas pelos contratos. Ela estrutura a relação familiar (titulares e dependentes), controla as credenciais de acesso ao portal e monitora inconsistências de coberturas ativas.
beneficiaries.manage
Cria, edita, convida, bloqueia e desativa cadastros de beneficiários.
Portal do beneficiário
Ações de Controle de Acesso
1. Envio de Convite
Dispara um link seguro temporário para o e-mail do beneficiário definir sua senha.
2. Reenvio de Link
Disponível se o convite anterior expirou ou não foi recebido. Gera um novo token de acesso.
3. Bloqueio de Acesso
Suspende a credencial imediatamente, impedindo logins no Portal do Beneficiário.
Metadados cadastrais
Campos Chave do Beneficiário
| Campo | API / Payload | Descrição / Regra |
|---|---|---|
| Nome Completo | name | Obrigatorio. Nome civil impresso na carteirinha digital. |
| CPF | cpf | Obrigatorio. Validação única de formato nacional. |
| Data de Nascimento | birthDate | Obrigatorio. Utilizada para categorização de faixas etárias. |
| Gênero | gender | Obrigatorio. M (Masculino) ou F (Feminino). |
| Parentesco | relationship | Obrigatorio. HOLDER (Titular), SPOUSE (Cônjuge), SON (Filho), DAUGHTER (Filha), FATHER/MOTHER (Pai/Mãe), etc. |
| Código Externo | externalId | Obrigatorio. Número de matrícula ou identificação da operadora. |
| Opcional. Necessário para habilitar o envio de convites de acesso ao portal. | ||
| Titular Vinculado | dependentOfId | Obrigatório para dependentes. Aponta para o ID do beneficiário titular. |
Gestão de apólices e coberturas
Módulos Analíticos de Vida e Saúde
Resumo de Saúde (Medical & Dental)
Consolida os valores de faturamento do mês atual detalhando os custos de saúde e odontológicos daquela vida.
Vida em Grupo (Life Insurance)
Mapeia capitais segurados, prêmios calculados e apólices vigentes quando o contrato possui o ramo de Vida.
Gaps de Cobertura (Missing Life)
Identifica automaticamente vidas ativas no plano de Saúde que não estão incluídas no catálogo de Vida em Grupo.
Checklist Atuarial
Antes de salvar o beneficiário
O CPF foi preenchido e validado sem formatação incorreta.
Para dependentes, o titular correto foi selecionado no campo de vínculo.
O e-mail foi inserido corretamente antes de disparar o convite de acesso.
Os códigos externos de matrícula batem com os arquivos da operadora.
Os gaps de seguro de vida foram revisados no painel lateral do beneficiário.