Skip to main content
Consent records

Read consent record of a data agreement

GET/v4/service/consent/individual/record/data-agreement/{dataAgreementId}

Reads the consent record of the individual for a data agreement. Use it to show the current choice of the individual. When the individual has no record for the data agreement, the answer is 200 with "consentRecord": null.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:consent-records:read

Path parameters

  • dataAgreementIdstringrequired

    Data agreement ID.

    Example:"6af080eb2d6fb7b6ac6efc57"

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 consent record, or null.

  • consentRecordobject or null