Integration Guide

1. Visão Geral

Nossa API de Auto Equity permite que você ofereça empréstimos com garantia de veículo sem sair do seu ambiente. Através desta integração, você reduz o atrito de entrada (simulação) e automatiza a coleta de informações e análise de crédito, recebendo notificações em tempo real sobre a liberação do dinheiro para o seu cliente.

2. Jornada Sugerida — API

Nossa integração foi desenhada para que você ofereça crédito de forma nativa, mantendo o usuário totalmente dentro do seu ecossistema. Para garantir a melhor experiência e maximizar sua taxa de conversão, estruturamos o fluxo com foco em qualificação prévia. Isso assegura que as ofertas apresentadas sejam precisas e estejam alinhadas aos nossos critérios de elegibilidade, evitando o desgaste de clientes não elegíveis e aumentando a eficiência operacional das suas indicações.

📘
Por que qualificar o lead antes? Apresentar uma oferta para um cliente não elegível gera uma experiência negativa de frustração. Nossos endpoints de Elegibilidade e Simulação Assertiva servem como um filtro inteligente para que você só avance com clientes que tenham alta probabilidade de aprovação.

Ordem de Aplicação	Endpoint	Objetivo	O que acontece	Output
1	`/eligibility`	Consultar a elegibilidade e a decisão de pré-aprovação ou não do cliente	O parceiro envia o CPF e o e-mail para fazermos as devidas validações	Retornamos true ou false para o campo `eligible`, e true ou false para `isPreApproved`
2	`/offers`	Iniciar o processo de consulta às políticas	O parceiro envia as informações do leadform, contendo dados sobre o cliente e placa do veículo	Retornamos um ID que deve ser usado no próximo endpoint de oferta.
3	`/offers/[id]`	Retornar as informações da simulação assertiva	Processamos a oferta	Retornamos as condições da oferta, incluindo, taxa, CET, valor da parcela etc
4	`/proposals`	Criar uma proposta na Creditas	Parceiro envia as informações necessárias para criar um lead	Retornamos 200 OK para criação de proposta.

3. Diagrama de Integração

4. Webhook e Eventos

Com nosso webhook, é possível acompanhar a evolução das propostas em nossa esteira de contratação. Funcionalidades Principais:

Notificação em Tempo Real: você recebe um POST via HTTPS sempre que uma proposta anda na nossa esteira.
Flexibilidade de Assinatura: Você escolhe quais avisos quer receber, podendo usar um endereço diferente para cada evento ou concentrar tudo em um só lugar.
Segurança de Ponta: Utilizamos assinaturas digitais (HMAC-SHA256) para garantir que ninguém falsifique nossas mensagens.
Resiliência (Retentativas): Se seu sistema cair, não desistimos de primeira. Tentamos entregar a mensagem até 5 vezes em um intervalo de 40 minutos.