Source
Banner & choice architecture — found from sitemap — OneTrust Cookie Consent
Checked for OneTrust Cookie Consent on 29 Oct 2026
- Page
- https://developer.onetrust.com/onetrust/docs/get-banner-ui
- Checked
- 29 Oct 2026, 21:49 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:2ac47a0cde34f604891381b3ed1c6e74354fb90622abdabf39f5aea4966833b8
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Banner UI endpoint Report an error
“API (GET) https://mobile-data.onetrust.io/cfw/cmp/v1/banner API Reference: https://developer.onetrust.com/onetrust/reference/get_banner”
-
Banner geo rule note Report an error
“Banner details are not returned if the banner is not configured to be shown in your geolocation rule.”
-
Banner reason codes Report an error
“101 Show banner enabled in geo rule and is first launch true 102 SDK data has been published with reconsent true 103 Consent has expired true 104 TC String has expired true 105 Reconsent triggered for an authenticated user true 107 100% sync not achieved for cross device sync enabled scenario true 109 The template type is updated to IAB true 150 Show banner not enabled in geo rule false 151 Banner will not be shown as consent validity holds true false 152 Banner will not be shown as 100% cross device sync is achieved false”
-
Banner request headers Report an error
“OT-CDN-Location string CDN location Yes OT-App-Id string App ID Yes OT-SDK-Version string API version to fetch Yes OT-Device-Type string Type of the device e.g. mobile, ctv Yes OT-Consent-String string Base 64 encoded consent string. Should be empty for the very first call and passed in the header on subsequent calls to persist user consent data from one session to the next. Yes, after the first API call OT-Identifier string Data Subject ID Only when using cross device OR if passing in your own identifier OT-Sync-Profile-Auth string JWT auth token (generated using the public keys saved in OneTrust portal) Only when using cross device OT-Fetch-Type string Determines if the data download should include profile data or not. By default if no fetch type is passed, we use APP_DATA_ONLY. If cross device is in scope, pass in APP_DATA_AND_SYNC_PROFILE Only when using cross device OT-Language string Language to display the UI No OT-Country-Code string Country code of end user No OT-Region-Code string Region code of end user No OT-Force-Fetch string Return banner data regardless of shouldShowBanner status. By default, this is false. Set to true to force the return of banner data No OT-Tcf-Eu2v2-Consent-String string IAB TC String <IABTCF_TCString> Only when IAB TCF is in scope OT-Addtl-Consent-String string Google vendors additional consent string <IABTCF_AddtlConsent> Only when Google Additional Consent is in scope in conjunction with IAB TCF OT-Identifier-UpdateType string Header must be passed if 'OT-Identifier' may be different than the identifier stored in the otConsentString. Value will be Rename-Identifier Only if the OT-Identiferdiffers from the identifier in otConsentStrng OT-Exclude-Html-Tags boolean Set to true to remove default HTML tags from the response. Explicitly added HTML tags will not be removed. No. Currently only affects TCF 2.2 templates”
-
Banner response contents Report an error
“"appConfig": { "showBanner": true, "bannerReason": "Geo rule Banner is enabled and is first launch.", "bannerReasonCode": 101, "templateType": "IAB2V2" },”
-
Banner buttons Report an error
“"acceptAll": { "textColorDark": "#FFFFFF", "colorDark": "#346E4A", "borderRadius": "", "color": "#346E4A", "fontSize": "17", "text": "I Accept", "position": 0, "textColor": "#FFFFFF", "interactionType": "BANNER_ALLOW_ALL" }, "rejectAll": { "textColorDark": "#FFFFFF", "colorDark": "#346E4A", "borderRadius": "", "color": "#346E4A", "fontSize": "17", "text": "Reject All", "position": 0, "textColor": "#FFFFFF", "interactionType": "BANNER_REJECT_ALL" }, "showPreferences": { "textColorDark": "#346E4A", "colorDark": "#FFFFFF", "borderRadius": "", "color": "#FFFFFF", "fontSize": "17", "text": "Show Purposes", "position": 0, "textColor": "#346E4A", "showAsLink": false },”
-
Banner error codes Report an error
“All generic server errors ERROR_CODE_GENERIC_ERROR 500 (Internal Server Error) Something went wrong All required headers missing ERROR_CODE_NO_ACCESS 403 (Forbidden) No access to this resource Invalid API route ERROR_CODE_TEXT_RESOURCE_NOT_FOUND 404 (Not Found) Not Found Invalid OT-Consent-String header ERROR_CODE_INVALID_OT_CONSENT_STRING 400 (Bad Request) Invalid OT consent string Invalid OT-Country-Code or OT-Region-Code header ERROR_CODE_INVALID_COUNTRY_OR_REGION 400 (Bad Request) Invalid country code or region code Invalid OT-CDN-Location or OT-App-Id header ERROR_CODE_BLOB_LOCATIONS_UNAVAILABLE 400 (Bad Request) Unable to fetch data for the specified Application ID. Please check your configurations Invalid OT-Fetch-Type header ERROR_CODE_INVALID_FETCH_TYPE 400 (Bad Request) Invalid Fetch type Invalid OT-Device-Type header ERROR_CODE_INVALID_DEVICE_TYPE 400 (Bad Request) Invalid Device Type Missing required headers e.g. OT-Device-Type, OT-CDN-Location etc ERROR_CODE_MISSING_REQUIRED_HEADER 400 (Bad Request) Request header {{header}} should not be null”
Scores citing this record
- The Agency Developer Banner & choice architecture
- The Agency Developer Consent records & proof
- The Agency Developer Frameworks, signals & platforms
- The Data Protection Officer Banner & choice architecture
- The Data Protection Officer Consent records & proof
- The Data Protection Officer European sovereignty
- The In-House Lawyer Banner & choice architecture
- The In-House Lawyer Consent records & proof
- The In-House Lawyer Frameworks, signals & platforms
- The Publisher Marketing Lead Banner & choice architecture
- The Publisher Marketing Lead Consent records & proof
- The Publisher Marketing Lead Frameworks, signals & platforms
- The Skeptic Banner & choice architecture
- The Skeptic Consent records & proof
- The Skeptic Frameworks, signals & platforms
- The WordPress Webmaster Banner & choice architecture
- The WordPress Webmaster Consent records & proof
- The WordPress Webmaster Frameworks, signals & platforms