With the external API, you can download the original and anonymized documents of your projects as well as the related current project configurations. Mapping is done via the respective project ID.
A full description of all endpoints and response fields is available in the API documentation.
Prerequisite
Send your API key with every request in the Authorization header:
Authorization: Bearer <API-Key>
1. Retrieve available projects
The response contains all projects your API key can access. Perform the following steps for each returned project.
2. Download the project configuration
Retrieve project configuration
Replace {projectId} with the ID from step 1 and save the response, for example as config.json.
3. Retrieve documents for a project
Results are returned page by page. Fetch all pages and include documents with status COMPLETED or FINALIZED.
4. Download anonymized documents
Replace {projectId} and {documentId} with the values from the document list. Repeat this step for each document.
If the API responds with status 409, the document is still being created. Try the download again after a short wait.
5. Download original documents
Use the same project and document ID as for downloading the anonymized document. Repeat this step for each document.
Original documents are only available if they are stored in the respective project. Otherwise, the API responds with status 403.