API Reference

This section is a comprehensive reference to the .Net SDK and the methods that can be called to initialize, manage, and interact with consent data.

Always use CMPSDK.sharedInstance to refer to the OneTrust SDK. Please verify the SDK successfully initializes before calling any of these methods. For more information, see Initialize the SDK.

Retrieve data to build your UI

Handling user interactions

Banner

Preference Center

When updating consent for individual categories, the Preference Center works on a "stage and commit" model. You will update the consent values for each category as it is toggled, but changes will not be saved until the Save function is called.

Vendor List

When updating consent for individual vendors, the vendor list works on a "stage and commit" model. You will update the consent values for each vendor consent as it is toggled, but changes will not be saved until the Save function is called.

Multi Profile Consent

The following methods can be used to support multi profile consent for your application if you allow multiple user profiles to use one login.

userProfiles Payload

// Returns array of profiles.  Only 1 profile can be Active.
[
  {
    "OneTrust_ConsentLoggingIdentifier": "545bd599-51d6-401e-af1c-17c0611ad81f",
    "OneTrust_UID_isAnonymous": true,
    "OneTrust_lastInteraction": "Preference Center - Confirm",
    "OneTrust_lastConsentDate": 637902346597025080,
    "isActiveProfile": true
	},
  {
    "OneTrust_ConsentLoggingIdentifier": "9898db3-51d6-401e-af1c-17c0611ad37d",
    "OneTrust_UID_isAnonymous": true,
    "OneTrust_lastInteraction": "Banner - Accept All",
    "OneTrust_lastConsentDate": 637902346597025080,
    "isActiveProfile": false
	}
]

// If you want to take lastConsentDate to a formatted date...

DateTime lastConsentDate = new DateTime(long.Parse(OneTrust_lastConsentDate));
System.Diagnostics.Debug.WriteLine(lastConsentDate.ToUniversalTime().ToString("F"));

Fetch CMP API Data*

The CMP API is split into three parts to improve the performance. The initial API call fetchs only Banner UI data and the rest of the data is fetched whenever the user navigates to a particular screen. See below the list of methods to fetch individual API data:

📘

*These changes will be available from 202503.2.0 release for MAUI/.Net SDK only.