Get Banner UI
Retrieve the required attributes to render the banner UI
API
(GET) https://mobile-data.onetrust.io/cfw/cmp/v1/banner
API Reference: https://developer.onetrust.com/onetrust/reference/get_banner
Request headers
| Key | Value | Description | Required? |
|---|---|---|---|
| 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 |
Note
Banner details are not returned if the banner is not configured to be shown in your geolocation rule.
Sample response (success):
{
"errors": [],
"appConfig": {
"showBanner": true,
"bannerReason": "Geo rule Banner is enabled and is first launch.",
"bannerReasonCode": 101,
"templateType": "IAB2V2"
},
"bannerUIData": {
"general": {
"backgroundColor": "#fafafa",
"backgroundColorDark": "#fafafa",
"additionalDescriptionPlacement": "AfterDescription",
"useRTL": false,
"layout": "bottom",
"buttonFocusColor": "#696969",
"buttonFocusTextColor": "#FFFFFF",
"buttonBorderShow": false
},
"logo": {
"url": "https://cdn.cookielaw.org/logos/static/ot_company_logo.png",
"logoVoiceOverText": "Banner Logo"
},
"summary": {
"title": {
"textColorDark": "#696969",
"textAlign": "center",
"fontSize": "22",
"text": "We Care About Your Privacy!!",
"textColor": "#696969"
},
"description": {
"textColorDark": "#696969",
"textAlign": "center",
"fontSize": "16",
"text": "We and our <b>847</b> partners store and access personal data, like browsing data or unique identifiers, on your device. Selecting \"I Accept\" enables tracking technologies to support the purposes shown under \"we and our partners process data to provide,\" whereas selecting \"Reject All\" or withdrawing your consent will disable them. If trackers are disabled, some content and ads you see may not be as relevant to you. You can resurface this menu to change your choices or withdraw consent at any time. Your choices will have effect within our Website. For more details, refer to our Privacy Policy.",
"textColor": "#696969"
},
"dpdTitle": {
"textColorDark": "#696969",
"textAlign": "center",
"fontSize": "22",
"text": "We and our partners process data to provide:",
"textColor": "#696969"
},
"dpdDescription": {
"textColorDark": "#696969",
"textAlign": "center",
"fontSize": "16",
"text": "Use precise geolocation data. Actively scan device characteristics for identification. Store and/or access information on a device. Personalised advertising and content, advertising and content measurement, audience research and services development. ",
"textColor": "#696969"
},
"additionalDescription": {
"textColorDark": "#696969",
"textAlign": "center",
"fontSize": "16",
"text": "<img src=\"\nhttps://api.qrserver.com/v1/create-qr-code/?data=https://www.onetrust.com/products/privacy-notice-management/&size=130x130\"\nalt=\"\" title=\"Policy link qr code\" />",
"textColor": "#696969"
}
},
"buttons": {
"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
},
"vendorList": {
"color": "#FFFFFF",
"text": "List of Partners (vendors)",
"textColor": "#346E4A",
"textColorDark": "#f01c05"
}
},
"links": {
"policyLink": {
"textColorDark": "#f01c05",
"urlQRCode": "https://optanon.blob.core.windows.net/logos/077a021e-b242-4450-9b45-8249699e72f5/018f63d4-ca3a-771e-aacc-a37d7adb4183/09e18ce3-4aa1-4bce-afda-8c7327695386/bb193220-96d8-4d0b-a2c5-4132e4cb8502.png",
"textAlign": "center",
"show": true,
"fontSize": "17",
"text": "Cookie Policy",
"textColor": "#f01c05",
"url": "onetrust.com",
"linkVoiceOverText": "Opens in a webview"
}
}
},
"storageKeys": {
"IABTCF_TCString": "CQE4wUAQE4wUAAcABBENA_FgAAAAAEPgAChQKbtV_G__bWlr8X73aftkeY1P9_h77sQxBhfJE-4FzLvW_JwXx2ExNA36tqIKmRIAu3bBIQNlGJDUTVCgaogVryDMaE2coTNKJ6BkiFMRM2dYCF5vm4tj-QKY5vr991dx2B-t7dr83dzyz4VHn3a5_2a0WJCdA5-tDfv9bROb-9IOd_x8v4v8_F_rE2_eT1l_tWvp7D9-cts7_XW89_fff_9Ln_-uB_-_2CmQBJhoVEAZYEhIQaBhBAgBUFYQEUCAAAAEgaICAEwYFOwMAl1hIgBACgAGCAEAAKMgAQAAAQAIRABAAUCAACAQKAAMACAYCAAgYAAQAWAgEAAIDoGKYEECgWACRmREKYEIQCQQEtlQgkAQIK4QhFngEQCImCgAAAAAKwABAWCwOJJASoSCBLiDaAAAgAQCCAAoQScmAAIAzZag8GTaMrTANHzBIhpgGQAA.YAAACHwAAAAA",
"IABTCF_CmpSdkID": 28,
"IABTCF_CmpSdkVersion": 1,
"IABTCF_PolicyVersion": 5,
"IABTCF_gdprApplies": 1,
"IABTCF_PublisherCC": "UK",
"IABTCF_PurposeOneTreatment": 0,
"IABTCF_UseNonStandardTexts": 0,
"IABTCF_VendorConsents": "110101010111111100011011111111111101101101011010010110101111110001011111101111011101101001111110110110010001111001100011010100111111110111111110000111101111101110110001000011000100000110000101111100100100010011111011100000010111001100101110111101011011111100100111000001011111000111011000010011000100110100000011011111101010110110101000100000101010011001000100100000000010111011011101101100000100100001000000110110010100011000100100001101010001001101010100001010000001101010100010000001010110101111001000001100110001101000010011011001110010100001001100110100101000100111101000000110010010001000010100110001000100110011011001110101100000001000010111100110111110011011100010110110001111111001000000101001100011100110111110101111110111110111010101110111000111011000000111111010110111101101110110101111110011011101110111001111001011001111100001010100011110011111011101101011100111111111011001101011010001011000100100001001110100000011100111111010110100001101111110111111110101101101000100111001101111111011110100100000111001110111111111000111110010111111100010111111110011111100010111111110101100010011011011111101111001001111010110010111111110110101011010111110100111101100001111110111111001110010110110110011101111111101011101011011110011110111111101111101111101111111111111110100101110011111111111111010111000000111111111111011111111011",
"IABTCF_VendorLegitimateInterests": "000000010010011000011010000101010001000000000110010110000001001000010010000100000110100000011000010000010000001000000000010101000001010110000100000001000101000000100000000000000000000000000001001000000110100010000000100000000001001100000110000001010011101100000011000000001001011101011000010010001000000000010000000000101000000000000001100000100000000001000000000000000010100011001000000000000100000000000000000000000100000000000010000100010000000000010000000000000101000000100000000000000000100000000100000010100000000000000011000000000000100000000110000000100000000000001000000110000000000000000100000000000101100000001000000001000000000000000010000000111010000001100010100110000001000001000000101000000101100000000000100100011001100100010001000010100110000001000010000100000000100100000100000001001011011001010100001000001001000000000100000010000010101110000100001000010001011001111000000001000100000000100010001001100000101000000000000000000000000000000000000010101100000000000000010000000101100000101100000011100010010010010000000100101010000100100000100000010010111000100000110110100000000000000000001000000000000100000000100000100000000000001010000100000100100111001001100000000000000010000000001100110110010110101000001111000001100100110110100011001010110100110000000011010001111100110000010010001000011010011000000001100100000",
"IABTCF_PurposeConsents": "00000000000",
"IABTCF_PurposeLegitimateInterests": "01000011111",
"IABTCF_SpecialFeaturesOptIns": "00",
"IABTCF_PublisherRestrictions": {},
"IABTCF_PublisherConsent": "00000000000",
"IABTCF_PublisherLegitimateInterests": "01000011111",
"IABTCF_PublisherCustomPurposesConsents": "",
"IABTCF_PublisherCustomPurposesLegitimateInterests": "",
"IABTCF_AddtlConsent": "1~43.46.55.61.70.83.89.93.108.117.122.124.135.143.144.147.149.159.192.196.202.211.228.230.239.259.266.286.291.311.318.320.322.323.327.367.371.385.394.397.407.415.424.430.436.445.453.486.491.494.495.522.523.540.550.559.560.568.574.576.584.587.591.737.802.803.820.821.839.864.899.904.922.931.938.979.981.985.1003.1027.1031.1040.1046.1051.1053.1067.1092.1095.1097.1099.1107.1135.1143.1149.1152.1162.1166.1186.1188.1205.1215.1226.1227.1230.1252.1268.1270.1276.1284.1290.1301.1307.1312.1345.1356.1364.1375.1403.1415.1416.1421.1423.1440.1449.1455.1495.1512.1516.1525.1540.1548.1555.1558.1570.1577.1579.1583.1584.1591.1603.1616.1638.1651.1653.1659.1667.1677.1678.1682.1697.1699.1703.1712.1716.1721.1725.1732.1745.1750.1765.1782.1786.1800.1810.1825.1827.1832.1838.1840.1842.1843.1845.1859.1866.1870.1878.1880.1889.1899.1917.1929.1942.1944.1962.1963.1964.1967.1968.1969.1978.1985.1987.2003.2008.2027.2035.2039.2047.2052.2056.2064.2068.2072.2074.2088.2090.2103.2107.2109.2115.2124.2130.2133.2135.2137.2140.2147.2150.2156.2166.2177.2183.2186.2205.2213.2216.2219.2220.2222.2225.2234.2253.2279.2282.2292.2305.2309.2312.2316.2322.2325.2328.2331.2334.2335.2336.2337.2343.2354.2357.2358.2359.2370.2376.2377.2387.2400.2403.2405.2407.2411.2414.2416.2418.2425.2440.2447.2461.2465.2468.2472.2477.2481.2484.2486.2488.2493.2498.2501.2510.2517.2526.2527.2532.2535.2542.2552.2563.2564.2567.2568.2569.2571.2572.2575.2577.2583.2584.2596.2604.2605.2608.2609.2610.2612.2614.2621.2628.2629.2633.2636.2642.2643.2645.2646.2650.2651.2652.2656.2657.2658.2660.2661.2669.2670.2677.2681.2684.2687.2690.2695.2698.2713.2714.2729.2739.2767.2768.2770.2772.2784.2787.2791.2792.2798.2801.2805.2812.2813.2816.2817.2821.2822.2827.2830.2831.2834.2838.2839.2844.2846.2849.2850.2852.2854.2860.2862.2863.2865.2867.2869.2873.2874.2875.2876.2878.2880.2881.2882.2883.2884.2886.2887.2888.2889.2891.2893.2894.2895.2897.2898.2900.2901.2908.2909.2916.2917.2918.2919.2920.2922.2923.2927.2929.2930.2931.2940.2941.2947.2949.2950.2956.2958.2961.2963.2964.2965.2966.2968.2973.2975.2979.2980.2981.2983.2985.2986.2987.2994.2995.2997.2999.3000.3002.3003.3005.3008.3009.3010.3012.3016.3017.3018.3019.3025.3028.3034.3038.3043.3048.3052.3053.3055.3058.3059.3063.3066.3068.3070.3073.3074.3075.3076.3077.3089.3090.3093.3094.3095.3097.3099.3100.3106.3109.3112.3117.3119.3126.3127.3128.3130.3135.3136.3145.3150.3151.3154.3155.3163.3167.3172.3173.3182.3183.3184.3185.3187.3188.3189.3190.3194.3196.3209.3210.3211.3214.3215.3217.3219.3222.3223.3225.3226.3227.3228.3230.3231.3234.3235.3236.3237.3238.3240.3244.3245.3250.3251.3253.3257.3260.3270.3272.3281.3288.3290.3292.3293.3296.3299.3300.3306.3307.3309.3314.3315.3316.3318.3324.3328.3330.3331.3531.3731.3831.4131.4531.4631.4731.4831.5231.6931.7235.7831.7931.8931.9731.10231.10631.10831.11031.11531.12831.13632.13731.14237.14332.15731.16831.16931.21233.23031.25731.25931.26031.26831.27731.27831.28031.28731.28831.29631.31631.32531.33631",
"OT_GroupConsents": {
"C0003": 0,
"C0001": 1,
"C0004": 0,
"C0002": 0,
"C0005": 0,
"IAB2V2_1": 0,
"ISF2V2_1": 0,
"V2STACK42": 0,
"IAB2V2_2": 0,
"IAB2V2_3": 0,
"IAB2V2_4": 0,
"IAB2V2_5": 0,
"IAB2V2_6": 0,
"IAB2V2_7": 0,
"IAB2V2_8": 0,
"IAB2V2_9": 0,
"IAB2V2_10": 0,
"IAB2V2_11": 0,
"ISF2V2_2": 0,
"ISP2V2_1": 1,
"ISP2V2_2": 1,
"IFE2V2_1": 1,
"IFE2V2_2": 1,
"IFE2V2_3": 1
},
"OT_GroupLIConsents": {
"IAB2V2_2": 1,
"IAB2V2_7": 1,
"IAB2V2_8": 1,
"IAB2V2_9": 1,
"IAB2V2_10": 1,
"IAB2V2_11": 1
},
"OT_SdkConsents": {
"25ad99c8-94e9-4256-bbcb-3f93aa072bf8": 0,
"a4774e14-8e33-4be1-89e7-d9b6cabe16ac": 0,
"cb26050d-2723-41e1-aff3-5ddeabb4f21b": 0,
"a2c0a87b-94b4-4fa6-b669-34590df609cd": 0,
"e8a0be0d-3155-4458-bb62-4472d7fa8ac6": 0,
"b6c5d7fd-232b-40b4-854d-1e57c665a183": 0,
"1d6a31cd-1c3c-494c-a553-f160ffaaacb2": 0,
"0cf9f205-7637-4ebd-affd-0c5cafc3d1ef": 0,
"95c1ad0a-ee08-495f-93dd-78182315defe": 0,
"37c912cb-82ef-4fb7-9eef-87233986fa55": 0,
"40f2fefb-90a1-457d-9239-2eaaf18c5919": 0,
"8e4c8620-c52f-4193-9e71-fb8896a76f30": 0,
"0d07c37b-d616-4da5-9b08-f696d9da816d": 0,
"b8eea331-cc73-4cf8-ab7c-cbc500a67ac5": 0,
"45a8ad74-f8da-49ef-bd4b-0c12e15b3257": 0,
"c5f91231-104a-41d2-b905-bccd7e49b990": 0,
"0e0846d2-3f31-4f47-b5c2-a14def924258": 0,
"9a204cc5-6881-4b1b-b25e-6451f6577413": 0,
"6116f0af-8394-4afc-a98a-be088c4dfe5f": 0,
"ee269e45-b69f-4455-a8fc-96fcfab960f9": 0,
"2a2289fe-5377-431e-b305-e46297bba4ab": 0,
"e873bb60-38a3-4a86-a33c-8485e88f790c": 0,
"c7554680-fe7a-4f69-a600-ebba722bbad8": 0,
"50fe7f55-0ead-4f4a-836c-e2f787b2d154": 0,
"b90b207c-fea4-4129-b4c9-c3aaf434ea30": 0,
"08a0a7c7-4fd5-4163-a77c-6d86767f4821": 0,
"3d6a9e7a-3b34-4e29-be4a-f261234f7beb": 0,
"1f575edc-1c5d-4434-8b83-652b61d1311b": 0,
"52e70ca1-4908-443c-aff3-e8d80293fccb": 0,
"6e7b3b35-524e-4057-88dd-f5cbf036e634": 0,
"cf30b74b-ff58-4660-bd9c-3249997d1bc8": 0,
"494e2758-792a-40cb-8e60-c4b0126bb9e4": 0,
"704806db-3653-44f4-b13b-52164408bc2e": 1,
"60bf4101-0b0c-451e-9c48-1eca1b402821": 1,
"599e5da7-a94e-4137-9335-3965fd823af7": 1,
"0f81f224-f142-46be-bba5-86736df1c238": 1,
"9ea486be-8e55-47ee-b4e7-5de2ea7d4aae": 1,
"1a942e00-44ec-4a97-b746-b8cfff02b899": 1,
"63a2df50-ec80-42ae-944f-c63e8f2c2fbe": 1,
"27ade2b9-f0df-4420-9b85-94692868c3a8": 1,
"39d42a28-f381-448e-82a6-dba5f78dcc02": 1,
"2bf5db0a-ef07-4651-b13c-742f651b43b9": 1,
"57bae5bd-fd45-45fe-acda-60e09a6d9f27": 1,
"a6fd7e05-3e6d-40e0-91bd-ccd8febb7d00": 1,
"2253ec52-18b4-4868-902f-02f9a19e7984": 0,
"f8ea3b4e-aaae-422c-9b52-687e99560aa5": 0,
"62c45332-2d06-4845-8840-33340184b00e": 0,
"fe47eced-3744-418f-b22c-d808213bd222": 0,
"8cc94f7a-0b74-44c1-b615-37c6f863e487": 0,
"74942dd7-7064-4e1e-9f77-89ec8dd0d19c": 0,
"5940a315-0f58-4a8c-8675-ad622fb0e223": 0,
"c1e4f1d2-28eb-412f-9e82-f6de4f7906b4": 0,
"e56c91c1-bfbb-4e78-97aa-573fb4aefd14": 0,
"81b24c1c-26ba-4fff-aa45-97ba8923a753": 0,
"dbc6d5d8-913f-4a06-b02d-e83cd726013f": 0,
"b78f65c9-7afa-4011-a87a-cff5776fb087": 0,
"6bc8a2f8-a74d-4145-93e4-8640dffb6cad": 0,
"458192d3-45b2-4810-b778-d291af37e1a7": 0,
"9aba9fc8-cddf-4726-b21c-fae90a8a64ba": 0,
"efc77024-defb-4012-9c64-863a0b36d305": 0,
"49e08dcb-3d47-424f-b012-7be571dfdff9": 0
}
},
"otConsentString": "eyJsYXN0TGF1bmNoRGF0ZSI6MTcyNjI0MjU3MzQ2Mywic2hvdWxkU2hvd0Jhbm5lciI6MSwiZHNJZCI6Ijk5NzQ1ZGRjLTBkNGItNGI2Ni04ZjdjLWJjOWYwOWRlYTQ5NiIsImFwcElkIjoiMmI5MjhmMzAtYzBiNS00NTVjLTkzODMtZWY0YjRhY2Q0ZWRiLXRlc3QiLCJjZG4iOiJjZG4uY29va2llbGF3Lm9yZyIsImlzQW5vbnltb3VzIjoxLCJleHBpcnlEYXRlIjpudWxsLCJncm91cENvbnNlbnRzIjp7IkMwMDAzIjowLCJDMDAwMSI6MSwiQzAwMDQiOjAsIkMwMDAyIjowLCJDMDAwNSI6MCwiSUFCMlYyXzEiOjAsIklTRjJWMl8xIjowLCJWMlNUQUNLNDIiOjAsIklBQjJWMl8yIjowLCJJQUIyVjJfMyI6MCwiSUFCMlYyXzQiOjAsIklBQjJWMl81IjowLCJJQUIyVjJfNiI6MCwiSUFCMlYyXzciOjAsIklBQjJWMl84IjowLCJJQUIyVjJfOSI6MCwiSUFCMlYyXzEwIjowLCJJQUIyVjJfMTEiOjAsIklTRjJWMl8yIjowLCJJU1AyVjJfMSI6MSwiSVNQMlYyXzIiOjEsIklGRTJWMl8xIjoxLCJJRkUyVjJfMiI6MSwiSUZFMlYyXzMiOjF9LCJzZGtDb25zZW50cyI6eyIyNWFkOTljOC05NGU5LTQyNTYtYmJjYi0zZjkzYWEwNzJiZjgiOjAsImE0Nzc0ZTE0LThlMzMtNGJlMS04OWU3LWQ5YjZjYWJlMTZhYyI6MCwiY2IyNjA1MGQtMjcyMy00MWUxLWFmZjMtNWRkZWFiYjRmMjFiIjowLCJhMmMwYTg3Yi05NGI0LTRmYTYtYjY2OS0zNDU5MGRmNjA5Y2QiOjAsImU4YTBiZTBkLTMxNTUtNDQ1OC1iYjYyLTQ0NzJkN2ZhOGFjNiI6MCwiYjZjNWQ3ZmQtMjMyYi00MGI0LTg1NGQtMWU1N2M2NjVhMTgzIjowLCIxZDZhMzFjZC0xYzNjLTQ5NGMtYTU1My1mMTYwZmZhYWFjYjIiOjAsIjBjZjlmMjA1LTc2MzctNGViZC1hZmZkLTBjNWNhZmMzZDFlZiI6MCwiOTVjMWFkMGEtZWUwOC00OTVmLTkzZGQtNzgxODIzMTVkZWZlIjowLCIzN2M5MTJjYi04MmVmLTRmYjctOWVlZi04NzIzMzk4NmZhNTUiOjAsIjQwZjJmZWZiLTkwYTEtNDU3ZC05MjM5LTJlYWFmMThjNTkxOSI6MCwiOGU0Yzg2MjAtYzUyZi00MTkzLTllNzEtZmI4ODk2YTc2ZjMwIjowLCIwZDA3YzM3Yi1kNjE2LTRkYTUtOWIwOC1mNjk2ZDlkYTgxNmQiOjAsImI4ZWVhMzMxLWNjNzMtNGNmOC1hYjdjLWNiYzUwMGE2N2FjNSI6MCwiNDVhOGFkNzQtZjhkYS00OWVmLWJkNGItMGMxMmUxNWIzMjU3IjowLCJjNWY5MTIzMS0xMDRhLTQxZDItYjkwNS1iY2NkN2U0OWI5OTAiOjAsIjBlMDg0NmQyLTNmMzEtNGY0Ny1iNWMyLWExNGRlZjkyNDI1OCI6MCwiOWEyMDRjYzUtNjg4MS00YjFiLWIyNWUtNjQ1MWY2NTc3NDEzIjowLCI2MTE2ZjBhZi04Mzk0LTRhZmMtYTk4YS1iZTA4OGM0ZGZlNWYiOjAsImVlMjY5ZTQ1LWI2OWYtNDQ1NS1hOGZjLTk2ZmNmYWI5NjBmOSI6MCwiMmEyMjg5ZmUtNTM3Ny00MzFlLWIzMDUtZTQ2Mjk3YmJhNGFiIjowLCJlODczYmI2MC0zOGEzLTRhODYtYTMzYy04NDg1ZTg4Zjc5MGMiOjAsImM3NTU0NjgwLWZlN2EtNGY2OS1hNjAwLWViYmE3MjJiYmFkOCI6MCwiNTBmZTdmNTUtMGVhZC00ZjRhLTgzNmMtZTJmNzg3YjJkMTU0IjowLCJiOTBiMjA3Yy1mZWE0LTQxMjktYjRjOS1jM2FhZjQzNGVhMzAiOjAsIjA4YTBhN2M3LTRmZDUtNDE2My1hNzdjLTZkODY3NjdmNDgyMSI6MCwiM2Q2YTllN2EtM2IzNC00ZTI5LWJlNGEtZjI2MTIzNGY3YmViIjowLCIxZjU3NWVkYy0xYzVkLTQ0MzQtOGI4My02NTJiNjFkMTMxMWIiOjAsIjUyZTcwY2ExLTQ5MDgtNDQzYy1hZmYzLWU4ZDgwMjkzZmNjYiI6MCwiNmU3YjNiMzUtNTI0ZS00MDU3LTg4ZGQtZjVjYmYwMzZlNjM0IjowLCJjZjMwYjc0Yi1mZjU4LTQ2NjAtYmQ5Yy0zMjQ5OTk3ZDFiYzgiOjAsIjQ5NGUyNzU4LTc5MmEtNDBjYi04ZTYwLWM0YjAxMjZiYjllNCI6MCwiNzA0ODA2ZGItMzY1My00NGY0LWIxM2ItNTIxNjQ0MDhiYzJlIjoxLCI2MGJmNDEwMS0wYjBjLTQ1MWUtOWM0OC0xZWNhMWI0MDI4MjEiOjEsIjU5OWU1ZGE3LWE5NGUtNDEzNy05MzM1LTM5NjVmZDgyM2FmNyI6MSwiMGY4MWYyMjQtZjE0Mi00NmJlLWJiYTUtODY3MzZkZjFjMjM4IjoxLCI5ZWE0ODZiZS04ZTU1LTQ3ZWUtYjRlNy01ZGUyZWE3ZDRhYWUiOjEsIjFhOTQyZTAwLTQ0ZWMtNGE5Ny1iNzQ2LWI4Y2ZmZjAyYjg5OSI6MSwiNjNhMmRmNTAtZWM4MC00MmFlLTk0NGYtYzYzZThmMmMyZmJlIjoxLCIyN2FkZTJiOS1mMGRmLTQ0MjAtOWI4NS05NDY5Mjg2OGMzYTgiOjEsIjM5ZDQyYTI4LWYzODEtNDQ4ZS04MmE2LWRiYTVmNzhkY2MwMiI6MSwiMmJmNWRiMGEtZWYwNy00NjUxLWIxM2MtNzQyZjY1MWI0M2I5IjoxLCI1N2JhZTViZC1mZDQ1LTQ1ZmUtYWNkYS02MGUwOWE2ZDlmMjciOjEsImE2ZmQ3ZTA1LTNlNmQtNDBlMC05MWJkLWNjZDhmZWJiN2QwMCI6MSwiMjI1M2VjNTItMThiNC00ODY4LTkwMmYtMDJmOWExOWU3OTg0IjowLCJmOGVhM2I0ZS1hYWFlLTQyMmMtOWI1Mi02ODdlOTk1NjBhYTUiOjAsIjYyYzQ1MzMyLTJkMDYtNDg0NS04ODQwLTMzMzQwMTg0YjAwZSI6MCwiZmU0N2VjZWQtMzc0NC00MThmLWIyMmMtZDgwODIxM2JkMjIyIjowLCI4Y2M5NGY3YS0wYjc0LTQ0YzEtYjYxNS0zN2M2Zjg2M2U0ODciOjAsIjc0OTQyZGQ3LTcwNjQtNGUxZS05Zjc3LTg5ZWM4ZGQwZDE5YyI6MCwiNTk0MGEzMTUtMGY1OC00YThjLTg2NzUtYWQ2MjJmYjBlMjIzIjowLCJjMWU0ZjFkMi0yOGViLTQxMmYtOWU4Mi1mNmRlNGY3OTA2YjQiOjAsImU1NmM5MWMxLWJmYmItNGU3OC05N2FhLTU3M2ZiNGFlZmQxNCI6MCwiODFiMjRjMWMtMjZiYS00ZmZmLWFhNDUtOTdiYTg5MjNhNzUzIjowLCJkYmM2ZDVkOC05MTNmLTRhMDYtYjAyZC1lODNjZDcyNjAxM2YiOjAsImI3OGY2NWM5LTdhZmEtNDAxMS1hODdhLWNmZjU3NzZmYjA4NyI6MCwiNmJjOGEyZjgtYTc0ZC00MTQ1LTkzZTQtODY0MGRmZmI2Y2FkIjowLCI0NTgxOTJkMy00NWIyLTQ4MTAtYjc3OC1kMjkxYWYzN2UxYTciOjAsIjlhYmE5ZmM4LWNkZGYtNDcyNi1iMjFjLWZhZTkwYThhNjRiYSI6MCwiZWZjNzcwMjQtZGVmYi00MDEyLTljNjQtODYzYTBiMzZkMzA1IjowLCI0OWUwOGRjYi0zZDQ3LTQyNGYtYjAxMi03YmU1NzFkZmRmZjkiOjB9LCJncm91cExJQ29uc2VudHMiOnsiSUFCMlYyXzIiOjEsIklBQjJWMl83IjoxLCJJQUIyVjJfOCI6MSwiSUFCMlYyXzkiOjEsIklBQjJWMl8xMCI6MSwiSUFCMlYyXzExIjoxfX0="
}
Sample response (error)
{
"errors": [
{
"code": "ERROR_CODE_MISSING_REQUIRED_HEADER",
"message": "Request header OT-Device-Type should not be null"
}
]
}
Banner reason code
| Status Code | Banner Reason | Should Show Banner Status |
|---|---|---|
| 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 |
Response errors
| Scenario | OT Custom Error Code | HTTP Error Code | Error Message |
|---|---|---|---|
| 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 |
Updated about 1 month ago