v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Data Subjects V3

Get Data Subject

❗️ Migration Recommendation

Please, do not adopt this API if you have not already done so. Continue to use the Get List of Data Subjects V1 API or request access to have Data Subjects V4 APIs enabled.

Use this API to retrieve a single data subject using the identifer header parameter.

🗒 Things to Know

This API can also be used to retrieve the magic link token as linkToken in the response.

This API will remain available during maintenance periods.

This API is not designed to be used in workflows.

get/rest/api/preferences/v3/datasubjects/profile

Query parameters

includeInstantLinkTokenboolean

Includes the data subject's instant link token in the response that is used to login to the preference center.

isDNCIncludeboolean

Includes whether the data subject's phone numbers are on the FTC Do Not Call registry or not.

Headers

identifierstring required

Data subject to return details for.

Response

Data subject details retrieved successfully.

idstring uuid

Unique Identifier identifying a Data Subject

languagestring

The preferred language for the Data Subject

identifierstring

The Data Subject identifier value

linkTokenstring

The Data Subject magic link token

lastUpdatedDatestring date-time

The date that the Data Subject record was last updated on

createdDatestring date-time

The date when the Data Subject record was created

testDataSubjectboolean

Flag indicating if Data Subject is a test Data Subject

doNotCallboolean

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

additionalIdentifierInstantLinkTokensobject

Instant access link tokens for additional identifiers

Example response

{
  "id": "1b1f53d3-dc40-4288-abf1-74a4a4c33510",
  "language": "en-us",
  "identifier": "example@otprivacy.com",
  "linkToken": "jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ=",
  "lastUpdatedDate": "2020-01-12T16:11:25.479Z",
  "createdDate": "2020-01-12T16:11:25.479Z",
  "dataElements": [
    {
      "name": "Work Email",
      "doNotCall": true
    }
  ],
  "purposes": [
    {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "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"
            }
          ]
        }
      ],
      "groupEffectiveStatus": [
        {
          "groupId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "effectiveStatus": "ACTIVE"
        }
      ],
      "lastUpdatedDate": "2020-01-05T11:34:30.974Z",
      "lastInteractionDate": "2020-01-05T11:34:30.974Z"
    }
  ],
  "Notices": [
    {
      "Id": "05e30742-7e6c-4916-a5a1-7742a14ee984",
      "Name": "Marketing Notice",
      "Url": "www.onetrust.com",
      "Guid": "1439b150-ef4c-444c-a20e-44622c8ccaf3",
      "Type": "EMBEDDED",
      "Purposes": [
        {
          "Id": "cbac5669-1445-4520-ba15-b1993902b295",
          "Name": "Entity Name"
        }
      ],
      "PrivacyNoticeVersion": {
        "Id": "fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279",
        "Name": "Entity Name",
        "Version": 1,
        "MinorVersion": 1
      },
      "CollectionPoint": {
        "Id": "fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279",
        "Name": "Entity Name",
        "Version": 1,
        "MinorVersion": 1
      }
    }
  ],
  "testDataSubject": true,
  "doNotCall": true
}