List Opted-In Individuals

GET 
/v3/service/data-disclosure-agreement/record/:dataDisclosureAgreementRecordId/individuals

Lists individuals that have opted-in to the underlying Data Agreement within the specified Data Disclosure Agreement Record.

Request

Path Parameters

dataDisclosureAgreementRecordId stringrequired

Unique ID of a Data Disclosure Record

Responses

200

List of Opted-In Individuals

application/json

Schema

Schema

individuals object[]required

Example (from schema)

{
  "individuals": [
    {
      "id": "64541a2e6e7569000145cd66",
      "externalId": "[email protected]",
      "externalIdType": "email",
      "identityProviderId": "64541a2e6e7569000145ab12",
      "name": "string",
      "iamId": "string",
      "email": "string",
      "phone": "string",
      "pushNotificationToken": "string",
      "deviceType": "android",
      "mapperId": "string"
    }
  ]
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

Resource not found

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...