Você está aqui:
APIs para gerenciamento de benefícios do grupo de seguro
Aprimore o gerenciamento de benefícios do grupo de seguro com APIs.
- Gerenciamento de censo em massa de seguros (POST)
- Membros do censo do grupo de seguros (POST, PATCH, DELETE)
- Exclusão dos membros do censo do grupo de seguros (POST)
- Contas e usuários pessoais do seguro (POST)
- Contatos e usuários do seguro
- Classificação de membro do seguro (POST)
- Planejamento do Membro do Seguro (POST)
- Plans de membro do seguro (PATCH)
- Exclusão de planos de membro do seguro (POST)
- Sincronização de resumo do censo de seguro (POST)
- Regimes elegíveis dos membros do seguro (GET)
- Contrato de seguro de cotação (POST)
- Classificação de grupo de seguros (POST)
- Inscrição individual (POST)
Gerenciamento de censo em massa de seguro (POST)
Use a API de Gerenciamento de censo em massa de seguro (POST) para processar dados de censo de grupo em massa para um ID de censo de grupo específico. Essa API ajuda os seguradores a gerenciar de modo eficiente grandes volumes de dados de membro, incluindo membros principais e dependentes, durante a integração, a renovação ou a inscrição aberta.
Essa API lê dados do membro do arquivo CSV anexado ao registro de censo do grupo, valida o conteúdo e cria ou atualiza registros dependentes e do membro. Ele aplica detecção de duplicados, verifica relacionamentos principais e dependentes e executa o fluxo padrão para aplicar atribuições de classe de grupo e configuração de plano. Use essa API quando precisar processar arquivos de censo grandes, em vez de adicionar membros individualmente.
Nos bastidores, a API chama o fluxo Processar dados do membro do censo do grupo, que valida, transforma e salva registros do membro do censo. Você pode estender e personalizar esse fluxo de acordo com suas necessidades de negócios.
Você pode usar essa API como parte de fluxos de trabalho de inscrição automatizados em que os dados de censo são coletados de sistemas de RH ou administradores de terceiros. Após o processamento, o Censo de grupo resultante e os registros relacionados estão disponíveis para operações a jusante, como configuração de plano, classificação de grupo, geração de cotação e criação de política.
Como funciona
- Recupera metadados de censo e o arquivo CSV anexado.
- Valida as linhas de membro para dados obrigatórios e associações pai e filho.
- Atualiza membros existentes e cria novos membros.
- Coleta erros e os retorna na resposta da API ou os salva para revisão.
- Para tipos de censo de inscrição, também atualize os detalhes do plano com base nas regras de negócios.
Quando usá-lo
- Carregar um novo arquivo de censo para uma política de grupo.
- Reprocessar um arquivo CSV corrigido depois de corrigir erros de validação.
- Automatizar fluxos de trabalho de integração em que os dados de censo se originam de sistemas externos de RH ou de folha de pagamento.
Membros do censo do grupo de seguro (POST, PATCH, DELETE)
Use a API Membros do censo do grupo de seguro (POST, PATCH, DELETE) para adicionar, atualizar ou excluir registros de membro em um censo de grupo específico.
- Use POST para adicionar um ou mais membros e seus dependentes a um censo de grupo.
- Use PATCH para atualizar os detalhes dos membros existentes.
- Use DELETE para remover todos os membros de um censo de grupo especificado.
A API processa membros principais e dependentes e aplica as regras de validação necessárias para manter o censo preciso, consistente, classificado ou cotado. Ela avalia os relacionamentos entre membros principais e dependentes, realiza a detecção de duplicados e aplica a lógica de inscrição e classe de grupo por meio do fluxo Processar dados do membro do censo do grupo, a menos que você especifique um fluxo diferente.
A API pega o groupCensusId no caminho e processa apenas os registros de membro fornecidos na solicitação. Geralmente, você usa essa API ao integrar dados de novos membros, corrigir campos demográficos, como nome, data de nascimento ou classe do grupo, ou preparar o censo para etapas a jusante, como seleção de plano.
O método DELETE remove todos os membros vinculados ao groupCensusId especificado. Isso difere da API Excluir membros do censo de seguro (POST), que exclui apenas os membros individuais cujos IDs você fornece na solicitação. Use DELETE quando precisar limpar e redefinir o censo completo antes do reprocessamento e use a API de exclusão direcionada quando quiser remover apenas membros específicos.
Excluir membros do censo do grupo de seguro (POST)
Use a API Excluir membros do censo do grupo de seguro (POST) para remover um ou mais membros do censo associados a um ID de censo de grupo específico. Essa API ajuda os seguradores a manter os dados do censo limpos e precisos removendo membros que não são mais elegíveis, ativos ou relevantes para processos de inscrição, classificação ou cotação.
Quando um membro é excluído, todos os registros dependentes associados também são removidos. Registros excluídos não podem ser restaurados, portanto, use essa API quando um membro precisar ser totalmente excluído de processos conduzidos por censo, como configuração de plano, classificação de grupo ou criação de contrato. Na solicitação, você especifica os IDs de membro do censo de grupo para os registros de membro que deseja excluir.
Contas e usuários pessoais de seguro (POST)
Use a API Contas e usuários pessoais de seguro (POST) para criar contas pessoais e usuários do portal para membros do censo de grupo. A conta pessoal é usada para vincular o membro à política apropriada e o usuário do portal permite que o membro faça login no portal da comunidade de clientes.
Depois que os registros são criados e os conjuntos de permissões necessários são atribuídos, os membros podem acessar o portal da comunidade para visualizar informações sobre eles mesmos, dependentes e políticas existentes com base no fluxo de trabalho configurado pelo administrador do sistema. Eles também podem usar a experiência do portal para configurar planos e concluir a inscrição com base na configuração de fluxo de trabalho digital da operadora.
Essa API pode criar contas pessoais para todos os membros em um censo de grupo ou para uma lista específica de membros do censo. Ele oferece suporte à detecção de duplicados para evitar a criação de várias contas para a mesma pessoa e usa mapeamentos de campo para alinhar os dados do membro do censo aos campos da conta.
Contatos e usuários de seguro
Use a API de Contatos e usuários de seguro (POST) para criar registros de contato e usuários do portal opcionais para membros do censo de grupo. Essa API ajuda a converter dados do membro do censo em registros padrão de Contato do Salesforce que podem participar de processos de inscrição, comunicação e política. Quando os usuários do portal são criados, os membros podem acessar a comunidade de clientes para revisar planos ou concluir etapas de inscrição por autoatendimento.
Essa API dá suporte ao processamento de todos os membros de um censo de grupo ou de membros específicos identificados na solicitação. Ele impede a criação de contatos duplicados usando campos correspondentes e aplica mapeamentos de campo para alinhar os dados do membro do censo aos campos de contato. Depois que os registros de usuário do portal e contato forem criados e os conjuntos de permissões necessários forem atribuídos, os membros poderão acessar o portal da comunidade para revisar os planos e concluir a inscrição.
Você também pode integrar essa API ao fluxo Inscrição de grupo para automatizar a criação do usuário do portal durante o processo de inscrição. Ao personalizar a ação invocável Criar contatos e usuários do censo de grupo ou Membros no fluxo de inscrição, você pode definir Criar usuário do portal como verdadeiro e fornecer um ID de perfil válido. Isso habilita a criação automática de usuários do portal para cada membro quando os dados de inscrição são processados.
Para processamento em lote, configure um trabalho em lote que faça referência ao fluxo de inscrição personalizado. O trabalho em lote cria usuários do portal para os membros principais em massa com base nos registros de censo do grupo.
Classificação de membro de seguro (POST)
Use a API Classificação de membro de seguro (POST) para calcular prêmios e valores de contribuição para membros individuais em um censo de grupo. Essa API avalia os planos e coberturas selecionados de cada membro, determina a precificação no nível de cobertura e totaliza esses valores para os níveis de plano e membro.
A API dá suporte a cálculos de contribuição do funcionário e do empregador, tornando-o uma etapa crucial antes da inscrição ou classificação do grupo.
A API usa os dados de plano e cobertura do membro como entrada e retorna os prêmios e contribuições calculados. Cada resposta inclui resultados de precificação detalhados, valores de contribuição e mensagens de erro encontradas durante a classificação.
Use essa API quando precisar:
- Calcule prêmios e contribuições no nível do membro antes da inscrição.
- Valide ou visualize a precificação para planos e coberturas selecionados.
Planos de membro do seguro (POST)
Use POST para adicionar novos planos para um membro do censo de grupo. A solicitação inclui o ID do membro e uma lista de planos a serem adicionados. A API adiciona todos os planos especificados em uma única operação e retorna a lista de planos atualizada do membro e os erros que ocorreram durante o processamento.
Planos do membro do seguro (PATCH)
Use PATCH para atualizar as seleções de plano existentes para um membro adicionando novos planos ou excluindo os existentes.
A API processa todas as alterações como uma única transação, assim, todas as atualizações são bem-sucedidas ou nenhuma é aplicada. A resposta lista quais planos foram atualizados ou removidos e inclui quaisquer erros de validação.
Quando um membro principal aceita um plano, os dependentes não recebem automaticamente a mesma seleção de plano. Os dependentes podem escolher o mesmo plano com diferentes opções de cobertura ou recusar a categoria do plano.
Se o membro principal alterar sua seleção de plano, todas as seleções de plano dependentes para esse plano serão removidas e deverão ser reconfiguradas. Quando um membro principal recusa uma categoria de plano, os dependentes não podem se inscrever nessa categoria.
Exclusão de planos de membro do seguro (POST)
Use a API Excluir planos do membro de seguro (POST) para excluir um ou mais planos de um membro do censo de grupo. Essa API remove os registros do plano do membro especificados e seus detalhes relacionados do censo do grupo.
Quando você fornece um ID do plano raiz como entrada, a API remove o plano e todas as coberturas relacionadas do membro e retorna o resultado da solicitação de exclusão.
Use essa API para remover planos que um membro não deseja mais ou corrigir seleções de plano incorretas. Quando você exclui um plano, todos os registros do plano relacionados são removidos da configuração do membro.
Sincronização de resumo do censo de seguro (POST)
Use a API de Sincronização de resumo do censo de seguro (POST) para recalcular e atualizar dados de resumo para um censo de grupo. Essa API atualiza os registros de Resumo do censo de grupo e Resumo da classe do grupo do censo de grupo para que reflitam as informações dependentes e do membro mais recentes após qualquer operação de adição, atualização ou exclusão.
A API usa o ID de censo do grupo para realizar a sincronização e não requer uma carga útil da solicitação. Ele retorna contagens de resumo atualizadas, como o número total de membros, dependentes e recusas, junto com divisões no nível da classe do grupo.
Você pode usar essa API depois de adicionar, atualizar ou excluir membros ou dependentes em um censo de grupo para garantir que os dados de resumo reflitam as informações mais recentes dos membros.
Planos elegíveis do membro do seguro (GET)
Use a API de Planos elegíveis do membro do seguro (GET) para recuperar os planos do grupo de contratos para os quais um membro do censo do grupo e seus dependentes são elegíveis. A elegibilidade é determinada pela configuração, como atribuições de classe de grupo e configuração de contrato.
A API pega o ID do membro do censo do grupo como entrada e retorna detalhes do plano e da cobertura disponíveis a cada membro com base nas regras de elegibilidade definidas para o censo do grupo. Você pode escolher incluir ou excluir elegibilidade dependente usando o parâmetro request. A resposta lista os planos e coberturas elegíveis de cada membro por categoria de produto, junto com informações como nomes de plano e status da assinatura.
Você pode usar essa API como parte do processo de inscrição em grupo para exibir os planos disponíveis antes que os membros selecionem ou atualizem suas preferências de plano. Ele garante que cada membro e dependente veja apenas os planos para os quais eles são elegíveis com base na classe do grupo e na configuração do contrato.
Contrato de seguro da cotação (POST)
Use a API Contrato de seguro da cotação (POST) para criar um contrato de benefícios do grupo a partir de uma cotação aprovada. Essa API converte uma cotação em um registro de contrato com termos, datas e campos adicionais opcionais definidos.
A API pega o ID da cotação e os detalhes do contrato como entrada e retorna uma resposta que indica se a criação do contrato foi iniciada com sucesso junto com um ID de rastreamento para o trabalho assíncrono. Como parte de um trabalho assíncrono, a API cria planos de grupo de contratos para cada um dos produtos raiz e coberturas configuradas na cotação, junto com atributos. Se aplicável, também cria registros que são usados para a identificação da elegibilidade do plano de grupo para membros com base na classe do grupo.
A API valida a cotação, cria o contrato e aplica detalhes do contrato, como datas de início e término, períodos de inscrição e duração do prazo. Você também pode incluir campos adicionais para definir valores para entidades como Contrato, Contrato de seguro e Plano do grupo de contratos durante a criação do contrato.
Você pode usar essa API após a aprovação da cotação, assim que o cliente concorda em comprar a cobertura. Se você estiver chamando essa API de um fluxo, habilite Atribuir variáveis manualmente (avançado) ao mapear saídas. O campo de saída asyncBulkRequestId não tem suporte no mapeamento automático de variável.
Classificação de grupo de seguro (POST)
Use a API Classificação de grupo de seguro (POST) para calcular prêmios para todos os itens de linha de cotação em uma cotação de benefícios do grupo. Você pode classificar toda a cotação ou planos raiz específicos para calcular prêmios para seus itens de linha de cotação associados.
A API pega o quoteId no caminho e usa as entradas da solicitação para iniciar o processo de classificação. Você pode fornecer uma lista de IDs de item de linha de cotação para classificar produtos específicos ou omitir a lista para classificar a cotação completa. Você também pode enviar uma ratingDate para controlar a data de precificação que se aplica ao cálculo. A API aciona um processo de classificação assíncrona para que você receba uma resposta imediata enquanto o cálculo continua em segundo plano.
A API valida a cotação de entrada e processa a classificação usando o mecanismo de classificação de grupo. Ele calcula os prêmios com base na data da classificação e nas regras de configuração definidas para os produtos na cotação.
Use essa API quando você finalizar seleções de plano e precisar de prêmios precisos para cotação ou quando atualizar dados de membro ou cobertura e quiser atualizar a precificação para um ou mais planos.
Inscrição individual (POST)
Use a API de Inscrição individual (POST) para inscrever um membro do censo de grupo em um plano de seguro de benefícios do grupo e criar os registros de apólice correspondentes. A API processa a inscrição para um membro principal e seus dependentes sob o plano de grupo de contratos raiz especificado.
A API pega o memberId no caminho e usa o ID do plano fornecido na solicitação. Você também pode especificar um flowName para executar a lógica de inscrição personalizada ou depender do fluxo padrão Processar dados do membro do censo do grupo. A API valida os detalhes do membro e do plano, verifica a elegibilidade, aplica regras de inscrição e gera um ou mais registros de apólice para a família.
Você pode usar essa API como parte do fluxo de trabalho de inscrição individual, em que os membros revisam planos elegíveis, visualizam prêmios e contribuições e concluem a inscrição. A API automatiza a criação de políticas para planos selecionados quando as validações de elegibilidade e classificação são concluídas.
