Faça sua primeira consulta
Saiba como usar o access_token para acessar APIs Creditas
Para exemplificar o uso do access_token
obtido na sessão Faça sua autenticação, vamos usar a API de elegibilidade.
O uso do access_token
é obrigatório em todas as requisições, somente com ele é possível acessar os recursos disponíveis e, para isso é necessário o envio no cabeçalho (header) de cada requisição, veja abaixo como deve ser enviado, para validar a elegibilidade:
Requisição HTTP POST
Ambiente | Tipo da Requisição | URL | Endpoint |
---|---|---|---|
Staging | GET | https://stg-api.creditas.io/b2b | /borrowers/eligibility |
Production | GET | https://api.creditas.io/b2b | /borrowers/eligibility |
Request Headers
Header | Valor |
---|---|
Accept-Version | v1 |
Content-Type | application/json |
Authorization | Bearer {{your_access_token}} |
Request Params
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
cpf | string | Sim | CPF da proposta *(Envio do valor sem formatação) |
string | Sim | E-mail da proposta | |
productType | string | Não | Nome do produto Creditas AUTO_REFINANCING ou HOME_REFINANCING |
Request
curl --location --request GET 'https://stg-api.creditas.io/b2b/borrowers/eligibility?cpf=12345678909&[email protected]' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'
Response
`
[
{
"product": "AUTO_REFINANCING",
"eligible": true
},
{
"product": "HOME_REFINANCING",
"eligible": true
}
]
A chamada de exemplo faz a verificação se o CPF e e-mail enviado como parameter query estão elegíveis para criação de uma proposta de acordo com seu produto, no response podemos verificar se está elegibilidade é verdadeira ou falsa, em caso de verdadeira, é possível criar uma proposta para este usuário no produto em questão, do contrário, ao tentar criar uma proposta irá ocorrer um erro.
Updated 4 months ago