🚧  API Specification Update in Progress: We're migrating our APIs from Swagger 2.0 to OpenAPI 3.1.0. This upgrade brings improved compatibility, flexibility, and support for modern API standards. For more information, see OneTrust API Migration to OpenAPI 3.1.0.

Get Data Subject's Preferences

Use this API to retrieve a list of all consent preferences for a data subject identifier. The response will include details such as consent date, Purpose Preferences, and data subject's geolocation. The response will also include relevant information about data elements and last interaction date, along with the current status of consent for the purposes that the data subject has interacted with.

🗒

Things to Know

  • This API uses an authorization token with public key model that reduces query response time and bypasses rate limits that are in place with the main APIs that rely on querying the main OneTrust database.
  • This API does not require an intermediary server-server API call. It is optimized for client-side applications, maintaining security to make quick decisions based on data subject consent.
  • The response of this API will not return updates made via the Update Data Subject's Preferences in a Preference Center API.
Query Params
string

UUID of the sync group.

Headers
string
required

ID of a data subject.

string
required

UUID of the tenant. The value can be retrieved in the OneTrust application using Get Help > Contact Us > Account ID.

string
required

Authorization token for the data subject. Refer Using an authorization token with public key model for more details.

Responses

401

Unauthorized

403

Forbidden

404

Not found

Language
Choose an example:
application/json
*/*