Skip to main content
POST
/
extract
Extração de dados de documentos
curl --request POST \
  --url https://api.scanify.com.br/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form documentType=NFE \
  --form 'callbackUrl=<string>' \
  --form 'referenceId=<string>' \
  --form 'metadata={}' \
  --form file=@example-file
{
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "in_progress",
  "excessPrice": 81
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
file
file
required

O arquivo do documento a ser processado

​
documentType
enum<string>
required

Tipo do documento a ser processado

Available options:
BOLETO,
NFE
Example:

"NFE"

​
callbackUrl
string
required

URL para receber notificações de callback quando o processamento for concluído

​
referenceId
string | null

ID de referência opcional para rastreamento do processamento

​
metadata
object | null

Qualquer informação/metadados adicional que o usuário queira associar ao documento, será retornado no callback

Response

Documento enviado com sucesso e processamento iniciado

​
requestId
string<uuid>

ID único da requisição de processamento

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
status
string

Status atual do processamento

Example:

"in_progress"

​
excessPrice
number

Informa o cliente se haverá cobrança de excedente, caso o plano seja compatível

Example:

81