Skip to main content
POST
/
classify
Classificação de documento
curl --request POST \
  --url https://api.scanify.com.br/classify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": {
    "fileUrl": "<string>",
    "fileBase64": "<string>",
    "filename": "<string>"
  },
  "referenceId": "<string>",
  "metadata": {},
  "timeout": 60000
}
'
{
  "request_id": "<string>",
  "confidence": 0.5,
  "reason": "<string>",
  "document_type_detection": {
    "provided_document_type": "<string>",
    "detected_document_type": "<string>",
    "confidence": 123,
    "threshold": 123,
    "accepted": true,
    "reason": "<string>"
  }
}

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.

Retorna apenas o tipo do documento (document_type, confidence, reason) sem extrair os campos. Mais barato e rápido que a extração completa quando você só precisa identificar o tipo.

​
Exemplos

curl -X POST https://api.scanify.com.br/classify \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {
      "fileUrl": "https://exemplo.com/documento.pdf"
    },
    "referenceId": "pedido-123",
    "timeout": 60000
  }'

Authorizations

​
Authorization
string
header
required

Chave de API enviada no cabeçalho Authorization no formato: Authorization: Bearer <API_KEY>.

Body

​
file
object
required

Origem do arquivo. Forneça fileUrl OU fileBase64 (com filename obrigatório), nunca ambos.

​
referenceId
string

Identificador externo para rastreamento.

​
metadata
object

Metadados arbitrários associados à requisição.

​
timeout
integer
default:60000

Tempo máximo de espera em milissegundos.

Required range: 10000 <= x <= 300000

Response

Documento classificado.

Resultado da classificação. Não inclui campos extraídos (fields), markdown, processed_at nem o bloco scanify — apenas o tipo detectado e a justificativa. Para o resultado completo, use /extract/sync ou /extract.

​
request_id
string
​
status
enum<string>
Available options:
success
​
document_type
enum<string>

Tipo de documento. Quando omitido na extração, o tipo é detectado automaticamente.

Available options:
NFE,
BOLETO,
CONTRATO,
RECIBO,
CNH,
RG,
COMPROVANTE_RESIDENCIA,
CONTRATO_SOCIAL,
IRPF,
CERTIDAO_NASCIMENTO,
CERTIDAO_CASAMENTO,
LAUDO_MEDICO,
CERTIDAO_OBITO,
PROCURACAO,
HOLERITE,
DOCUMENTO_VEICULAR,
DOCUMENTO_JURIDICO,
EXTRATO_BANCARIO,
INFORME_RENDIMENTOS_EMPREGADOR_INSS,
INFORME_RENDIMENTOS_BANCOS,
INFORME_RENDIMENTOS_CORRETORAS,
INFORME_PLANO_SAUDE,
DESPESA_MEDICA,
COMPROVANTE_EDUCACAO,
DECLARACAO_IR_ANTERIOR
​
confidence
number | null

Confiança da classificação (0–1).

Required range: 0 <= x <= 1
​
reason
string | null

Justificativa textual gerada pelo modelo.

​
document_type_detection
object