myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Get Universal Consent Purposes

get
https://mobile-data.onetrust.io/cfw/cmp/v1/uc-purposes

Use this API to retrieve the required interface attributes to be rendered for Universal Consent Purposes.

Headers
string
enum
required

The location of the CDN.

Allowed:
string
required

The unique identifier for the app or domain.

string
enum
required

The type of device.

Allowed:
string
required

The published version of the app or domain.

string | null

The OT SDK identification.

string | null

The language in which the user interface should be displayed.

string | null

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

string | null

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

string | null
enum

The type of data to download.

Allowed:
string | null

The encoded consent string that contains the interface's metadata.

string | null

The unique identifier for the data subject.

string | null

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

string | null
enum

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

Allowed:
string | null

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

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:
boolean | null

This is specifically to unbold the vendor numbers only.

Responses

Updated 4 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 4 months ago