Estrutura de Resposta Labels

Visão Geral

Resposta 'labels'

[
  {
    "label": <string>,
    "crop": <Base64>,
    "validation": {
      "type": <string>,
      "value": <bool/float>
    },
    "text": <string>,
    "topLeft": [696.0, 1234.0],
    "bottomRight": [579.0, 654.0],
    "ocrList": [<object(Validation)>],
    "serpro": <dict or str>,
    "ocrInterpretive": <bool or string>
  },
  {
    "label": <string>,
    ...
  }...
]

Resposta de Erro

{
  "error": {
    "message": "Não foi possível extrair o documento."
  }
}

Estrutura de Campos

Principal

Campo	Tipo	Descrição
label	object	Contêiner para dados extraídos (nome varia conforme template)
crop	Base64	Imagem do campo recortada
validation	object	Resultados de validação automática
text	string	Texto extraído pelo OCR
topLeft	float[2]	Coordenadas do canto superior esquerdo
bottomRight	float[2]	Coordenadas do canto inferior direito

Avançado

Campo	Tipo	Descrição
ocrList	object[]	Lista do mesmo objeto 'ocr'
serpro	dict/string	Dados de consulta Serpro ou mensagem de erro
ocrInterpretive	bool/string	Resposta de IA generativa com análise contextual
plate	object	Resposta de consulta a Placa de veículos

Validações Suportadas

Tipos

Tipo de Validação	Chave Retornada	Tipo Valor
Alfanumérico	isAlphanumeric	bool
Assinatura	accuracyIsSignature	float (0-1)
Checkbox	accuracyIsCheckbox	float (0-1)
CPF/CNPJ	isCpfCpnj	bool
Data	isDate	bool
Placa Veículo	isPlate	bool
Json	isJson	bool

Mais Tipos

Tipo de Validação	Chave Retornada	Tipo Valor
Digital	accuracyIsDigital	float (0-1)
Fotografia	accuracyIsPhoto	float (0-1)
Número Decimal	isFloat	bool
Texto Capitalizado	isCapitalizedString	bool

Documentação Relacionada

• Consulta CPF Serpro
• Consulta CNPJ Serpro