OCR (Extração)

Este artigo explica como extrair dados de documentos através da REST API do Unico Check.

Esse método extrai dados de documentos como CNH (Aberta, frente, verso ou digital), RG (Frente ou Verso) e CRM (Frente ou verso) enviados na requisição.

Como usar?

Faça uma requisição POST para o endpoint /documents/ocr

Com o token de acesso válido, faça uma requisição para o endpoint (POST/documents/ocr) enviando os seguintes parâmetros:

{
  "type": "TIPO_DOCUMENTO",
  "Base64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso
Content-Type	String	Mandatório	"application/json"

• REQUEST BODY SCHEMA

Nome	Tipo	Mandatorio/Opcional	Descrição
type	String	Mandatório	Tipo do documento
Base64	String	Mandatório	Foto do documento. A imagem precisa ser em base64 (png, jpg, jpeg)

Exemplo de requisição:

Arquivo JSON

{
  "type": 4,
  "base64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAAAAgSURBVDhPY/wPBAwUACYoTTYYNWDUABAYNWDgDWBgAABrygQclUTopgAAAABJRU5ErkJggg=="
}

O tipo do documento pode ser encontrado no artigo de enumerados em Documentos para OCR.

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo os seguintes campos, como a seguir:

{
  "BirthDate": "01/01/2000",
  "PlaceOfBirth": "São Paulo",
  "Category": "AB",
  "ExpeditionCity": "São Paulo",
  "ExpeditionState": "SP",
  "ExpeditionDate": "01/01/2000",
  "ExpirationDate": "01/01/2000",
  "FatherName": "João",
  "MotherName": "Maria",
  "FirstLicenseDate": "01/01/2000",
  "Name": "José",
  "RG": "123456789",
  "Code": "12345678910",
  "RegistrationNumber": "01234567",
  "Renach": "789456123",
  "SecurityCode": "123456",
  "MirrorNumber": "78910",
  "CRM": "5-549788-5/PR",
  "Observation": ""
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
BirthDate	string	Indica a data de nascimento
PlaceOfBirth	string	Indica o local de nascimento
Category	string	Indica a categoria da habilitação (CNH)
ExpeditionCity	string	Indica a cidade de emissão do documento
ExpeditionState	string	Indica UF de emissão do documento
ExpeditionDate	string	Indica a data de emissão do documento
ExpirationDate	string	Indica a validade do documento
FatherName	string	Indica o nome do pai
MotherName	string	Indica o nome da mãe
FirstLicenseDate	string	Indica a data da 1ª habilitação (CNH)
Name	string	Indica o nome da pessoa
RG	string	Indica o número do RG
Code	string	Indica o número do CPF
RegistrationNumber	string	Indica o Nº de Registro da habilitação (CNH)
Renach	string	Indica o Registro Nacional de Carteira de Habilitação (CNH)
SecurityCode	string	Indica o código de segurança
MirrorNumber	string	Indica o Número do Espelho da habilitação (CNH)
CRM	string	Indica o número do CRM
Observation	string	Indica observaçoes que estão no documento

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.