Pré-requisito: Antes de começar, gere sua chave de API na plataforma do Scanify.

1

Autentique-se com sua chave de API

Todas as requisições à API do Scanify exigem uma chave de autenticação no cabeçalho Authorization.

Exemplo:

-H "Authorization: Bearer SUA_API_KEY"

Você pode copiar sua chave diretamente na área de onboarding da plataforma.

2

Envie um documento para processamento

Faça uma requisição para o endpoint principal /extract com o documento a ser processado.

A requisição deve usar o método POST e o formato multipart/form-data.

curl -X POST https://api.scanify.com.br/extract \
  -H "Authorization: Bearer SUA_API_KEY" \
  -F "file=@boleto.pdf" \
  -F "callback_url=https://seusistema.com/webhook"
  • O campo file deve conter o PDF ou imagem do documento.
  • O campo callback_url é opcional, mas recomendado para receber o resultado automaticamente.

Importante: verifique se o documento atende aos formatos suportados (PDF, JPG, PNG) e aos limites do seu plano.

3

Receba o resultado via Webhook

Se você enviou um callback_url, o Scanify enviará o resultado e a validação automaticamente assim que o processamento for concluído.

Exemplo de payload de resposta:

{
  "request_id": "abc123",
  "document_type": "BOLETO",
  "status": "partial_success",
  "fields": {
    "barcode": { "value": "2379...", "error": null },
    "due_date": { "value": null, "error": "Formato inválido" }
  },
  "processed_at": "2025-05-15T21:00:00Z"
}

Se o seu endpoint retornar erro, o Scanify tentará reenviar por um tempo limitado.

​
Consultar histórico manualmente (opcional)

Caso não utilize webhook, você pode acompanhar suas requisições diretamente pelo painel da plataforma, na seção Atividade. Lá é possível ver o status de cada documento processado e baixar os resultados manualmente.

​
Resolução de Problemas