Processamento em lote

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'

import requests

url = "https://api.scanify.com.br/extract/batch"

files = { "file.items": ("example-file", open("example-file", "rb")) }
payload = {
    "file": "<string>",
    "callbackUrl": "<string>",
    "callbackAuthToken": "<string>",
    "callbackMethod": "POST",
    "includeMarkdownInWebhook": "false",
    "referenceId": "<string>",
    "metadata": "<string>",
    "signature": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('callbackUrl', '<string>');
form.append('callbackAuthToken', '<string>');
form.append('callbackMethod', 'POST');
form.append('includeMarkdownInWebhook', 'false');
form.append('referenceId', '<string>');
form.append('metadata', '<string>');
form.append('signature', '<string>');
form.append('file.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.scanify.com.br/extract/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scanify.com.br/extract/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scanify.com.br/extract/batch"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scanify.com.br/extract/batch")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scanify.com.br/extract/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

[
  {
    "request_id": "<string>",
    "status": "in_progress"
  }
]

{
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "Unauthorized"
}

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'

import requests

url = "https://api.scanify.com.br/extract/batch"

files = { "file.items": ("example-file", open("example-file", "rb")) }
payload = {
    "file": "<string>",
    "callbackUrl": "<string>",
    "callbackAuthToken": "<string>",
    "callbackMethod": "POST",
    "includeMarkdownInWebhook": "false",
    "referenceId": "<string>",
    "metadata": "<string>",
    "signature": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('callbackUrl', '<string>');
form.append('callbackAuthToken', '<string>');
form.append('callbackMethod', 'POST');
form.append('includeMarkdownInWebhook', 'false');
form.append('referenceId', '<string>');
form.append('metadata', '<string>');
form.append('signature', '<string>');
form.append('file.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.scanify.com.br/extract/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scanify.com.br/extract/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scanify.com.br/extract/batch"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scanify.com.br/extract/batch")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scanify.com.br/extract/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackUrl\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackAuthToken\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"callbackMethod\"\r\n\r\nPOST\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"includeMarkdownInWebhook\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"referenceId\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

[
  {
    "request_id": "<string>",
    "status": "in_progress"
  }
]

{
  "message": "<string>",
  "request_id": "<string>"
}

{
  "error": "Unauthorized"
}

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"

import axios from 'axios';
import FormData from 'form-data';
import fs from 'node:fs';

const form = new FormData();
form.append('file', fs.createReadStream('boleto.pdf'));
form.append('file', fs.createReadStream('nfe.pdf'));
form.append('callbackUrl', 'https://seu-app.com/webhooks/scanify');

const { data } = await axios.post(
  'https://api.scanify.com.br/extract/batch',
  form,
  {
    headers: {
      Authorization: 'Bearer SUA_CHAVE_DE_API',
      ...form.getHeaders(),
    },
  },
);

console.log(data);

import requests

files = [
    ("file", ("boleto.pdf", open("boleto.pdf", "rb"), "application/pdf")),
    ("file", ("nfe.pdf", open("nfe.pdf", "rb"), "application/pdf")),
]
data = {"callbackUrl": "https://seu-app.com/webhooks/scanify"}

response = requests.post(
    "https://api.scanify.com.br/extract/batch",
    headers={"Authorization": "Bearer SUA_CHAVE_DE_API"},
    files=files,
    data=data,
)
response.raise_for_status()
print(response.json())

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

Extração assíncrona Consultar resultado

​Exemplos

Authorizations

Body

Response

Exemplos