Data Disclosure Agreements

Check opt-in of an individual

GET/v4/service/consent/data-disclosure-agreement/record/{dataDisclosureAgreementRecordId}/individual/{individualId}

Tells whether one individual opted in to the data agreement of a data disclosure agreement record. Name the record by its canonicalId, and the individual by the external ID that your organisation knows (externalId).

Errors: 404 when the record or the individual does not exist, or when the individual has no consent record for the data agreement.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/service/consent/data-disclosure-agreement/record/{dataDisclosureAgreementRecordId}/individual/{individualId}' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "optIn": true,
  "individual": {
    "id": "6af1c2a52d6fb7b6ac6efd40",
    "externalId": "1001-2002",
    "externalIdType": "customerNumber",
    "identityProviderId": "",
    "name": "",
    "iamId": "",
    "email": "",
    "phone": "",
    "pushNotificationToken": "",
    "deviceType": "",
    "mapperId": ""
  }
}

Authorizations

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

Path parameters

dataDisclosureAgreementRecordIdstringrequired
The canonicalId of the data disclosure agreement record.
individualIdstringrequired
External ID of the individual (externalId), the ID under which your organisation knows the individual, for example a customer number.

Response

application/json

The opt-in state of the individual.

optInboolean
true when the individual opted in to the data agreement.
individualobject
A person whose consent the organisation records, for example a customer. The record can point to the person in another system through externalId. Keep personal data in it to the minimum that you need.