/
Informações Gerais - API Life Pension

Informações Gerais - API Life Pension

Visão geral

  • A API Life Pension (Previdência Sobrevivência) faz parte do Open Insurance Brasil — Fase 2.

  • Traz informações de contrato, contribuições e benefício, portabilidade, resgate e sinistro mantidas nas instituições transmissoras por seus clientes.

  • Não possui segregação entre pessoa natural e pessoa jurídica.

  • Requer consentimento do cliente para todos os endpoints.

Base URL

https://api.organizacao.com.br/open-insurance/insurance-life-pension/v1

 

GET /insurance-life-pension/contracts

Dicionário de dados

 

Obtém a lista de identificação de Previdência Sobrevivência

Estrutura de dados

API_Previdência_Risco_-_Open_Insurance_Brasil.insurance-pension-plan_contracts.png

Diagrama de Relacionamento Conceitual

Árvore do endpoint/API

GET _insurance-life-pension_contracts.png

 

GET /insurance-life-pension/{certificateId}/contract-info

Dicionário de dados

 

Obtém as informações gerais do contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

Árvore do endpoint/API

 

GET /insurance-life-pension/{certificateId}/movements

Dicionário de dados

 

Obtém os dados de movimentação do contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

Árvore do endpoint/API

 

GET /insurance-life-pension/{certificateId}/portabilities

Dicionário de dados

 

Obtém os dados de portabilidades associadas ao contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

Árvore do endpoint/API

 

GET /insurance-life-pension/{certificateId}/withdrawals

Dicionário de dados

 

Obtém os dados de resgates associados ao contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

Árvore do endpoint/API

 

GET /insurance-life-pension/{certificateId}/claim

Dicionário de dados

 

Obtém os dados de sinistro associados ao contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

Árvore do endpoint/API

 

Web: Governança do Open Insurance Brasil — Especificações