Quickstart - Scanify

Pré-requisito: uma chave de API válida. Se ainda não tem, veja Autenticação.

Envie um documento

Faça um POST para /extract/sync informando a URL do arquivo no corpo da requisição.

curl -X POST https://api.scanify.com.br/extract/sync \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {
      "fileUrl": "https://exemplo.com/boleto.pdf"
    }
  }'

Substitua https://exemplo.com/boleto.pdf pela URL do seu arquivo. Também é possível enviar o arquivo em base64 (fileBase64) ou via multipart/form-data.

Inspecione a resposta

A resposta em sucesso traz o request_id, o tipo detectado, os campos extraídos e o bloco scanify com a avaliação de confiabilidade.

{
  "request_id": "req_01H...",
  "document_type": "BOLETO",
  "status": "success",
  "fields": {
    "valor_total": {
      "value": "150.00",
      "confidence_score": 0.98
    }
  },
  "scanify": {
    "reliability_score": 0.94,
    "reliability_level": "high",
    "schema_version": "1.0"
  }
}

O bloco scanify agrega a confiabilidade geral da extração. Veja Confiabilidade para entender cada campo.

Próximos passos

Fluxo de uso

Síncrono, assíncrono e em lote.

Webhook

Receba o resultado por callback.

Tipos de documento

Documentos suportados e campos.

Referência da API

Todos os parâmetros do endpoint.

Introdução