Introduction
Welcome to QI Tech's OCR API (Optical Character Recognition) for document reading. You can use this API to send an image of a document to be recognized, such as a Driver's License or Identity Card, and reference it through a key in other QI Tech system products.
Problems?
We are not a company that hides behind an API! Contact our support and we will respond as quickly as possible. Feel free to call us if you want a quick response!
We Love Feedback
Even if you have already solved your problem or it is very simple (Even a typo or inadequate organization that you already understood), send us an email, so we make the documentation increasingly practical and the next person won't need to suffer the pains you suffered!
Environments
We have two environments for our clients. The base URLs of the APIs are:
- Production -
https://api.caas.qitech.app/ocr/ - Sandbox -
https://api.sandbox.caas.qitech.app/ocr/
Real data from individuals and/or legal entities should not be used in QI Tech's Sandbox environments.
HTTPS Only
For security reasons, all communication with QI Tech APIs must be performed using HTTPS communication. To prevent HTTP calls from being made due to inattention or other reasons, this server only provides port 443 with TLS 1.2 communication. Calls made using other protocols will be automatically denied.
Authentication
To authenticate a call, use the following code:
# In the shell, you only need to add the appropriate header in each request
curl "api_endpoint_here"
-H "Authorization: EXAMPLE_API_KEY"
Replace the API key 'EXAMPLE_API_KEY' with your key acquired from our support.
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, 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_API_KEY
You must replace EXAMPLE_API_KEY with the API Key received from support.