Informações Gerais - API Housing - v1.3.0

Visão geral

  • A API Housing (Habitacional) faz parte do Open Insurance Brasil — Fase 2.

  • Traz informações de apólice, prêmio 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-housing/v1

Dicionário de dados

Fazer download do dicionário de dados

GET /insurance-housing

Obtém a lista de identificação Habitacional.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-housing/{policyId}/policy-info

Obtém as informações gerais da apólice.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-housing/{policyId}/premium

Obtém os dados de prêmio da apólice.

Estrutura de dados

Diagrama de Relacionamento Conceitual

GET /insurance-housing/{policyId}/claim

Obtém os dados de sinistro associados à apólice.

Estrutura de dados

Diagrama de Relacionamento Conceitual