Skip to main content
DELETE
/
document-requests
/
{id}
Void document request
curl --request DELETE \
  --url https://api.uk.veridox.ai/document-requests/{id} \
  --header 'x-api-key: <api-key>'
{
  "error_code": "<string>",
  "error_message": "User tried to perform an invalid operation on a file without a risk score.",
  "error_details": {
    "field": "email_address"
  }
}
Permanently deactivate a document request. This action expires the request and voids the secure upload link provided to the recipient. Once voided, the recipient will no longer be able to access the upload page or upload any further files.
This endpoint requires the Document Requests feature to be enabled for your organisation. If you receive a 403 with request.organisations.module.not-enabled, contact your organisation admin to have it activated. Learn more.

​
Immediate Voiding

The guest access token associated with the request is invalidated immediately upon deletion. This is useful for cancelling requests that are no longer needed or were sent to the wrong recipient in error.

​
File Retention

Any files that were already uploaded via the request before deletion remain in the associated case and are not removed from the system.

​
Best Practices

  1. Confirm Before Deletion: Provide a confirmation step in your UI before permanently voiding a request to prevent accidental deactivation.
  2. Use for Cancellation: Proactively void requests that are no longer required to maintain security hygiene and prevent unauthorised uploads.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Document request ID

Response

Document request voided successfully