Verificar Elegibilidade e Pré-Aprovação

❗️

Funcionalidade em teste. Disponível apenas com beta-testers. Não está habilitada para uso sem autorização.

1. Visão Geral

Este endpoint é a porta de entrada para a jornada de crédito. Ele deve ser consultado antes da criação de qualquer proposta para validar se o cliente está apto a seguir o fluxo.

Utilize este recurso para atingir dois objetivos principais através do CPF do cliente:

• Evitar Duplicidade (Padrão): Verifica se o cliente já possui uma proposta ativa ou em andamento na nossa base, prevenindo a criação de leads duplicados e erros na esteira de aprovação.
• Consultar Pré-Aprovação (Novo — dez./25): Verifica se o cliente possui crédito pré-aprovado disponível. Nota: Esta funcionalidade requer o envio de um parâmetro específico (veja "Parâmetros" abaixo).

🚧

Importante: O que significa o retorno false?

O status pre_approved: false indica apenas que o cliente não atende aos critérios de pré-aprovação automática neste momento.

Como a Pré-Aprovação utiliza critérios mais rígidos do que a análise da simulação assertiva, um retorno false NÃO significa uma negativa definitiva.

Ação Recomendada: Não apresente o anúncio de pré-aprovado, mas não bloqueie a jornada. Se o cliente for para o fluxo padrão de simulação, permita que seja realizada uma chamada para nossa API. Na etapa completa, utilizaremos dados adicionais que podem resultar em uma aprovação final, recuperando leads que não passaram no filtro inicial estrito.

1.1. Recomendação de Aplicação

Com a funcionalidade de consultar a decisão de pré-aprovação, você tem três tipos de casos de uso para o endpoint de elegibilidade:

1. Qualificação de Ofertas e Criação de Proposta (como já funcionava antes): com base no resultado de true ou false a respeito da elegibilidade, você libera (ou não) a chamada para consulta da simulação assertiva e criação de proposta. No caso do cliente não ser elegível (retorno false), você bloqueia a criação de oferta e propostas.
2. Campanhas de CRM (E-mail / Push): Utilize o endpoint para qualificar sua base de usuários. Identifique quem tem eligible e pre_approved = true e dispare comunicações assertivas como: "[Nome do cliente], você tem um empréstimo pré-aprovado com nossa parceira Creditas!".
3. Tela de Login / Home do App: Chame este endpoint assim que o usuário fizer login no seu aplicativo. Se o retorno for positivo, exiba um Banner de Destaque ou Pop-up na tela inicial oferecendo o crédito.
   1. Benefício: Captura o usuário antes mesmo que ele pense em simular, reduzindo o atrito e encurtando a jornada de compra.

1.1.1. Lógica de Aplicação

2. Nota técnica para implementação do pré-aprovado

Para manter a compatibilidade com integrações existentes, a verificação de pré-aprovação é opcional.

• Para ativar a consulta de crédito, você deve enviar os parâmetros scope = PRE_APPROVAL e productType = AUTO_REFINANCING

Caso o parâmetro não seja enviado, o endpoint retornará apenas a verificação de duplicidade padrão.

3. Como verificar a elegibilidade do lead

Request HTTP GET

Request Params

📌

É recomendado o envio de ambos valores email e cpf juntos na mesma consulta de elegibilidade, com isso evitará receber erros de Conflict(409) durante a criação das propostas.

Request Headers

Para mais detalhes sobre como obter o access_token, consulte a documentação Autenticação e Ambientes.

Request Response

Exemplo de Request e Response

curl --location --request GET '{{url_base}}/borrowers/eligibility?cpf=12345678909&scope=PRE_APPROVAL' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'

[
    {
        "product": "AUTO_REFINANCING",
      	"eligible": true,
        "isPreApproved": true
    }
]