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

Log Consent

post
https://mobile-data.onetrust.io/cfw/cmp/v1/save-log-consent

Use this API to log consent when a user interacts with a Banner or Preference Center.

Body Params

Request body cannot be empty

string
enum

The type of interactions users can have with the interface.

consent
object

The consent statuses for Purposes, IAB Vendors, Google Vendors, and SDKs.

string

The browser details of the user that is accessing the app or website.

ageGate
object

The age range information for AgeGate consent. Required when interactionType is AGEGATE_RANGE.

customDataElements
object

The additional information about the user provided during their consent interaction.

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

string | null

The IAB TCF string that contains information on consent preferences.

string | null

The GPP string that contains information on consent preferences.

boolean | null

If true, only the consent explicitly provided in the request body will be submitted.

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?