Skip to main content

Introduction

Welcome to the QI Tech Document Analysis API. This API was specially designed to analyze complex documents that do not follow a standard format, such as proof of address, contracts, invoices, CCBs, bank slips, and others.

Support and Feedback​

If you encounter any technical issues or need assistance, please contact our support team at suporte.caas@qitech.com.br. We are committed to providing a timely response.

We Love Feedback​

We greatly value our clients' feedback! If you identify any inaccuracies, unclear sections, or have suggestions for improvement, we encourage you to share them with our team. Your contribution helps us improve the experience for all users!

Environments​

The API is available in two distinct environments for client use. The base URLs for the APIs are as follows:

  • Production - https://api.caas.qitech.app/document_analysis/
  • Sandbox - https://api.sandbox.caas.qitech.app/document_analysis/

Important Notice!

The use of real data from individuals and/or legal entities is strictly prohibited in the QI Tech Sandbox environment.

HTTPS Only​

For security reasons, all communication with QI Tech APIs must be carried out using HTTPS. To ensure compliance and prevent insecure data transmission, the server is configured to accept only connections on port 443 with the TLS 1.2 protocol. Calls made using other protocols will be automatically rejected.

Authentication​

Access to the API is granted through the use of an API Key. Your access key has been or will be sent to your email. If you have not yet received it, please contact our support team at suporte.caas@qitech.com.br.

The API expects the key to be included in the Authorization header of each request sent to the server.

Request Example:

# The -H flag adds the required authorization header to the request.
curl "api_endpoint_here" \
  -H "Authorization: EXAMPLE_API_KEY"
Attention

You must replace EXAMPLE-OF-API-KEY with the API Key received from support.