Informações Gerais - API Financial Assistance - v1.2.0

Visão geral

  • A API Financial Assistance (Assistência Financeira) faz parte do Open Insurance Brasil — Fase 2.

  • Traz informações de contrato e movimentações financeiras 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-financial-assistance/v1

Dicionário de dados

GET /insurance-financial-assistance/contracts

Obtém a lista de identificação de Assistência Financeira.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-financial-assistance/{contractId}/contract-info

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

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-financial-assistance/{contractId}/movements

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

Estrutura de dados

Diagrama de Relacionamento Conceitual