Documentation

The integration contract

From API key to PDF/UA in three predictable steps

One base URL, one authentication header, and one case ID connect the entire workflow.

1. 01POST/pdf/upload

   Upload

   Send one or more PDFs and receive a caseId for every accepted file.

   Open endpoint documentation
2. 02GET/job-status/{caseId}

   Track

   Poll a clear lifecycle from queued through running to a terminal status.

   Open endpoint documentation
3. 03GET/download/{caseId}

   Download

   Fetch the remediated document as a standard application/pdf response.

   Open endpoint documentation

Copy, paste, ship

Your first upload is ready to run

Choose your stack. Every sample calls the same endpoint and returns the case ID used by the rest of the API.

• Set ACCESSFUL_API_KEY
• Place document.pdf in your working directory
• Run the sample and keep successfulUploads[0]

Continue with the end-to-end quickstart

first-upload API

cURLNode.jsPython

: "${ACCESSFUL_API_KEY:?Set ACCESSFUL_API_KEY first}"

curl --fail-with-body \
  -X POST "https://api.accessful.de/api/v1/upload-service/pdf/upload" \
  -H "X-API-Key: $ACCESSFUL_API_KEY" \
  -F "files=@document.pdf"

import { openAsBlob } from 'node:fs';

const apiKey = process.env.ACCESSFUL_API_KEY;
if (!apiKey) throw new Error('Set ACCESSFUL_API_KEY first');

const file = await openAsBlob('document.pdf', {
  type: 'application/pdf',
});
const body = new FormData();
body.append('files', file, 'document.pdf');

const response = await fetch(
  'https://api.accessful.de/api/v1/upload-service/pdf/upload',
  {
    method: 'POST',
    headers: { 'X-API-Key': apiKey },
    body,
  },
);

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

# pip install requests
import os
import requests

url = "https://api.accessful.de/api/v1/upload-service/pdf/upload"
headers = {"X-API-Key": os.environ["ACCESSFUL_API_KEY"]}

with open("document.pdf", "rb") as pdf:
    response = requests.post(
        url,
        headers=headers,
        files={"files": ("document.pdf", pdf, "application/pdf")},
        timeout=60,
    )

response.raise_for_status()
print(response.json())

200 OKsuccessfulUploads[0] → caseId

Choose your next step

Go from first request to production without hunting

Each path starts where you are and takes you directly to the detail you need.

Quickstart

Run upload → status → download end to end.

Open quickstart

Live API tester

Convert a real PDF from the browser with your own key.

Try it live

API reference

Inspect every endpoint, field, response, and status code.

Browse endpoints

Webhooks

Replace polling with signed, event-driven callbacks.

Configure webhooks

Agent-ready documentation

Building with an AI coding agent?

Install the versioned Accessful skill so your agent can reason about the complete API contract without guesswork.

Download the agent skill