Skip to main content
POST
/
extract
/
batch
Extração assíncrona em lote
curl --request POST \
  --url https://api.scanify.com.br/extract/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>' \
  --form 'callbackUrl=<string>' \
  --form 'callbackAuthToken=<string>' \
  --form callbackMethod=POST \
  --form includeMarkdownInWebhook=false \
  --form 'referenceId=<string>' \
  --form 'metadata=<string>' \
  --form 'signature=<string>' \
  --form file.items='@example-file'
[
  {
    "request_id": "<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.

Envia múltiplos documentos numa única requisição (multipart/form-data). Retorna um request_id por arquivo. Use GET /extract/batch para acompanhar o status do lote.

​
Exemplos

O endpoint aceita apenas multipart/form-data. Envie o campo file repetido (um por arquivo) e um único callbackUrl aplicado a todos. 
curl -X POST https://api.scanify.com.br/extract/batch \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -F "file=@boleto.pdf" \
  -F "file=@nfe.pdf" \
  -F "callbackUrl=https://seu-app.com/webhooks/scanify"

Authorizations

​
Authorization
string
header
required

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

Body

multipart/form-data
​
file
file[]
required

Um ou mais arquivos (campos file repetidos).

​
documentType
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
​
callbackUrl
string<uri>
​
callbackAuthToken
string
​
callbackMethod
enum<string>
default:POST
Available options:
POST,
PATCH,
PUT
​
includeMarkdownInWebhook
boolean
default:false
​
referenceId
string
​
metadata
string

Metadados como string JSON aplicados a todos os arquivos.

​
signature
string

Response

Processamento em lote iniciado.

​
request_id
string
​
status
enum<string>
Available options:
in_progress