Skip to main content
GET
Consultar Documento OCR

Path Params

id
string
required
Identificador do documento, retornado no envio.Exemplo: 123e4567-e89b-12d3-a456-426614174000

Response

Além dos campos descritos em Consultar Documento, a resposta traz os documentos extraídos pelo OCR.
docs
array
Documentos identificados na extração. Permanece vazio enquanto a extração não é concluída.
docs[].docName
string
Nome do documento extraído.Exemplo: CNH
docs[].docId
integer
Identificador do documento no processamento.Exemplo: 262740
docs[].docType
string
Tipo do documento identificado.Exemplo: cnh
docs[].type
string
Classificação atribuída ao documento na extração.Exemplo: identificacao
docs[].keys
array
Campos extraídos do documento.
docs[].keys[].keyAlias
string
Identificador do campo extraído.Exemplo: nome
docs[].keys[].keyName
string
Nome do campo extraído.Exemplo: Nome
docs[].keys[].value
string
Valor lido no documento.Exemplo: JOAO DA SILVA