Domain Data
Get Domain Data
Use this API to retrieve a list of all templates, cookie consent models, and vendor lists data for the specified domain in JSON format.
get/domaindata
Headers
location'cdn.cookielaw.org' | 'otcc-training.onetrust.com' | 'otcc-demo.otprivacy.com' | 'cookie-cdn.cookiepro.com' | 'cdn-ukwest.onetrust.com' | 'cdn-au.onetrust.com' required
The blob location where the JSON data is stored.
domainstring required
The hexadecimal domain Id in OneTrust Admin Portal. This string is obtained from the URL on the specific pages in OneTrust Admin Portal relating to that domain. (Example- The script page or the scan results page for that domain.)
langstring required
The ISO 639-1 language code to return the back translated text for the Banner and Preference Center UI properties.This is the two letter ISO language code for the language you would like returned.
OT-Country-Codestring
This is the optional value for passing a ISO 3166-2 country code to return a geolocation rule that matches this country code instead of the country code auto-determined by the server.
OT-Region-Codestring
This is the optional value for passing a ISO 3166-2:US code to return a geolocation rule that matches this region code instead of the region code auto-determined by the server. For this to work at the US state level, the OT-Country-Code parameter will also need to be passed as "us".
sdkVersionstring
The sdk version number in OneTrust Admin Portal. This string is related to version number by which the domain was published. You can refer the version number for the published domain in OneTrust Admin Portal relating to that domain. (Example - The script page for that domain.)
fetchHtmlAndCssboolean
This is an optional value for passing a ISO 3166-2:US code to return HTML and CSS content for the given domain. When passed as True, SSR feature needs to be enabled to dsiplay Html and CSS content in the API response.
Response
OK
Example response
{
"domain": {
"UseV2": true,
"MobileSDK": true,
"ScriptType": "Production",
"Version": "5.10.0",
"OptanonDataJSON": "b97c9cf3-6801-4463-8cf8-f557a00a4052",
"GeolocationUrl": "https://geolocation.1trust.app/cookieconsentpub/v1/geo/location"
},
"culture": {
"DomainData": {
"cctId": "b97c9cf3-6801-4463-8cf8-f557a00a4052",
"MainText": "OneTrust Privacy and Preference Center",
"MainInfoText": "We process user's data to deliver content or advertisements and measure the delivery of such content or advertisements, extract insights and generate reports to understand service usage; and/or accessing or storing information on devices for that purpose. Below you may read further about the purposes for which we process data, exercise your preferences for processing, and/or see our partners.",
"AboutText": "More Information",
"AboutCookiesText": "Your Privacy",
"ConfirmText": "Accept All Settings",
"AllowAllText": "Save Settings",
"CookiesUsedText": "Cookies Used",
"AboutLink": "https://cookiepedia.co.uk/giving-consent-to-cookies",
"HideToolbarCookieList": true,
"ActiveText": "Always Active",
"AlertNoticeText": "We use cookies to personalise content and ads, to provide social media features and to analyse our traffic. We also share information about your use of our site with our social media, advertising and analytics partners. You may read more about any of the purposes or vendors that we use by clicking 'Show Purposes'. This preference center is accessible at any time through the 'Manage Privacy Preferences' button located on every page.<a href=https://www.onetrust.com/privacy-notice/>Privacy Policy</a>",
"AlertCloseText": "Close",
"AlertMoreInfoText": "Settings",
"CookieSettingButtonText": "Cookie Settings",
"AlertAllowCookiesText": "Accept",
"LastReconsentDate": 1573844708133,
"BannerTitle": "OneTrust",
"ForceConsent": true,
"InactiveText": "Inactive",
"CookiesText": "Cookies Used",
"CategoriesText": "Cookie Subgroup",
"LifespanText": "Lifespan",
"BannerPosition": "default",
"PreferenceCenterPosition": "default",
"PreferenceCenterConfirmText": "Confirm My Choices",
"VendorListText": "List of Partners",
"ThirdPartyCookieListText": "Cookies Details",
"PreferenceCenterManagePreferencesText": "Manage Cookie Preferences",
"PreferenceCenterMoreInfoScreenReader": "This opens coookie policy in a new window",
"CookieListTitle": "Cookie List",
"CookieListDescription": "A cookie is a small piece of data (text file) that a website – when visited by a user – asks your browser to store on your device in order to remember information about you, such as your language preference or login information. Those cookies are set by us and called first-party cookies. We also use third-party cookies – which are cookies from a domain different than the domain of the website you are visiting – for our advertising and marketing efforts. More specifically, we use cookies and other tracking technologies for the following purposes",
"FooterDescriptionText": "Footer Description",
"CustomJS": "alert('banner clicked');",
"LifespanTypeText": "Session",
"LifespanDurationText": "days",
"CloseText": "Close",
"BannerCloseButton": "Close Banner",
"AlertLayout": "bottom",
"ShowAlertNotice": true,
"IsConsentLoggingEnabled": true,
"ConsentModel": "opt-in",
"IsConsentIntegration": true,
"IsIABEnabled": true,
"ShowAlert": true,
"CenterRounded": true,
"Center": true,
"BannerIABPartnersLink": "List of Partners (vendors)",
"BannerPurposeTitle": "Purposes we use",
"BannerPurposeDescription": "<ul><li>Personalisation</li> <li>Ad selection, delivery, reporting</li><li>Measurement</li><li>Content selection, delivery, reporting</li><li>Information storage and access</li></ul>",
"BannerFeatureTitle": "Features we use",
"BannerFeatureDescription": "<ul><li>Offline data matching: combining data from offline sources that were initially collected in other contexts with data collected online in support of one or more purposes.</li><li>Device linking: processing data to link multiple devices that belong to the same user in support of one or more purposes.</li><li>Precise geographic location data: collecting and supporting precise geographic location data in support of one or more purposes.</li></ul>",
"BannerInformationTitle": "Information that may be used",
"BannerInformationDescription": "<ul><li>Type of browser and its settings Information about the device''s operating system</li><li>Cookie information</li> <li>Information about other identifiers assigned to the device</li><li>The IP address from which the device accesses a client''s website or mobile application</li><li>Information about the user''s activity on that device, including web pages and mobile apps visited or used</li><li>Information about the geographic location of the device when it accesses a website or mobile application</li></ul>",
"BannerRejectAllButtonText": "Reject All",
"PCFirstPartyCookieListText": "First Party Cookies"
},
"CommonData": {
"IabThirdPartyCookieUrl": "cookies-dev.onetrust.mgr.consensu.org",
"OptanonHideAcceptButton": "hide-accept-button",
"OptanonStyle": "modern",
"BannerCustomCSS": "#onetrust-pc-sdk .pc-logo {\\n height: 40px;\\n width: 120px;\\n margin-bottom: 20px;\\n background-color: #FFFFFF !important;\\n background-repeat: no-repeat !important;\\n}",
"PCCustomCSS": "#onetrust-pc-sdk .pc-logo {\\n height: 40px;\\n width: 120px;\\n margin-bottom: 20px;\\n background-color: #FFFFFF !important;\\n background-repeat: no-repeat !important;\\n}",
"PcTextColor": "#F1F1F1",
"PcButtonColor": "#148FC7",
"PcButtonTextColor": "#FeFF23",
"PcBacgroundTextColor": "#000000",
"PcMenuColor": "#AC7422",
"PcMenuHighLightColor": "#F56310",
"TextColor": "#23FF53",
"ButtonColor": "#19c3a2",
"ButtonTextColor": "#20D4B3",
"BackgroundColor": "#b5cedf",
"OptanonLogo": "NEED EXAMPLE",
"OptanonCookieDomain": "OneTrust CCPA App",
"OptanonGroupIdPerformanceCookies": "C0002",
"OptanonGroupIdFunctionalityCookies": "C0003",
"OptanonGroupIdTargetingCookies": "C0004",
"OptanonGroupIdSocialCookies": "C0005",
"ShowSubGroupDescription": true,
"LegacyBannerLayout": "default_flat_bottom_two_button_black",
"OptanonHideCookieSettingsButton": "NEED EXAMPLE",
"ShowBannerAcceptButton": true,
"ShowBannerCookieSettings": true,
"PCShowCookieHost": true,
"PCShowCookieDuration": true,
"PCShowCookieType": true,
"PCShowCookieCategory": true,
"PCShowCookieDescription": true,
"CookieListTitleColor": "#8A898A",
"CookieListGroupNameColor": "#D6D6D6",
"CookieListTableHeaderColor": "#688DC0",
"CookieListPrimaryColor": "#76C350",
"CookieListCustomoCss": "#onetrust-pc-sdk .pc-logo {\\n height: 40px;\\n width: 120px;\\n margin-bottom: 20px;\\n background-color: #FFFFFF !important;\\n background-repeat: no-repeat !important;\\n}"
}
}
}