v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Data Subjects V4

Get Data Subject Details

Use this API to retrieve complete details for a specific data subject. The response will include all of the data subject’s basic details, purpose details, and email link tokens.

get/rest/api/consent/v4/datasubjects/details

Query parameters

includeConsentGroupsboolean

This flag indicates whether data subject group information is included in the response.

includeAttachmentsboolean

This flag indicates whether attachment information is included in the response.

includeNoticesboolean

This flag indicates whether collection point notice information is included in the response.

includeConsentStringsboolean

This flag indicates whether consent string information is included in the response.

isDNCIncludeboolean

Indicates whether to include data subject in the response if the data subject is in the DNC list.

Headers

identifierstring required

The data subject identifier of the data subject.

Response

identifierstring

The data subject identifier of the data subject.

identifierTypestring

The type of data subject identifier used for the data subject's identifier.

languagestring

The language set for the data subject.

createdDatestring date-time

The date and time that the data subject record was created.

lastTransactionDatestring date-time

The date and time that the last transaction for the data subject was written to the database.

lastReceiptGuidstring uuid

The unique identifier of the latest consent receipt for the data subject.

testDataSubjectboolean

This flag indicates whether the data subject is used for testing purposes.

consentGroupsstring[]

The list of data subject group identifiers to which the data subject belongs.

idstring uuid

Unique Identifier identifying a Data Subject

lastUpdatedDatestring date-time

The date that the Data Subject record was last updated on

doNotCallboolean

This attribute determines if a phone number is listed in FCC’s Do Not Call list

Example response

{
  "identifier": "example@otprivacy.com",
  "identifierType": "Email",
  "language": "en-us",
  "createdDate": "2020-01-12T16:11:25.479Z",
  "lastTransactionDate": "2020-01-12T16:11:25.479Z",
  "lastReceiptGuid": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "testDataSubject": true,
  "dataElements": [
    {
      "name": "Work Email",
      "doNotCall": true
    }
  ],
  "latestGeoLocation": {
    "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
    "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
    "country": "US",
    "state": "GA",
    "stateName": "Georgia"
  },
  "latestSource": {
    "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
    "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
    "sourceType": "WEB",
    "sourceContent": "https://example.com/consent"
  },
  "profiles": [
    {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "identifier": "example@otprivacy.com",
      "lastReceiptId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "Marketing Communications",
      "version": 2,
      "status": "ACTIVE",
      "firstTransactionDate": "2020-01-05T11:34:30.974Z",
      "lastTransactionDate": "2020-01-12T16:11:25.479Z",
      "withdrawalDate": "2020-01-12T16:11:25.479Z",
      "consentDate": "2020-01-07T13:18:23.123Z",
      "expiryDate": "2020-01-07T13:18:23.123Z",
      "totalTransactionCount": 3,
      "topics": [
        {
          "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
          "name": "Car Marketing"
        }
      ],
      "customPreferences": [
        {
          "id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
          "name": "Email Frequency",
          "options": [
            {
              "id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
              "name": "Weekly"
            }
          ]
        }
      ],
      "purposeNote": {
        "noteId": "f312dd9b-58b4-4f34-b5ff-10b9b464bc4f",
        "noteType": "UNSUBSCRIBE_REASON",
        "noteLanguage": "en-us",
        "noteText": "I did not sign up for this.",
        "isValidNote": true
      },
      "lastUpdatedDate": "2020-01-05T11:34:30.974Z",
      "lastInteractionDate": "2020-01-05T11:34:30.974Z",
      "geolocation": {
        "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
        "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
        "country": "US",
        "state": "GA",
        "stateName": "Georgia"
      },
      "attachments": [
        {
          "attachmentId": "25d9ccac-db88-4d34-849c-3d602a629961",
          "fileName": "policy.pdf",
          "uploadedBy": "John Doe",
          "uploadDate": "2024-01-01T00:00:00"
        }
      ],
      "source": {
        "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
        "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
        "sourceType": "WEB",
        "sourceContent": "https://example.com/consent"
      }
    }
  ],
  "linkTokens": [
    {
      "token": "QFpXYCFOYUrFZfstplM5l1hjdLv4YlaQtkbYt7gpZUc=",
      "identifier": "example@otprivacy.com",
      "createdDate": "2024-01-01T00:00:00.000",
      "expiryDate": "2024-02-01T00:00:00.000"
    }
  ],
  "consentStrings": [
    {
      "type": "GPP",
      "content": "DBABMA~CQJ4dQAQJ4dQAPoABABGBUEAAAAAAAAAAAAAAAAAAAAA.QAAA.IAAA",
      "receivedDate": "2024-02-01T00:00:00.000",
      "interactionDate": "2024-02-01T00:00:00.000"
    }
  ],
  "id": "633ba071-61b0-485f-81a0-a2245777b432",
  "lastUpdatedDate": "2020-01-12T16:11:25.479Z",
  "doNotCall": true,
  "notices": [
    {
      "id": "05e30742-7e6c-4916-a5a1-7742a14ee984",
      "name": "Marketing Notice",
      "url": "www.onetrust.com",
      "guid": "1439b150-ef4c-444c-a20e-44622c8ccaf3",
      "type": "EMBEDDED",
      "purposes": [
        {
          "guid": "15e30742-7e6c-4916-a5a1-7742a14ee284",
          "name": "Marketing"
        }
      ],
      "privacyNoticeVersion": {
        "guid": "15e30742-7e6c-4916-a5a1-7742a14ee284",
        "name": "Marketing",
        "version": 1,
        "minorVersion": 2
      },
      "collectionPoint": {
        "guid": "15e30742-7e6c-4916-a5a1-7742a14ee284",
        "name": "Marketing",
        "version": 1,
        "minorVersion": 2
      }
    }
  ],
  "attachments": [
    {
      "attachmentId": "25d9ccac-db88-4d34-849c-3d602a629961",
      "fileName": "policy.pdf",
      "uploadedBy": "John Doe",
      "uploadDate": "2024-01-01T00:00:00"
    }
  ]
}