EqualDoc Try EqualDoc

API

EqualDoc API

Integrate EqualDoc's PDF accessibility processing into your own workflows: for single documents as well as for large document collections.

Draft. The EqualDoc API is being planned and is not publicly available yet. This page shows the intended concept; endpoints, fields and responses may change before launch.

What the API is for

The API is meant for organisations that want to process PDFs automatically rather than one by one in the browser.

Documents from your document management system, your content management system or your line-of-business applications are passed to EqualDoc, remediated and returned with an accessibility report, with no manual step in between.

  • Process single PDFs on demand
  • Process large document volumes in batches
  • Integrate with existing workflows and systems
  • Retrieve the remediated PDF and the report

How processing works

Every document goes through four steps. Processing is asynchronous: you start it and check the status until the result is ready.

  1. Upload the PDF

    You send the document and receive a document ID.

    POST /v1/documents

  2. Start processing

    EqualDoc analyses the document, remediates it and validates the result.

    POST /v1/documents/{id}/convert

  3. Check the status

    The status shows whether the document is queued, being processed or finished.

    GET /v1/documents/{id}

  4. Retrieve the result

    You download the remediated PDF and the accessibility report.

    GET /v1/documents/{id}/result

Endpoints (draft)

A first overview of the intended endpoints.

Draft, not a binding API contract. Paths, parameters and responses will be settled before launch and then fully documented.

POST /v1/documents
Upload a PDF and create a document
POST /v1/documents/{id}/convert
Start remediation
GET /v1/documents/{id}
Get status and metadata
GET /v1/documents/{id}/result
Retrieve the remediated PDF and the report
DELETE /v1/documents/{id}
Delete the document and its results

Example: processing a document

This is how processing could look with curl. The address, document ID and key are placeholders.

Request: upload a PDF and start processing
curl -X POST https://api.equaldoc.example/v1/documents \
  -H "Authorization: Bearer $EQUALDOC_API_KEY" \
  -F "file=@annual-report-2026.pdf"

curl -X POST https://api.equaldoc.example/v1/documents/doc_7f3a9c/convert \
  -H "Authorization: Bearer $EQUALDOC_API_KEY"
Response: check the status (GET /v1/documents/doc_7f3a9c)
{
  "id": "doc_7f3a9c",
  "status": "completed",
  "pages": 24,
  "created_at": "2026-10-05T09:12:04Z",
  "result": "/v1/documents/doc_7f3a9c/result"
}

Intended statuses: queued, processing, completed, failed.

Access and batch processing

API keys

Access will later use API keys that you create and revoke in your account. Every request sends the key as a bearer token. API keys cannot be created yet.

Batch processing and integrations

Batch processing and automated integrations are part of the product concept: submit many documents in one job and retrieve the results together. A notification on completion, for example via webhook, is planned.

Want to integrate EqualDoc into your workflows?

Tell us which documents and systems you would like to connect. We will get in touch as soon as API access is available.

Contact us Product overview