Verificar elegibilidade por CPF ou Email

Esta seção descreve como você pode verificar se um cliente pode criar um nova proposta, antes de criá-la de fato. O objetivo deste endpoint é permitir uma melhor experiência para o usuário final uma vez que você consegue checar previamente se esse cliente possui uma solicitação em andamento - evitando preencher várias informações e ao final não ter a request processada.

Este endpoint apenas valida o CPF e o Email internamente para identificar se o cliente possui um solicitação em andamento e não realiza nenhuma análise classificatória para o empréstimo.


Como verificar a elegibilidade do lead


Request HTTP GET

Tipo da Requisição

URL

Exemplo

GET

{{url_base}}/borrowers/eligibility

https://api.stg.creditas.io/b2b/borrowers/eligibility

Request Params

Campo

Tipo

Obrigatório

Descrição

cpf* ou email

string

Sim

CPF ou Email do lead (envio do valor sem formatação)

productType

string

Não

Nome do produto Creditas AUTO_REFINANCING

*É possível validar a existência de uma solicitação em aberto utilizando apenas um dos campos, não sendo obrigatório o envio dos dois.

Request Headers

Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.

Request Response

Campo

Tipo

Descrição

product

string

Nome do produto Creditas: AUTO_REFINANCING

eligible

boolean

Resposta true ou false referente à existência do lead para o produto


Exemplo de Request e Response

curl --location --request GET '{{url_base}}/borrowers/eligibility?cpf=12345678909' \
--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
    }
]