Processar um documento

Crie um job de processamento assíncrono para uma versão de documento da conta.

Autenticação

Chave de API ou autenticação da conta

Escopos

documents:read, jobs:create

Contrato

API v1

Requisição

curl -X POST 'https://api.maxscanner.app/api/v1/documents/{documentId}/process' \
  -H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: unique-request-id' \
  -d '{ "operation": "convert", "format": "pdf" }'

Corpo da requisição

{ "operation": "convert", "format": "pdf" }

Resposta

{ "jobId": "job_123", "documentId": "doc_123", "versionId": "ver_4", "status": "queued" }

Notas de implementação

O servidor valida a propriedade do documento antes de enfileirar.
Use o jobId retornado para acompanhar o status.

Experimente este endpoint

Use o ambiente de testes da API para se autenticar e testar com segurança antes de integrar o endpoint ao seu aplicativo.

Abrir o ambiente de testes →