Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scanify.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Validação automática de campos

Após extrair os dados de um documento, o Scanify valida automaticamente os campos com base em regras brasileiras. A validação se aplica a todos os tipos de documento suportados — cada tipo possui seu próprio conjunto de campos, mas o mecanismo é o mesmo.

Como funciona

Cada campo extraído retorna um objeto com value e, quando há problema, um error:
"due_date": {
  "value": null,
  "error": "Formato inválido"
}
Se o campo foi extraído e validado com sucesso:
"issuer_cnpj": {
  "value": "12345678000199"
}
O status geral da resposta reflete o resultado da validação de todos os campos do documento.

Possíveis status da resposta

StatusSignificado
successTodos os campos extraídos e validados com sucesso
partial_successAlguns campos extraídos, outros inválidos
failedO documento não pôde ser processado ou retornou erro geral

Tipos de validação aplicados

  • Datas (formato, validade)
  • Valores (normalização para number)
  • Códigos (ex: chave de acesso NF-e, CNPJ, linha digitável de boleto)
  • Formatação específica por tipo de documento
Todos os erros são retornados diretamente no payload de resposta, no campo error de cada item. Consulte Tipos de Documento para ver os campos de cada tipo.