Data requests

Cancel a data download request of the individual

POST/v4/service/consent/organisation/data-download/{dataReqId}/cancel

Cancels a request of the individual to download its data: the request goes to state 8 (cancelled by the individual), and your organisation gets the webhook event data.download.cancelled. Get the ID from the status route or the list.

Send only the ID of an open download request: the server does not check the type or the state of the request, and sets any request of the individual to state 8 (the webhook event then has the type of that request). In this answer, closedDate is still the value from before the cancel. This route takes an API key or a token of the identity provider of the organisation, not an individual token or a token of the privacy dashboard login.

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/service/consent/organisation/data-download/6af19d442d6fb7b6ac6efd11/cancel' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "dataRequest": {
    "id": "6af2d6182d6fb7b6ac6efd19",
    "userId": "6af081b138e8f33dcf799628",
    "userName": "[email protected]",
    "organisationId": "6ae2bf741c3dadfeb27982ec",
    "type": 2,
    "typeStr": "Download Data",
    "state": 8,
    "requestedDate": "2026-11-10 08:30:16 +0000 UTC",
    "closedDate": "0001-01-01 00:00:00 +0000 UTC",
    "stateStr": "Request cancelled by user",
    "comment": ""
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:data-requests:update

Path parameters

dataReqIdstringrequired
ID of the data request.
Example:"6af19d442d6fb7b6ac6efd11"

Headers

X-ConsentBB-IndividualIdstring
ID of the individual, or its externalId. Mandatory with an API key: without it the answer is 400 ("IndividualId is not present in request header"), and an unknown individual gets 400 too. With an individual token, leave it out: the server takes the individual from the token. Send it only on the routes that list it: with an API key that has resource scopes (for example consent-records:read), another route answers 400 to a request with this header.
Example:"6af081b138e8f33dcf799628"

Response

application/json

The cancelled data request.

dataRequestobject
A request of an individual to delete, download or update personal data that your organisation holds. The individual makes it, your organisation handles it and moves it through its states, and the individual can cancel it.