Get Preference Center Data

get

https://mobile-data.onetrust.io/cfw/cmp/v1/preferences

Use this API to retrieve the required interface attributes to be rendered on the Preference Center.

Headers

OT-CDN-Location

string

enum

required

The location of the CDN.

Allowed:

OT-App-Id

string

required

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}(-test)?$

The unique identifier for the app or domain.

OT-Device-Type

string

enum

required

The type of device.

Allowed:

OT-SDK-Version

string

required

^\d{6}\.\d+\.\d+$

The published version of the app or domain.

OT-SDK-Identification

string | null

The OT SDK identification.

OT-Language

string | null

The language in which the user interface should be displayed.

OT-Country-Code

string | null

The country code from which the user is accessing the app or website.

OT-Region-Code

string | null

The region code from which the user is accessing the app or website.

OT-Fetch-Type

string | null

enum

The type of data to download.

Allowed:

OT-Consent-String

string | null

OT-Identifier

string | null

The unique identifier for the data subject.

OT-Identifier-Type

string | null

The identifier type associated with the unique identifier in OT-Identifier header

OT-Identifier-UpdateType

string | null

enum

The update type for the identifier. This header is used to specify how the identifier should be updated.

Allowed:

OT-Sync-Profile-Auth

string | null

The JSON Web Token (JWT) generated using Public Keys within the OneTrust application.

OT-Platform

string | null

enum

To handle platform-specific features like ATT (App Tracking Transparency for Apple) or GoogleAdId (for Android) in a structured way, you can send the platform type in the parameters of an API or request.

Allowed:

OT-Exclude-Html-Tags

boolean | null

This is specifically to unbold the vendor numbers only.

OT-Tcf-Eu2v2-Consent-String

string | null

OT-Addtl-Consent-String

string | null

Responses

200Success

400Bad Request

403Forbidden

404Not Found

429Too Many Requests. \nFor more information, see API Rate Limits.

500Internal Server Error