Skip to main content
POST
/
extract
Extração assíncrona
curl --request POST \
  --url https://api.scanify.com.br/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file": {
    "fileUrl": "<string>",
    "fileBase64": "<string>",
    "filename": "<string>"
  },
  "callbackUrl": "<string>",
  "callbackAuthToken": "<string>",
  "callbackMethod": "POST",
  "includeMarkdownInWebhook": false,
  "referenceId": "<string>",
  "metadata": {},
  "signature": "<string>"
}
'
{
  "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 um documento para processamento em background. Retorna request_id imediatamente; o resultado chega no callbackUrl (webhook) ou pode ser consultado em GET /extract/{requestId}.

​
Exemplos

curl -X POST https://api.scanify.com.br/extract \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "file": {
      "fileUrl": "https://exemplo.com/documento.pdf"
    },
    "documentType": "NFE",
    "callbackUrl": "https://seu-app.com/webhooks/scanify",
    "callbackAuthToken": "token-opcional-para-validar-no-seu-endpoint",
    "signature": "assinatura-opcional"
  }'

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.

​
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>

URL que receberá o resultado quando o processamento terminar.

​
callbackAuthToken
string

Token enviado no callback para autenticação no seu endpoint.

​
callbackMethod
enum<string>
default:POST

Método HTTP usado na chamada de callback.

Available options:
POST,
PATCH,
PUT
​
includeMarkdownInWebhook
boolean
default:false

Inclui o markdown gerado no payload do callback.

​
referenceId
string

Identificador externo para rastreamento, devolvido nas respostas.

​
metadata
object

Metadados arbitrários associados à requisição.

​
signature
string

Assinatura opcional para validação do callback.

Response

Processamento iniciado.

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