Criação de análise de crédito
stable
Este endpoint possibilita iniciar o processo de análise do cliente do parceiro para concessão de crédito.
Nota
Recordamos que essa análise ocorre de forma assíncrona e seu resultado (aprovação ou reprovação) bem como valor de crédito concedido (em acaso de aprovação) serão comunicados ao parceiro por meio de evento de webhook.
O status do contrato também poderá ser consultado por meio do endpoint Consulta de contrato de crédito.
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O cliente do parceiro possua uma conta ativa.
Requisição (Request)
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/cards/credits/customers
--request POST \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/customers' \
--header 'Authorization: Bearer' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'x-bkly-license: f64197e4-80b3-4820-bfae-1419049b15b5'\
--header 'content-type: application/json' \
--data '
{
"phone": {
"type": "Commercial",
"value": "23415162342",
"countryCode": "55"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"neighborhood": "Alter do Chão",
"city": "Santarém ",
"state": "PA",
"country": "Brasil"
},
"name": "Nísia Floresta",
"motherName": "Dionísia Gonçalves Pinto ",
"birthDate": "1810-10-12",
"programId": "111",
"documentNumber": "47742663023",
"profession": "Empresária",
"maritalStatus": "Divorced",
"academicDegree": "Masters",
"incomeBracket": "FromFiveThousandToTenThousand",
"sex": "Female",
"email": "[email protected]"
"scr": {
"collectedAt": "2023-08-17T16:36:20.717Z",
"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:
Scope | Descrição |
---|---|
credit.write | Concede acesso para solicitar análise ou reanálise de crédito para um cliente. |
Cabeçalhos (Headers)
Nome | Descrição |
---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-bkly-license | Obrigatório. Identificador da licença bancária utilizada pelo parceiro. |
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:
Nome | Tipo | Descrição |
---|---|---|
name | string | Nome do cliente. |
socialName | string | Nome pelo qual a pessoa gostaria de ser chamada. Saiba mais consultando a Cartilha do nome social. |
motherName | string | Nome da mãe do cliente. |
birthDate | string | Data de nascimento do cliente. |
programId | integer | Obrigatório. Identificador do programa que será vinculado ao cartão. |
documentNumber | string | Obrigatório. Número do documento (CPF ou CNPJ). Informe somente números. |
profession | string | Obrigatório. Profissão do cliente. |
maritalStatus | string | Obrigatório. Estado civil do cliente, o qual pode ser: “Single” (Solteiro), “Married” (Casado), “Separated” (Separado), “Divorced” (divorciado) e “Widower” (Viúvo). |
academicDegree | string | Obrigatório. Grau de instrução do cliente, o qual pode ser: “HighSchool” (Ensino Médio), “Graduated” (Graduação), “PostGraduate” (Pós-graduação), “Masters” (Mestrado) ou “Doctorate” (Doutorado). |
incomeBracket | string | Obrigatório. Renda salarial do cliente. |
sex | string | Obrigatório. Gênero do cliente, o qual pode ser: “Male” (Masculino), “Female” (Feminino) ou “Other” (Outro). |
email | string | Obrigatório. Endereço de e-mail do cliente. |
phone | object | Obrigatório. Objeto que contém os dados do telefone do cliente. |
phone.phoneType | string | Obrigatório. Tipo de telefone, o qual pode ser: “Residential” (Residencial), “Commercial” (Comercial) ou “Mobile” (Celular). |
phone.value | string | Obrigatório. Número do telefone. |
phone.countryCode | string | Obrigatório. Código DDI do país. |
address | object | Obrigatório. Objeto que contém os dados do endereço do cliente. |
address.zipcode | string | Obrigatório. Código postal do endereço. |
address.addressLine | string | Obrigatório. Logradouro (nome da rua, avenida etc.). |
address.buildingNumber | string | Número do imóvel. |
address.complement | string | Complemento do endereço. Exemplo: Apto 123, Casa B etc. |
address.neighborhood | string | Obrigatório. Nome do bairro ou distrito. |
address.city | string | Obrigatório. Nome da cidade. |
address.state | string | Obrigatório. Sigla do estado brasileiro conforme a ISO 3166-2:BR. |
address.country | string | Obrigatório. País do endereço. |
scr | object | Obrigatório. Objeto que deverá conter informações sobre a resposta do cliente quanto à consulta ao SCR (Sistema de Informação de Crédito). |
scr.collectedAt | string | Obrigatório. Data de coleta da resposta do cliente, no formato ISO 8601 - UTC. |
scr.authorized | boolean | Obrigatório. Indica se o cliente autorizou (true) ou não (false) a consulta ao SCR. |
{
"phone": {
"phoneType": "Commercial",
"value": "23415162342",
"countryCode": "55"
},
"address": {
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"buildingNumber": "2500",
"neighborhood": "Alter do Chão",
"city": "Santarém ",
"state": "PA",
"country": "Brasil"
},
"name": "Nísia Floresta",
"motherName": "Dionísia Gonçalves Pinto ",
"birthDate": "1810-10-12",
"programId": 111,
"documentNumber": "47742663023",
"profession": "Empresária",
"maritalStatus": "Divorced",
"academicDegree": "Masters",
"incomeBracket": "FromFiveThousandToTenThousand",
"sex": "Female",
"email": "[email protected]",
"scr": {
"collectedAt": "2023-08-17T16:36:20.717Z",
"authorized": true,
}
}
Faixa salarial do cliente
Renda | Descrição |
---|---|
LessThousand | Menos de mil. |
FromThousandToTwoThousand | De mil a dois mil. |
FromTwoThousandToThreeThousand | De dois mil a três mil. |
FromThreeThousandToFiveThousand | De três mil a cinco mil. |
FromFiveThousandToTenThousand | De cinco mil a dez mil. |
FromTenThousandToTwentyThousand | De dez mil a vinte mil. |
OverTwentyThousand | Acima de vinte mil. |
Resposta (Response)
O status code 202 indicará que a solicitação foi aceita e a análise de crédito foi criada.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
Nome | Tipo | Descrição |
---|---|---|
companyKey | string | Chave que identifica o parceiro dentro do Bankly. |
document | string | Número de documento do cliente (CPF ou CNPJ). |
contract | string | Número do contrato de crédito criado. |
{
"companyKey": "FLORESTA_ED",
"document": "47742663023",
"contract": "000010"
}
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:
Status Code | Código | Mensagem | Descrição |
---|---|---|---|
400 | SCR_MUST_BE_ACCEPTED | SCR authorization must be accepted. | Tentativa de gerar uma nova análise de crédito com o aceite do SCR negativo. |
404 | CREDIT_CONFIG_NOT_FOUND | Credit config with program ID ${programId} and company key ${companyKey} was not found | Os detalhes da configuração de crédito não estão configurados. |
409 | CREDIT_ANALYSIS_SIGNED_WITHIN_GRACE_DEADLINE | There is another credit analysis signed within the grace deadline! | Tentativa de gerar uma nova análise de crédito sendo que já existe uma criada dentro do período de carência. |
409 | OPEN_CREDIT_ANALYSIS | There is an open credit analysis! | Tentativa de criação de nova análise de crédito para documentNumber ou companyKey que já possui análise ativa (Pending/Approved/Signed/Blocked). |
422 | CARD_CANCELED | The card informed is invalid as it is canceled! | O cartão deste cliente foi cancelado. |
422 | PROGRAM_CREDIT_DETAILS_NOT_CONFIGURED | The program does not have a credit detail configured! | Os detalhes do programa do cartão não estão configurados. |
500 | FAILURE_TO_FETCH_CREDIT_CONFIG | An internal failure occurred while fetching the credit config. Try again later. | Ocorreu um erro durante a consulta da configuração de crédito. Tente novamente mais tarde. |
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:
Nome do evento | Descrição |
---|---|
CREDIT_CARD_LIMIT_CREATED | Solicitação de limite de crédito criada. |
CREDIT_CARD_LIMIT_APPROVED | Solicitação de limite de crédito aprovada. |
CREDIT_CARD_LIMIT_REPROVED | Solicitação de limite de crédito reprovada de acordo com a política de crédito. |
CREDIT_CARD_ANALYSIS_COMPLETED | A análise de crédito foi finalizada e pode ter sido aprovada ou reprovada. |
Updated about 2 months ago