Document operations API
Connect ProofSyncer to the systems you already run.
The direct ProofSyncer service and public Apify Actor remain independent. Enterprise API keys have limited permissions, expire, can be revoked, and support safe per-document retries inside batches.
{
"batchStatus": "processing",
"completed": 42,
"needsAttention": 3,
"delivery": "signed"
}What you get
Ready work with a clear decision trail.
How it works
- 1Create a limited API key
- 2Create a batch or send one document
- 3Upload each batch item with a stable item key
- 4Close the batch and monitor or export results
Integration reference
A focused API with enterprise safeguards.
Create an expiring key from Connections. Send it as a Bearer token. Keys can be limited to read or write access, revoked immediately, and are rate-limited per minute. Files remain limited to 8 MB and PDFs to 10 pages; API batches accept up to 500 independently uploaded items and 200 MB in aggregate.
/api/v1/documentsAdd one PDF, PNG, JPEG or WebP file. Use an Idempotency-Key to make retries safe.
/api/v1/documents/{id}/processStart the protected extraction and validation workflow immediately.
/api/v1/documents/{id}Read safe job, result, evidence, rule and route information.
/api/v1/batchesCreate a durable import batch for up to 500 expected items.
/api/v1/batches/{id}/documentsUpload one bounded file with a stable itemKey and sequence. Never send a giant file array.
/api/v1/batches/{id}/closeClose uploads and release accepted items to background processing.
/api/v1/batches/{id}Read batch counts and per-document progress.
/api/v1/batches/{id}/export?format=csvDownload safe structured results and item errors as CSV or JSON.
Safe retries
Reuse the same 8–120 character Idempotency-Key for a single document. Inside a batch, keep the same 8–64 character itemKey when retrying one file.
Signed outcomes
Deliveries include a unique event ID, Unix timestamp and HMAC-SHA256 signature. Receivers should verify the signature and deduplicate the event ID.