Verificar elegibilidade por CPF e e-mail

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 e-mail 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://stg-api.creditas.io/b2/borrowers/eligibility

Request Params

Campo	Tipo	Obrigatório	Descrição
`cpf*`	string	Sim	CPF do lead (Envio do valor sem formatação)
`email`	string	Sim	e-mail do lead
`productType`	string	Não	Nome do produto Creditas `HOME_REFINANCING`

É 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

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: `HOME_REFINANCING`
`eligible`	boolean	Resposta: `true` está elegível a enviar um lead para o respectivo e-mail e/ou CPF; `false` não está elegível a enviar um lead, por já existir um previamente cadastrado para o respectivo email e/ou CPF;

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": "HOME_REFINANCING",
 "eligible": true
 }
]