Descrição
A API de Documentoscopia de Documentos extrai informações de uma imagem que represente um documento de identificação qualquer, além, da classificação automática do tipo e lados do documento em questão (também é possível explicitar essas informações, não utilizando a classificação automática. A API espera receber como imagem uma URL ou String em base 64 que representem o documento.Tabela de preços para essa chamada
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 0,160 |
| 10001 - 50000 | R$ 0,153 |
| 50001 - 100000 | R$ 0,144 |
| 100001 - 500000 | R$ 0,138 |
| 500001 - 1000000 | R$ 0,131 |
| 1000001 - 5000000 | R$ 133,000.00 (preço fixo) |
| 5000001 e acima | Entre em contato |
Paramêtros obrigatórios
Essa consulta contem parâmetros obrigatórios para o sucesso da consulta. A tabela abaixo detalha os campos necessários.
| Campo | Descrição do campo | Valores Possíveis do Campo |
|---|---|---|
| DOC_IMG | string base 64 que represente a imagem | qualquer texto |
| DOC_IMG_URL | url que represente a imagem | qualquer texto |
Abaixo está um exemplo de como realizar a chamada com parâmetros obrigatórios:
{ "Parameters": ["DOC_IMG=base64"]} Paramêtros opcionais
Essa chamada permite a passagem de parâmetros opcionais para apoiar o processo de consulta. A tabela abaixo detalha os campos opcionais.
| Campo | Descrição do campo | Valores Possíveis do Campo |
|---|---|---|
| DOC_IMG_A | string base 64 da frente do documento (em caso de frente e verso) | qualquer texto |
| DOC_IMG_B | string base 64 do verso do documento (em caso de frente e verso) | qualquer texto |
| DOC_IMG_URL_A | URL da frente do documento (em caso de frente e verso) | qualquer texto |
| DOC_IMG_URL_B | URL do verso do documento (em caso de frente e verso) | qualquer texto |
| DOC_TYPE | Tipo do documento a ser analisado | CNH |
| SIDE | Lado do documento | B |
Abaixo está um exemplo de como utilizar um dos parâmetro opcionais:
{ "Parameters": ["DOC_IMG_A=base64"]} Documentos Aceitos
Os documentos atualmente aceitos no OCR são os a seguir:
| Documento |
|---|
| CNH |
| CNH 2022 |
| RG |
| RG 2019 |
| RG 2023 |
| CIN (Carteira de Identidade Nacional) |
| Cartão CPF |
| Comprovante de CPF |
| Passaporte |
| RNE (Carteira Nacional de estrangeiro) |
| CRNM (Nova carteira de estrangeiro) |
| CTPS (Carteira de Trabalho e Previdência Social) |
| OAB (Carteira da Ordem dos Advogados do Brasil) |
| Documento de Identificação Militar Antigo |
| Documento de Identificação Militar |
| CRLV (Certificado de Registro e Licenciamento de Veículos) |
| COFEN (Conselho Federal de Enfermagem) |
Classificação
A classificação automática ou não do tipo do documento fica a critério do cliente. Para explicitar a classificação automática, basta utilizar o parâmetro "DOC_TYPE" na chamada, explicitando que tipo de documento será analisado.Ambos modos possuem suas vantagens e desvantagens. O modo automático possui maior praticidade e o benefício de auxiliar em momentos de incerteza, enquanto que alguns documentos têm uma extração melhor de suas informações se utilizada a classificação manual.
Lados do documento
Também é possível enviar duas imagens do mesmo documento, frente e verso, ao invés de uma. O Lado "A" refere-se à frente do documento, e o "B", ao verso.
Validação de Faces
| Parâmetro | Valor |
|---|---|
| "SearchFace" | true |
A API também consegue realizar uma validação no documento indicando se há ou não uma face no mesmo. Basta ao usuário adicionar os parâmetros acima.
Validação de Dados Públicos
| Parâmetro | Valor |
|---|---|
| "ForensicValidations" | true |
De forma similar, a API consegue realizar a validação dos dados extraídos do documento com dados oficiais publicamente disponíveis. Essa chamada retorna o indíce de similaridade entre os dados extraídos e os dados obtidos publicamente, onde 0 corresponde a total disparidade, e 1 a equivalência dos dados. A verificação consegue, também, identificar inconsistências como a validade do documento.Para utilizar essa chamada, basta enviar os parâmetros acima.
Integração API NadaConsta
| Parâmetro | Valor |
|---|---|
| "TrafficTicket" | True |
É possível realizar uma consulta On-Demand à API NadaConsta, junto à requisição de OCR de documentos que possuam CPF e CNH.A API de NadaConsta retorna uma pontuação baseada no retrospecto de multas e infrações, baseado no CPF e na CNH extraídos do documento.Para utilizar essa chamada, basta adicionar o parâmetro acima.
Validação de Dados Próprios
| Parâmetro | Valor |
|---|---|
| "CheckInfo" | Dicionário com pares chave-valor das informações a serem validadas |
De forma similar à validação de dados públicos, é possível validar dados extraídos do documento com os próprios dados do usuário, inseridos manualmente. Para utilizar essa chamada, basta inserir o parâmetro acima.
Códigos e Descrições de Status
| Code | Message |
|---|---|
| -704 | No info was found on the provided picture |
| -701 | An error occurred during the OCR service execution |
| 70 | Found info |
