Informações Gerais - API Pension Plan
- 1 Visão geral
- 2 Base URL
- 3 GET /insurance-pension-plan/contracts
- 4 Dicionário de dados
- 5 GET /insurance-pension-plan/{pensionIdentification}/contract-info
- 6 Dicionário de dados
- 7 GET /insurance-pension-plan/{pensionIdentification}/movements
- 8 Dicionário de dados
- 9 GET /insurance-pension-plan/{pensionIdentification}/portabilities
- 10 Dicionário de dados
- 11 GET /insurance-pension-plan/{pensionIdentification}/withdrawals
- 12 Dicionário de dados
- 13 GET /insurance-pension-plan/{pensionIdentification}/claim
- 14 Dicionário de dados
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
https://api.organizacao.com.br/open-insurance/insurance-pension-plan/v1GET /insurance-pension-plan/contracts
Dicionário de dados
Obtém a lista de identificação de Previdência Risco.
Estrutura de dados
Diagrama de Relacionamento Conceitual
Árvore do endpoint/API
GET /insurance-pension-plan/{pensionIdentification}/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-pension-plan/{pensionIdentification}/movements
Dicionário de dados
Obtém os dados de contribuições do contrato.
Estrutura de dados
Diagrama de Relacionamento Conceitual
Árvore do endpoint/API
GET /insurance-pension-plan/{pensionIdentification}/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-pension-plan/{pensionIdentification}/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-pension-plan/{pensionIdentification}/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