> ## 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.

# Processamento em lote

> Inicia o processamento assíncrono de múltiplos documentos em uma única requisição multipart (vários campos file). Retorna um array com um request_id por arquivo enviado.

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.

<CodeGroup>
  ```bash cURL theme={"dark"}
  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"
  ```

  ```javascript Node.js (axios + form-data) theme={"dark"}
  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);
  ```

  ```python Python (requests) theme={"dark"}
  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())
  ```
</CodeGroup>


## OpenAPI

````yaml POST /extract/batch
openapi: 3.0.0
info:
  title: API Scanify
  version: 1.0.0
  description: >-
    API do Scanify para extração e classificação de dados de documentos. Esta
    API permite enviar arquivos (via URL, base64 ou upload multipart) para
    extração estruturada de campos.
  contact:
    name: Suporte Scanify
    url: https://scanify.com.br/support
    email: suporte@scanify.com.br
  license:
    name: Proprietary
    url: https://scanify.com.br/terms
servers:
  - url: https://api.scanify.com.br
security:
  - apiKeyAuth: []
paths:
  /extract/batch:
    post:
      summary: Extração assíncrona em lote
      description: >-
        Inicia o processamento assíncrono de múltiplos documentos em uma única
        requisição multipart (vários campos file). Retorna um array com um
        request_id por arquivo enviado.
      operationId: extractBatch
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BatchExtractMultipartRequest'
      responses:
        '200':
          description: Processamento em lote iniciado.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AcceptedRequest'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyAuth: []
components:
  schemas:
    BatchExtractMultipartRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: array
          items:
            type: string
            format: binary
          description: Um ou mais arquivos (campos file repetidos).
        documentType:
          $ref: '#/components/schemas/DocumentType'
        callbackUrl:
          type: string
          format: uri
        callbackAuthToken:
          type: string
        callbackMethod:
          type: string
          enum:
            - POST
            - PATCH
            - PUT
          default: POST
        includeMarkdownInWebhook:
          type: boolean
          default: false
        referenceId:
          type: string
        metadata:
          type: string
          description: Metadados como string JSON aplicados a todos os arquivos.
        signature:
          type: string
    AcceptedRequest:
      type: object
      properties:
        request_id:
          type: string
        status:
          type: string
          enum:
            - in_progress
    DocumentType:
      type: string
      description: >-
        Tipo de documento. Quando omitido na extração, o tipo é detectado
        automaticamente.
      enum:
        - 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
    Error:
      type: object
      properties:
        message:
          type: string
        request_id:
          type: string
          description: Presente em alguns erros de processamento.
      required:
        - message
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: Unauthorized
  responses:
    ValidationError:
      description: Requisição inválida (dados ou arquivo inválidos).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Chave de API ausente ou inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Chave de API enviada no cabeçalho Authorization no formato:
        Authorization: Bearer <API_KEY>.

````