Skip to content

Upload a PDF

Base URL https://api.accessful.de/api/v1/upload-service. Every request needs the X-API-Key header — see Authentication.

POST /pdf/upload
Content-Type: multipart/form-data
FieldTypeRequiredNotes
filesfileyesOne or more PDFs (application/pdf).
webhookUrlstringnoCallback URL for webhook events.
secretstringnoYour HMAC signing secret (required for webhooks).
folder-namestringnoOptional folder to group the case.

200 OK

{
"successfulUploads": ["7c2f1e4a-9b0d-4a1e-8f3c-2d6b5a9e1c40"],
"duplicateFiles": [{ "fileName": "document.pdf", "fileHash": "ab12cd34…" }],
"message": "Upload completed successfully. Uploaded 1 files. 1 duplicates found.",
"callbackUrl": "https://your-app.example.com/hooks/accessful"
}
  • successfulUploads — one caseId per accepted file. Track and download by this ID.
  • duplicateFiles — files skipped because the same content was already uploaded under your key.

Errors: 400 (non-PDF file or invalid webhook URL), 413 (too large). Quota is checked after upload — an exhausted quota does not fail this call; the job ends in the quota_exceeded status instead. See Limits.