Introduction
Welcome to QI Tech's Credit Analysis API! You can use our API to access endpoints in order to perform a credit analysis, as well as update the status of a granted credit.
Please note that this API is intended for companies that offer credit to individuals (Natural Persons) and small businesses (Legal Persons). Its purpose is to conduct a full credit assessment of your client's operations, based on the data you provide, data from bureaus and external sources, and QI Tech's datalake, in order to make the risk-return profile of each operation clear.
This API is designed for individuals and small businesses. It is not suited for assessing the credit risk of large corporations, which require deeper knowledge of their operations and the markets in which they operate.
Issues?
We’re not a company that hides behind an API! Reach out to our support team and we’ll get back to you as soon as possible. Feel free to give us a call if you want a quicker answer!
We love feedbacks
Even if you’ve already solved your issue or it is something simple (like a typo or a small organizational detail), feel free to send us an email. That way, we can keep improving our documentation and help the next person avoid the same difficulties you faced!
Environments
We provide two environments for our clients. The base URLs for our APIs are:
- Production –
https://api.caas.qitech.app/credit_analysis/ - Sandbox –
https://api.sandbox.caas.qitech.app/credit_analysis/
In the Sandbox environment, analyses are not charged and return predefined responses with fictitious data. Its sole purpose is to simulate the production environment and support clients during integration.
For credit analysis in the Sandbox environment, the decision is based on the total credit amount (financial.amount) according to the table below:
| Minimum | Maximum | Decision |
|---|---|---|
| 10001 | - | Rejected |
| 8001 | 10000 | Manual Analysis – A manual rejection webhook is sent after 1 minute |
| 6001 | 8000 | Manual Analysis – A manual approval webhook is sent after 1 minute |
| 4001 | 6000 | Awaiting Data – An automatic approval webhook is sent after 1 minute |
| 2001 | 4000 | Pending |
| 0 | 2000 | Approved |
HTTPS Only
For security reasons, all communication with QI Tech's APIs must be conducted using HTTPS. To ensure that no HTTP calls are made by mistake or for any other reason, this server only makes port 443 available with TLS 1.2 communication. Requests made using other protocols will be automatically denied.
Authentication
To authenticate a request, use the following code:
# In the shell, you only need to add the appropriate header to each request
curl "api_endpoint_here"
-H "Authorization: EXAMPLE-OF-API-KEY"
Replace the API key 'EXAMPLE-OF-API-KEY' with your key acquired from our support team.
We use an API Key to allow access to our API. It has probably already been sent to you by email. If you have not yet received your key, please send an email to suporte.caas@qitech.com.br.
Our API expects to receive the API Key in all requests to our server in a header like the one below:
Authorization: EXAMPLE-OF-API-KEY
You must replace EXAMPLE-OF-API-KEY with the API Key received from support.