Data Disclosure Agreements

List opted-in individuals

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

Lists the individuals who opted in to the data agreement of a data disclosure agreement record. As the data source, use it to know whose data a data using service may receive under the agreement.

Name the record by its canonicalId.

Errors: 404 when the record does not exist.

List opted-in individuals

Language of the request sample

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

{
  "individuals": [
    {
      "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.

Response

application/json

The opted-in individuals.

individualsobject[]