Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subjects V4

Get Data Subject

Use this API to retrieve a data subject’s basic details. The response will include details such as the data subject’s created date, last transaction date, and data elements.

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

Query parameters

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

OK

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"
  },
  "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"
    }
  ]
}