Data requests

Read the open data download request of the individual

GET/v4/service/consent/organisation/data-download/status

Tells if the individual has an open request (state 1 or 2) to download its data in your organisation, and gives its ID, state and date. Use it, for example, to show a cancel button. 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 'https://demo-api.igrant.io/v4/service/consent/organisation/data-download/status' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "requestOngoing": true,
  "id": "6af2d6182d6fb7b6ac6efd19",
  "state": 1,
  "stateStr": "Request initiated",
  "requestedDate": "2026-11-10 08:30:16 +0000 UTC"
}

Authorizations

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

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 open download request, or requestOngoing false.

requestOngoingboolean
true when the individual has an open request of this type.
Example:true
idstring
ID of the open request, or "".
Example:"6af19d442d6fb7b6ac6efd11"
stateenum<integer>
State of the open request: 1 initiated, 2 acknowledged. 0 when there is no open request.
Available options:0,1,2
Example:2
stateStrenum<string>
Name of the state, or "".
Available options:,Request initiated,Request acknowledged
Example:"Request acknowledged"
requestedDatestring
Date and time of the open request in UTC, in the text form YYYY-MM-DD hh:mm:ss +0000 UTC (not RFC 3339), or "".
Example:"2026-11-09 10:15:32 +0000 UTC"