Informações Gerais - API Pension Plan - v1.4.0

Visão geral

• A API Pension Plan (Previdência Risco) 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

Dicionário de dados

Open

GET /insurance-pension-plan/contracts

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

Estrutura de dados

Open

Diagrama de Relacionamento Conceitual

Open

GET /insurance-pension-plan/{pensionIdentification}/contract-info

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

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-pension-plan/{pensionIdentification}/movements

Obtém os dados de contribuições do contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-pension-plan/{pensionIdentification}/portabilities

Obtém os dados de portabilidades associadas ao contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-pension-plan/{pensionIdentification}/withdrawals

Obtém os dados de resgates associados ao contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-pension-plan/{pensionIdentification}/claim

Obtém os dados de sinistro associados ao contrato.

Estrutura de dados

Diagrama de Relacionamento Conceitual