Esta API realiza a análise e validação de documentos a partir do envio de uma imagem (em Base64), fornecendo um conjunto detalhado de informações extraídas, verificações de consistência e validações forenses. A resposta inclui dados capturados diretamente do documento, como nome, CPF, data de nascimento e número de identificação, além de informações oficiais para comparação, como nome completo, data de nascimento, idade e nome da mãe. Também são apresentados indicadores de correspondência entre os dados informados e os dados oficiais, como percentual de similaridade de nome e validação de data de nascimento, permitindo avaliar a confiabilidade das informações. A API incorpora ainda validações forenses da imagem enviada, identificando possíveis reutilizações, fraudes ou inconsistências, além de verificar a presença de rosto no documento e disponibilizar resultados consolidados com códigos e mensagens interpretáveis.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
TABELA DE CAMPOS DE REQUISIÇÃO
| Campo | Descrição | Formato | Obrigatório (Sim / Não) |
|---|---|---|---|
| IdConsulta | ID da consulta realizada | string | Sim |
| DOC_IMG | Imagem do documento em Base64 | string | Sim |
| FORENSICVALIDATIONS | Indica se deve realizar validações forenses | boolean/string | Não |
| SEARCHFACE | Indica se deve buscar face na imagem | boolean/string | Não |
| TRAFFICTICKET | Indica se deve verificar infrações associadas | boolean/string | Não |
TABELA DE CAMPOS DE RETORNO
| Campo | Descrição | Formato |
|---|---|---|
| CONSULTA.CODIGORESPOSTA | Código de resposta da consulta | string |
| CONSULTA.DATAHORA | Data e hora da consulta | string |
| CONSULTA.LOGON | Logon do usuário que realizou a consulta | string |
| CONSULTA.IDCONSULTA | ID da consulta realizada | string |
| RESPOSTA.CODIGO | Código de status do retorno | string |
| RESPOSTA.DOCUMENTOSCOPIA.ResultCode | Código do resultado da análise do documento | string |
| RESPOSTA.DOCUMENTOSCOPIA.ResultMessage | Mensagem descritiva do resultado | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.BIRTHDATEMATCH | Indica se a data de nascimento confere | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.NAMEMATCHPERCENTAGE | Percentual de correspondência do nome | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.NAMEMATCHPERCENTAGE_V2 | Percentual de correspondência do nome (versão 2) | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.OFFICIALAGE | Idade oficial encontrada | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.OFFICIALBIRTHDATE | Data de nascimento oficial | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.OFFICIALMOTHERNAME | Nome da mãe oficial | string |
| RESPOSTA.DOCUMENTOSCOPIA.OfficialInfo.OFFICIALNAME | Nome completo oficial | string |
| RESPOSTA.DOCUMENTOSCOPIA.ForensicValidations.CODE | Código do resultado da validação forense | string |
| RESPOSTA.DOCUMENTOSCOPIA.ForensicValidations.MESSAGE | Mensagem da validação forense | string |
| RESPOSTA.DOCUMENTOSCOPIA.DocInfo.BIRTHDATE | Data de nascimento extraída do documento | string |
| RESPOSTA.DOCUMENTOSCOPIA.DocInfo.CONTAINSFACE | Indica se o documento contém face | string |
| RESPOSTA.DOCUMENTOSCOPIA.DocInfo.CPF | CPF presente no documento | string |
| RESPOSTA.DOCUMENTOSCOPIA.DocInfo.DOCTYPE | Tipo do documento | string |
| RESPOSTA.DOCUMENTOSCOPIA.DocInfo.IDENTIFICATIONNUMBER | Número de identificação do documento | string |
| RESPOSTA.DOCUMENTOSCOPIA.DocInfo.NAME | Nome presente no documento | string |
| RESPOSTA.DOCUMENTOSCOPIA.EstimatedInfo.ESTIMATE_STATUS | Status da estimativa (ex: aplicável ou não) | string |
Códigos e Descrições de Status
| ResultCode | Message | Descrição |
|---|---|---|
| -704 | No info was found on the provided picture | Nenhuma informação relevante foi encontrada na imagem enviada. |
| -701 | An error occurred during the OCR service execution | Ocorreu um erro durante a execução do serviço de OCR ao processar a imagem. |
| 70 | Found info | Informações foram encontradas e extraídas com sucesso da imagem enviada. |
400Bad Request
401Unauthorized
