Cleardox API

You can easily integrate your systems with Cleardox through our JSON REST API. The API is documented with OpenAPI (Swagger) so Client SDKs can be generated for most programming languages including: JavaScript, TypeScript, Python, C#, Java, PHP, Go and others.

All Cleardox features are available through the API, including:

• Upload documents, with the ability for a user to review the documents in the Cleardox UI
• Retrieve the text content of the documents
• Retrieve and manipulate information to remove in documents
• Add appendix stamps, page numbers, text, lines and more to PDF's
• PDF manipulation: collect, split, move pages, anonymize pages, delete pages, etc.
• Automatic OCR processing of uploaded documents
• Convert Office documents, images, MSG files and more to PDF
• Download the anonymised documents

And much more - contact us to view documentation or for further information

1# Basic API usage for uploading document to cleardox.
2# If a user should go through the document they can be redirected to the returned `redirectUrl`.
3# When the user has completed their work in Cleardox:
4# - Optional: A request will be made to `Result-Url` with project info.
5# - Optional: User will be redirected to `Redirect-Url` with project info in query params.
6curl --data-binary "@file.pdf" \
7    -H "Authentication: $TOKEN" \
8    -H "X-Result-Url: $RESULT_URL" \
9    -H "X-Redirect-Url: $REDIRECT_URL" \
10    $CLEARDOX_URL/api/documents/upload
11{
12    "projectId": "...",
13    "redirectUrl": "...",
14    ...
15}