Sign in

v1

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

Get Purpose Details by Data Subject

Use this API to retrieve a data subject’s purpose details for a specific purpose. The response will include details such as the last transaction date, consent date, and purpose preferences.

get/rest/api/consent/v4/datasubjects/profiles/{purposeGuid}

Path parameters

purposeGuidstring uuid required

The unique identifier of the purpose.

Headers

identifierstring required

The data subject identifier of the data subject.

Response

OK

idstring uuid

Unique Identifier identifying a Purpose

identifierstring

The data subject identifier of the data subject.

lastReceiptIdstring uuid

Unique Identifier identifying a Receipt

namestring

The Purpose name

versioninteger

Version of the Purpose

statusstring

The status of the purpose for the data subject.

firstTransactionDatestring date-time

The date and time that the first transaction was written to the database.

lastTransactionDatestring date-time

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

withdrawalDatestring date-time

The date and time that the data subject withdrew consent for the purpose.

consentDatestring date-time

The date and time that the data subject gave their last active consent.

expiryDatestring date-time

The explicit expiration date after which the purpose is no longer valid and no further consent is collected against it.

totalTransactionCountinteger

The total number of Transactions recorded against this Purpose

topicsListstring[]

The list of topics associated with the purpose.

customPreferencesMapobject

The list of purpose preferences associated with the purpose.

lastTransactionCollectionPointIdstring uuid
lastTransactionCollectionPointVersioninteger
lastUpdatedDatestring date-time

The date and time of the latest change to the data subject profile in the database.to any of: Purpose version, Purpose Status, or Topic/Custom Preference selections

lastInteractionDatestring date-time

The date and time of the data subject's last interaction with the purpose.

attributesobject

The additional attributes associated with the purpose.

Example response

{
  "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"
  }
}