Introduction
Welcome to QI Tech's Onboarding API! This API provides access to Fraud Prevention, Anti-Money Laundering and KYC services in a Registration on your platform!
This API can be used to validate customer registration for:
- Opening Digital Accounts or Wallets
- Card Issuance
- Application User Validation
- Registration for Credit Approval
- Insurance Hiring Registration
- Registration Data Validation
You can use our API to access the endpoints for evaluating the following types of registration:
- Natural Person - used for registration validation of Natural Persons
- Legal Person - used for registration validation of Legal Persons
The different registration types above have specific objects and endpoints designed to cover the particularities of each entity.
How it works
| Step | Call | What it does |
|---|---|---|
| 1 | POST /onboarding/natural_person or /legal_person | Submits the registration; QI Tech runs your decision tree and returns the result in analysis_status. |
| 2 | PUT /onboarding/{type}/{id} | Reports the outcome on your platform (client_status). Feeds the models back. |
| 3 | GET /onboarding/{type}/{id} | Retrieves the current state and the event history. |
Asynchronous results arrive via Webhook.
There are only 3 required fields in each registration type. Start with the minimum payload in Natural Person or Legal Person, with examples in Python, PHP, Node.js, Java, C# and curl.
The keys returned by the SDKs go in different places for Natural Person and Legal Person. See SDK data.
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 feedback
Even if you've already solved your issue or it is something simple (like a typo or a small organizational detail), 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 the APIs are:
- Production -
https://api.caas.qitech.app/onboarding/ - Sandbox -
https://api.sandbox.caas.qitech.app/onboarding/
Real natural person and/or legal person data must not be used in QI Tech's Sandbox environments.
In the Sandbox environment, submitted analyses are not charged and are responded to according to the following rule based on the first digit of the document number - CPF for Natural Persons and CNPJ for Legal Persons:
| Digit | Decision |
|---|---|
| 0 | In Manual Analysis |
| 1 | In Manual Analysis |
| 2 | In Manual Analysis |
| 3 | In Manual Analysis |
| 4 | Automatically Challenged |
| 5 | Referred for Manual Analysis - Later Rejected |
| 6 | Referred for Manual Analysis - Later Approved |
| 7 | Pending |
| 8 | Automatically Rejected |
| 9 | Automatically Approved |
For CPF or CNPJ numbers starting with digits 1 or 2, please contact our support team to ensure the manual handling is done correctly.
Only HTTPS
For security reasons, all communication with QI Tech's APIs must be conducted over HTTPS. To ensure that no HTTP calls are made, whether by oversight or any other reason, this server only makes port 443 available with TLS 1.2 communication. Requests using other protocols will be automatically rejected.