myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
  1. Consent & Preferences - Consent Management Platform (CMP)
  2. Banner

Get Banner Data

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

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

Headers
string
enum
required

The location of the CDN.

Allowed:
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.

string
enum
required

The type of device.

Allowed:
string
required
^\d{6}\.\d+\.\d+$

The published version of the app or domain.

string | null

The OneTrust SDK identification.

string | null

The language in which the UI should be displayed.

string | null

The country code from which the user is accessing the app or website. The value passed in this parameter will be used to resolve the geolocation rule.

string | null

The region code from which the user is accessing the app or website. The value passed in this parameter will be used to resolve the geolocation rule.

string | null
enum

The type of data to download. The value passed in this parameter will determine whether to download app data only or app data and the data subject profile.

Allowed:
string | null

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

string | null

The unique identifier of the data subject.

string | null

The identifier type associated with the unique identifier in the 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. This is used to sync consent for a known user.

string | null
enum

The platform-specific features, such as ATT for Apple or GoogleAdId for Android.

Allowed:
boolean | null

The flag that indicates whether to unbold the vendor numbers.

boolean | null

The flag that indicates whether the Banner configuration data is returned, irrespective of the showBanner status.

string | null

The IAB TCF string that contains information on consent preferences.

string | null

The Additional Consent string for Google Vendors.

Responses

Updated 2 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 2 months ago

Did this page help you?