Criação de pré-análise de crédito

Este endpoint permite a realização de uma pré-análise para verificar se o cliente terá limite de crédito aprovado antes da criação de uma conta. Após a pré-análise, o parceiro deve utilizar o endpoint de criação de análise de crédito para realizar a análise final e gerar o contrato que o cliente deverá assinar.

🚧

Importante

A pré-análise é válida apenas até o final do dia em que foi realizada. Se a análise final não for iniciada no mesmo dia, pode haver alterações no resultado, incluindo a possível reprovação do limite de crédito.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

• O parceiro defina um programa para seus cartões.

Requisição

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/credits/pre-analysis

--request POST 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/pre-analysis' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {{Token}}' \ 
--header 'x-bkly-license: f64197e4-80b3-4820-bfae-1419049b15b5'\ 
--header 'Content-Type: application/json' \ 
--data '{
  "programId": 107,
  "documentNumber": "34031497067",
  "scr": {
    "collectedAt": "2024-05-23T14:54:55.719Z",
    "authorized": true
  }
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{
  "programId": 107,
  "documentNumber": "34031497067",
  "scr": {
    "collectedAt": "2024-05-23T14:54:55.719Z",
    "authorized": true
  }
}

Resposta (Response)

O status code 202 indica que a solicitação foi aceita e a pré-analise está sendo processada.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são: