Definição
This document describes the operation of the Asynchronous API, its purpose, the call parameters, and their respective returns. The content of this documentation and the specifications of the Asynchronous API are subject to change without prior notice.
Query
The call to the Asynchronous API enables queries to be made without the need to await the complete conclusion of the search for information from the official source. This allows the integrated application to continue its operations without waiting for the full processing result. Its development anticipates that the initial response to the API call will provide the most updated version of the data available in our databases. Subsequently, asynchronously, these data will be compared with the official source from which they originate. In the event that discrepancies are identified, an alert email will be sent to notify about the most updated return, as well as the inconsistent information found.
The accuracy of the information and the rate of inconsistency detection will depend on each accessed data source.
Request
For the request process, the access token will be required. If you don't have yours yet, please contact Netrin support, along with the document number for which you wish to perform the search.
Return Messages
Status Code
| Status Code | Message | Actions |
|---|---|---|
| 200 | Sucesso | - |
| 206 | Retorno Parcial | Evaluate internal code (table below) |
| 408 | Timeout | Evaluate internal code (table below) |
| 401 | Token Inválido / Expirado | Analyze token |
| 403 | Usuário não possui permissão para acessar este recurso | Contact Support |
| 404 | Parâmetros inválidos | Review the name of the service(s) |
| 502 | Falha na chamada | Contact Support |
Internal Codes
| Internal Codes | Description | Definitions |
|---|---|---|
| 601 | Lentidão ao gerar captcha | Contact Support in case of recurrence |
| 602 | Lentidão do site | Evaluate service consumption |
| 603 | Site fora do ar | Wait for site return |
| 604 | Em manutenção | Contact Support for return deadline |
| 605 | Parâmetros faltantes para a fonte | Contact Support in case of doubt |
| 606 | Não encontrado | Data does not exist in the original source database |
| 607 | Menor de idade | The consulted document belongs to a minor |
| 608 | Não foi possível emitir | The site did not allow to issue the proof |
| 609 | Parâmetro(s) inválido(s) | Verify the values of the provided parameters |
| 610 | Limite de tentativas excedido | The daily attempt limit has been exceeded |
| 611 | Franquia excedida | The contracted amount has been exceeded |
| 612 | Franquia inativa | The franchise has been deactivated |
| 613 | Franquia expirada | The franchise has not been renewed |
| 614 | PEP / VIP | The document belongs to a prominent person, and the data cannot be disclosed |
| 615 | Documento bloqueado na base de dados de origem | The document is blocked, and it will not be possible to consult it |
| 616 | Documento inativo | The document is inactive, and it will not be possible to consult it |
| 617 | Informações Pessoais identificáveis mínimas (PII) | Minimal Personally Identifiable Information (PII) |
| 618 | Pessoa falecida | The document belongs to a deceased holder |
| 619 | Não possui histórico de crédito | No credit history to present |
| 620 | Documento Inválido | The consulted document is invalid |
| 650 | Problemas na busca | Contact Support in case of recurrence |