Skip to main content
Data requests

Request to download the data of the individual

POST/v4/service/consent/organisation/data-download

Makes a request of the individual to download its data in your organisation. The request starts in state 1 (initiated), and your organisation gets the webhook event data.download.initiated. Your organisation then handles the request and sets its state with Update data request. The request stores the e-mail address of the individual as userName.

The individual can have only one open download request at a time: while one is in state 1 or 2, a new request gets 400. The answer is 200 with an empty body; read the new request with the list or the status route.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:data-requests:create

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

The server saved the request. The body is empty.

No body.