document-understanding
latest
false
- Getting Started
- Examples Using the Document Understanding™ Cloud API
- Running API Calls
- Authorize using an External Application and retrieve the available resources
- Use the Discovery APIs
- Use the Digitization APIs
- Use the Delete Document Data service
- Licensing
- Troubleshooting
Document Understanding API Guide
Last updated Jun 10, 2025
PREVIEWUse the Delete Document Data service
Note:
To ensure improved control, only External Applications with the following scope can
access this endpoint:
Du.Deletion.Api. Make sure to add this scope
to your application before authenticating.
You can use the DELETE API to remove all runtime and validation data (excluding Monitor data) related to a given
documentId, including:
- Digitization results (Document Object Model, text, optimized PDFs)
- Classification and extraction results
- Validation and classification tasks (based on user input)
This API allows you to clean up all associated data from a document without waiting for the automatic seven-day expiration.
To initiate the deletion of all data linked to a document, use the following
call:
POST /projects/{projectId}/document/{documentId}/POST /projects/{projectId}/document/{documentId}/After this call, a
202 Accepted response message is displayed to confirm
the deletion request. To confirm the deletion, use the following
call:GET /digitization/{documentId}GET /digitization/{documentId}Once the deletion is complete, a
404 Not Found message is
returned.
You can also use the following optional input parameter when making the deletion
call:
forceDeleteValidationData: true or false (default)forceDeleteValidationData: true or false (default)
The
forceDeleteValidationData parameter controls whether the associated
open validation or classification tasks should be deleted as well:
-
-
If set to
true, the tasks are deleted and become inaccessible.
-
- If set to false and open tasks exists, the API returns the following
message:
403 Forbidden Cannot delete document with ID {documentId}, as it has open validation tasks – either complete the created tasks or set the forceDeleteValidationData option to “true”.403 Forbidden Cannot delete document with ID {documentId}, as it has open validation tasks – either complete the created tasks or set the forceDeleteValidationData option to “true”.
