Visão Geral da API

1. Funcionalidades de nossa API

Nossa API é composta por um conjunto de endpoints que permitem a integração dos fluxos de Auto Equity e Home Equity, além de um Webhook para notificações de status.

• É importante notar que cada produto (Auto e Home) possui seus próprios endpoints específicos. No entanto, existem dois endpoints comuns que atendem a ambos os produtos.

A seguir, apresentamos de forma macro quais são as funcionalidades disponíveis para cada produto:

(A ordem de apresentação segue nossa recomendação de ordem de aplicação)

2. Fluxo básico de integração

Nossa API permite que você integre a submissão de propostas de crédito com garantia (Auto Equity e Home Equity) diretamente na sua plataforma, iniciando o processo de análise e qualificação do seu cliente de forma fluida.

O recurso central da integração é a criação de propostas. Você fará isso utilizando um dos seguintes endpoints, dependendo do tipo de garantia:

• Auto Equity: POST /proposals
• Home Equity: POST /proposals/home

2.1. Recomendação - Melhores Práticas de UX

Para maximizar a conversão e a experiência do seu usuário final, é fundamental que você verifique se o cliente está elegível e, então, realize uma simulação de crédito qualificada antes de enviar a proposta final. A seguir, descrevemos a ordem sugerida de aplicação de endpoint por produto:

Auto Equity

🚗

/eligibility → /offers → /proposals → webhook

Home Equity

🏠

/eligibility → /simulations → /proposals/home → /status