Process a document

Create an asynchronous processing job for an account-owned document version.

Authentication

API key or account auth

Scopes

documents:read, jobs:create

Contract

API v1

Request

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" }'

Request body

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

Response

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

Implementation notes

The server validates document ownership before enqueueing.
Use the returned jobId for status tracking.

Try this endpoint

Use the API Playground to authenticate and test safely before wiring the endpoint into your application.

Open Playground →