Visão Geral da API
A API de Parcerias Creditas permite que você integre nossas soluções de crédito com garantia (Auto Equity e Home Equity) diretamente na sua plataforma, aplicativo ou jornada de usuário.
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)
Diagrama de funcionalidades da API B2B Creditas
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:
Fluxo Auto (Simulação Quente ou Fria):
GET /borrowers/eligibility → POST /offers → GET /offers/{id} → POST /proposals → GET /proposals/{id}/status ou Webhook
A API
[POST] /offers(Simulação Quente) só está disponível para proposta de Auto Equity!
Fluxo Home (Simulação Fria)
GET /borrowers/eligibility → GET /simulations → POST /proposals/home → GET /proposals/{id}/status
A API
[GET] /simulations(Simulação Fria) está disponível para proposta de Auto Equity e Home Equity!
Updated about 1 month ago