--- title: "Get Banner Data" method: GET path: "/cfw/cmp/v1/banner" tags: ["Banner"] --- # Get Banner Data `GET /cfw/cmp/v1/banner` ## Request - Base URL: `https://mobile-data.onetrust.io` - URL: `https://mobile-data.onetrust.io/cfw/cmp/v1/banner` - Auth: none declared. Required headers: `OT-CDN-Location`, `OT-App-Id`, `OT-Device-Type`, `OT-SDK-Version` Use this API to retrieve the required interface attributes to be rendered on the Banner. ## Headers - `OT-CDN-Location` 'cdn.cookielaw.org' | 'cdn-apac.onetrust.com' | 'cdn.au.onetrust.com' | 'cdn-ukwest.onetrust.com' | 'cookie-cdn.cookiepro.com' | 'otcc-demo.otprivacy.com' | 'otcc-training.onetrust.com', required: The location of the CDN. - `OT-App-Id` string, required: The unique identifier for the app or domain. - `OT-Device-Type` 'mobile' | 'ctv', required: The type of device. - `OT-SDK-Version` string, required: The published version of the app or domain. - `OT-SDK-Identification` string, nullable: The OneTrust SDK identification. - `OT-Language` string, nullable: The language in which the UI should be displayed. - `OT-Country-Code` string, nullable: The country code from which the user is accessing the app or website. The value passed in this parameter will be used to resolve the geolocation rule. - `OT-Region-Code` string, nullable: The region code from which the user is accessing the app or website. The value passed in this parameter will be used to resolve the geolocation rule. - `OT-Fetch-Type` 'APP_DATA_ONLY' | 'APP_DATA_AND_PROFILE' | 'APP_DATA_AND_SYNC_PROFILE', nullable: The type of data to download. The value passed in this parameter will determine whether to download app data only or app data and the data subject profile. - `OT-Consent-String` string, nullable: The encoded consent string that contains the UI's metadata. - `OT-Identifier` string, nullable: The unique identifier of the data subject. - `OT-Identifier-Type` string, nullable: The identifier type associated with the unique identifier in the OT-Identifier header. - `OT-Identifier-UpdateType` 'Rename-Identifier', nullable: The update type for the identifier. This header is used to specify how the identifier should be updated. - `OT-Sync-Profile-Auth` string, nullable: The JSON Web Token (JWT) generated using Public Keys within the OneTrust application. This is used to sync consent for a known user. - `OT-Platform` 'Apple' | 'Android', nullable: The platform-specific features, such as ATT for Apple or GoogleAdId for Android. - `OT-Exclude-Html-Tags` boolean, nullable: The flag that indicates whether to unbold the vendor numbers. - `OT-Is-Anonymous-User` boolean, nullable: This flag indicates whether the request is anonymous. When `true`, profile creation is skipped. - `OT-Force-Fetch` boolean, nullable: The flag that indicates whether the Banner configuration data is returned, irrespective of the showBanner status. - `OT-Tcf-Eu2v2-Consent-String` string, nullable: The IAB TCF string that contains information on consent preferences. - `OT-Addtl-Consent-String` string, nullable: The Additional Consent string for Google Vendors. ## Response `200` Success - object - `errors` object[] - `code` 'SUCCESS' | 'ERROR_CODE_TEXT_RESOURCE_NOT_FOUND' | 'ERROR_CODE_NO_CONTENT' | 'ERROR_CODE_BLOB_LOCATIONS_UNAVAILABLE' | 'ERROR_CODE_INVALID_LOCATION' | 'ERROR_CODE_INVALID_COUNTRY_OR_REGION' | 'ERROR_CODE_INVALID_DEVICE_TYPE' | 'ERROR_CODE_INVALID_FETCH_TYPE' | 'ERROR_CODE_INVALID_CONSENT_REQUEST' | 'ERROR_CODE_HTTP_IF_NONE_MATCHED' | 'ERROR_CODE_SYNC_GROUP' | 'ERROR_CODE_FAILURE' | 'ERROR_CODE_DEFAULT_PURPOSE_STATUS' | 'ERROR_CODE_INVALID_OT_CONSENT_STRING' | 'ERROR_CODE_GENERIC_ERROR' | 'ERROR_CODE_MISSING_REQUIRED_HEADER' | 'ERROR_CODE_NO_ACCESS' | 'ERROR_CODE_INVALID_INTERACTION_TYPE' | 'ERROR_CODE_INVALID_CONTENT_TYPE_HEADER' | 'ERROR_IDENTIFIER_MISMATCH' | 'ERROR_UCP_NOT_CONFIGURED' | 'ERROR_CODE_INVALID_TC_STRING' | 'ERROR_GOOGLE_ADS_DISABLED' | 'ERROR_CODE_CONSENT_LOGGING' | 'ERROR_CODE_INVALID_REQUEST_BODY' | 'ERROR_CODE_UNSUPPORTED_VERSION' | 'ERROR_CODE_INVALID_AGE_RANGE' | 'ERROR_CODE_AGE_RANGE_REQUIRED' | 'ERROR_CODE_EMPTY_CONSENT' | 'ERROR_CODE_GLOBAL_OPT_OUT_NOT_CONFIGURED' | 'ERROR_CODE_GLOBAL_OPT_OUT_DISABLED' | 'ERROR_CODE_DSAR', required - `message` 'Not Found' | 'No content' | 'success' | 'Unable to fetch data for the specified Application ID. Please check your configurations.' | 'Invalid location' | 'Invalid country code or region code. If you want to skip validation, please set the header 'OT-Geolocation-Skip-Validation' to true.' | 'Invalid Device Type' | 'Invalid Fetch type' | 'Missing either or all of TenantId or Identifier or Authorization' | 'If-None-Match' | 'syncGroup' | 'failure' | 'NO_CONSENT' | 'Invalid OT consent string' | 'Something went wrong' | 'No access to this resource' | 'Invalid Interaction Type' | 'Content-Type header should be application/json' | 'Input Identifier does not match with one in consent string' | 'The UC Purposes API call was successful, but no data is available for display.' | 'UC Purposes is disabled.' | 'Error decoding TC string, default consent is returned.' | 'Google Ads is disabled.' | 'Consent Logging has failed, please retry in sometime and if issue still persists please reach out to support team.' | 'Error parsing request body' | 'The published version is not supported. Please publish a newer version.' | 'The upper bound of the age range must be greater than lower bound.' | 'At least one age bound (lower or upper) must be provided.' | 'At least one purpose consent is required.' | 'Global Opt-Out is not configured.' | 'Global Opt-Out is disabled.', required - `warnings` object[] - `code` 'WARNING_CODE_PUBLISHED_VERSION_MISMATCH', required - `message` 'Requested data for the OT-SDK-Version does not match the published version on the OneTrust server. The latest published version will be returned instead.', required - `appConfig` object, required: The object that contains the application configurations. - `showBanner` boolean, required: The flag that indicates whether to show the banner. - `bannerReason` 'Geo rule Banner is not enabled.' | 'Geo rule Banner is enabled and is first launch.' | 'Sdk's Automatic reconsent has expired.' | 'Reconsent triggered for an authenticated user.' | 'The TC String has expired.' | 'Hundred percent sync is not completed for cross device sync enabled scenario.' | 'The template type is updated to IAB.' | 'Sdk has been published with reconsent.' | 'Banner will not be shown as consent validity holds true.' | 'Banner will not be shown as cross device sync is hundred percent complete.', required: The reason the banner is being displayed. - `templateType` 'GDPR' | 'CCPA' | 'IAB2' | 'IAB2V2' | 'GENERIC' | 'LGPD' | 'GENERIC_PROMPT' | 'CPRA' | 'CDPA' | 'USNATIONAL' | 'CUSTOM' | 'COLORADO' | 'CTDPA' | 'UCPA' | 'OREGON' | 'FLORIDA' | 'DELAWARE' | 'IOWA' | 'MONTANA' | 'NEBRASKA' | 'TENNESSEE' | 'TEXAS' | 'NEW_JERSEY' | 'NEW_HAMPSHIRE' | 'MARYLAND' | 'INDIANA' | 'KENTUCKY' | 'RHODE_ISLAND' | 'MINNESOTA', required: The type of template used for the banner. - `bannerReasonCode` 101 | 102 | 103 | 104 | 105 | 107 | 109 | 150 | 151 | 152, required: The code associated with the reason the banner is displayed. - `multiProfileConsent` object - `downloadDataAfterSwitch` boolean, required - `maxProfilesLimit` number, required - `gcmInfo` object - `userConsented` boolean, required - `gcmConsents` object, required - `adPersonalization` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `adStorage` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `adUserData` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `analyticsStorage` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `functionalityStorage` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `personalizationStorage` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `securityStorage` 'UNASSIGNED' | 'UNDEFINED' | 'DENIED' | 'GRANTED', required - `countryCode` string - `regionCode` string - `shouldResetLocalState` boolean: The flag that indicates whether to discard local changes on the client side and collect fresh consent. - `lastReconsentDate` number - `rejectAllButtonBehavior` string - `globalOptOutData` object - `linkedCategories` object[] - `id` string, required - `groupName` string, required - `confirmationMessage` string, required - `instructionalMessage` string, required - `communicationMedium` string, required - `submitButtonText` string, required - `closeButtonText` string, required - `cancelButtonText` string, required - `inputValidationError` string, required - `submissionError` string, required - `knownUserError` string, required - `mobileSectionHeader` string, required - `emailFieldPlaceholderText` string, required - `closeButtonAriaLabel` string, required - `bannerUIData` object: The UI data for the banner. - `general` object, required: The general UI settings for the banner. - `backgroundColor` string, required: The background color of the banner in light mode. - `backgroundColorDark` string: The background color of the banner in dark mode. - `additionalDescriptionPlacement` string: The placement of the additional description. - `layoutHeight` string: The layout height, which is applicable to mobile devices only. - `buttonFocusColor` string: The button focus color, which is applicable to CTV devices only. - `buttonFocusTextColor` string: The button focus text color, which is applicable to CTV devices only. - `layout` string: The layout of the banner, which is applicable to CTV devices only. - `buttonBorderShow` boolean: The flag that indicates whether to show the button border, which is applicable to CTV devices only. - `useRTL` boolean, required: The flag that indicates whether to use Right-To-Left text direction. - `qrCodeAriaLabel` string: The ARIA label for the QR code, enhancing accessibility. - `headingAriaLabel` string: The ARIA label for the main heading, improving screen reader support. - `selectedAriaLabel` string: The ARIA label for selected items, indicating the current selection state for accessibility. - `bannerLinkScreenReaderAriaLabel` string: The ARIA label for the banner link, providing context for screen readers. - `openNewViewAriaLabel` string: The ARIA label for elements that open a new view, enhancing accessibility. - `bannerLandingDescription` string: The descriptive text presented to the user on the banner's landing view. - `linkRoleLabel` string: The accessibility label for elements with a link role. - `cookieSettingButtonText` string - `logo` object: The UI settings for the banner logo. - `url` string, required: The URL of the logo image. - `logoVoiceOverText` string, required: The voice-over text for the logo, which is applicable to CTV devices only. - `summary` object: The UI settings for the banner summary. - `title` object: The UI settings for the banner summary title. - `fontSize` string: The font size of the title. - `text` string, required: The text of the title. - `textAlign` string: The text alignment of the title. - `textColor` string: The text color of the title in light mode. - `textColorDark` string: The text color of the title in dark mode. - `description` object: The UI settings for the banner summary description. - `fontSize` string: The font size of the description. - `text` string, required: The text of the description. - `textAlign` string: The text alignment of the description. - `textColor` string: The text color of the description in light mode. - `textColorDark` string: The text color of the description in dark mode. - `dpdTitle` object: The UI settings for the data processing description title. - `fontSize` string: The font size of the data processing description title. - `text` string, required: The text of the data processing description title. - `textAlign` string: The text alignment of the data processing description title. - `textColor` string: The text color of the data processing description title in light mode. - `textColorDark` string: The text color of the data processing description title in dark mode. - `dpdDescription` object: The UI settings for the data processing description text. - `fontSize` string: The font size of the data processing description text. - `text` string, required: The text of the data processing description. - `textAlign` string: The text alignment of the data processing description. - `textColor` string: The text color of the data processing description in light mode. - `textColorDark` string: The text color of the data processing description in dark mode. - `additionalDescription` object: The UI settings for the additional description. - `fontSize` string: The font size of the additional description. - `text` string, required: The text of the additional description. - `textAlign` string: The text alignment of the additional description. - `textColor` string: The text color of the additional description in light mode. - `textColorDark` string: The text color of the additional description in dark mode. - `buttons` object: The UI settings for the buttons. - `closeButton` object: The UI settings for the close button. - `color` string: The color of the close button in light mode. - `colorDark` string: The color of the close button in dark mode. - `showAsLink` boolean: Whether to show the close button as a link. - `borderRadius` string: The border radius of the close button. - `fontSize` string: The font size of the close button. - `showText` boolean: Whether to show the text of the close button. - `text` string: The text of the close button. - `textColor` string: The text color of the close button in light mode. - `textColorDark` string: The text color of the close button in dark mode. - `imgcolor` string: The image color of the close button in light mode. - `imgcolorDark` string: The image color of the close button in dark mode. - `closeBtnVoiceOverText` string: The voice over text for the close button. - `interactionType` string: The interaction type of the close button. - `acceptAll` object: The UI settings for the accept all button. - `borderRadius` string: The border radius of the button. - `color` string: The background color of the button in light mode. - `colorDark` string: The background color of the button in dark mode. - `fontSize` string: The font size of the button text. - `text` string: The text displayed on the button. - `textColor` string: The color of the button text in light mode. - `textColorDark` string: The color of the button text in dark mode. - `interactionType` string: The interaction type associated with the button click. - `position` number: The position of the button. - `rejectAll` object: The UI settings for the reject all button. - `borderRadius` string: The border radius of the button. - `color` string: The background color of the button in light mode. - `colorDark` string: The background color of the button in dark mode. - `fontSize` string: The font size of the button text. - `text` string: The text displayed on the button. - `textColor` string: The color of the button text in light mode. - `textColorDark` string: The color of the button text in dark mode. - `interactionType` string: The interaction type associated with the button click. - `position` number: The position of the button. - `showPreferences` object: The UI settings for the show preferences button. - `borderRadius` string: The border radius of the button. - `color` string: The background color of the button in light mode. - `colorDark` string: The background color of the button in dark mode. - `fontSize` string: The font size of the button text. - `showAsLink` boolean: Determines if the button should be displayed as a link. - `text` string: The text displayed on the button. - `textColor` string: The color of the button text in light mode. - `textColorDark` string - `position` number: The position of the button. - `vendorList` object: The configuration for the vendor list link, applicable to CTV devices only. - `text` string, required: The text displayed for the vendor list link. - `color` string: The background color of the link in light mode. - `textColor` string, required: The color of the link text in light mode. - `textColorDark` string, required: The color of the link text in dark mode. - `position` number: The position of the link. - `links` object, required: The UI settings for the links on the banner. - `policyLink` object: The UI settings for the policy link. - `text` string, required: The text of the policy link. - `textAlign` string, required: The text alignment of the policy link. - `fontSize` string, required: The font size of the policy link. - `textColor` string, required: The text color of the policy link in light mode. - `textColorDark` string, required: The text color of the policy link in dark mode. - `url` string, required: The URL of the policy link. - `urlQRCode` string: The QR code for the policy link URL. - `linkVoiceOverText` string, required: The voice over text for the policy link. - `prompts` object: The UI settings for the prompts. - `ageGate` object: The UI settings for the age gate prompt. - `logoUrl` string: The URL of the logo to be displayed on the age gate prompt. - `titleText` string: The title text of the age gate prompt. - `descriptionText` string: The description text of the age gate prompt. - `primaryButtonText` string: The text of the primary button on the age gate prompt. - `secondaryButtonText` string: The text of the secondary button on the age gate prompt. - `toggleDisableHints` string - `linkedCategories` object, required - `list` object[], required - `groupId` string, required - `ageGroups` object[], required - `name` string, required - `lowerBound` number - `upperBound` number, required - `idfa` object: The UI settings for the IDFA prompt. - `prePrompt` object: The UI settings for the IDFA pre-prompt. - `logoUrl` string: The URL of the logo to be displayed on the IDFA pre-prompt. - `titleText` string: The title text of the IDFA pre-prompt. - `descriptionText` string: The description text of the IDFA pre-prompt. - `primaryButtonText` string: The text of the primary button on the IDFA pre-prompt. - `secondaryButtonText` string: The text of the secondary button on the IDFA pre-prompt. - `postPrompt` object: The UI settings for the IDFA post-prompt. - `logoUrl` string: The URL of the logo to be displayed on the IDFA post-prompt. - `titleText` string: The title text of the IDFA post-prompt. - `descriptionText` string: The description text of the IDFA post-prompt. - `primaryButtonText` string: The text of the primary button on the IDFA post-prompt. - `secondaryButtonText` string: The text of the secondary button on the IDFA post-prompt. - `linkedCategories` object, required: The categories to be displayed on the IDFA prompt. - `list` object[], required: A list of category IDs to be displayed on the IDFA prompt. - `groupId` string, required: The ID of the category to be displayed on the IDFA prompt. - `ntfyConfigData` object: The UI settings for the notification. - `duration` number, required: The duration for which the notification is displayed. - `sync` object, required: The sync settings for the notification. - `general` object, required: The general UI settings for the notification. - `backgroundColor` string: The background color of the notification in light mode. - `backgroundColorDark` string: The background color of the notification in dark mode. - `borderColor` string: The border color of the notification in light mode. - `borderColorDark` string: The border color of the notification in dark mode. - `iconBackgroundColor` string: The icon background color of the notification in light mode. - `iconBackgroundColorDark` string: The icon background color of the notification in dark mode. - `showIcon` boolean: Determines whether to show the icon on the notification. - `showClose` boolean: Determines whether to show the close button on the notification. - `closeAria` string: The ARIA label for the close button on the notification. - `title` object: The UI settings for the notification title. - `fontSize` string: The font size of the notification title. - `show` boolean, required: Determines whether to show the title on the notification. - `text` string: The text content of the notification title. - `textAlign` string: The text alignment of the notification title. - `textColor` string: The text color of the notification title in light mode. - `textColorDark` string: The text color of the notification title in dark mode. - `description` object: The UI settings for the notification description. - `fontSize` string: The font size of the notification description. - `show` boolean, required: Determines whether to show the description on the notification. - `text` string: The text content of the notification description. - `textAlign` string: The text alignment of the notification description. - `textColor` string: The text color of the notification description in light mode. - `textColorDark` string: The text color of the notification description in dark mode. - `complete` object, required: The UI settings for the success/complete notification. - `general` object, required: The general UI settings for the success/complete notification. - `backgroundColor` string: The background color of the notification in light mode. - `backgroundColorDark` string: The background color of the notification in dark mode. - `borderColor` string: The border color of the notification in light mode. - `borderColorDark` string: The border color of the notification in dark mode. - `iconBackgroundColor` string: The background color of the notification icon in light mode. - `iconBackgroundColorDark` string: The background color of the notification icon in dark mode. - `showIcon` boolean: Determines whether to show the icon on the notification. - `showClose` boolean: Determines whether to show the close button on the notification. - `closeAria` string: The ARIA label for the close button. - `title` object: The UI settings for the notification title. - `fontSize` string: The font size of the notification title. - `text` string: The text content of the notification title. - `textAlign` string: The text alignment of the notification title. - `textColor` string: The text color of the notification title in light mode. - `textColorDark` string: The text color of the notification title in dark mode. - `description` object: The UI settings for the notification description. - `fontSize` string: The font size of the notification description. - `text` string: The text content of the notification description. - `textAlign` string: The text alignment of the notification description. - `textColor` string: The text color of the notification description in light mode. - `textColorDark` string: The text color of the notification description in dark mode. - `button` object: The UI settings for the notification button. - `borderRadius` string: The border radius of the notification button. - `color` string - `colorDark` string - `fontSize` string - `show` boolean, required - `showAsLink` boolean - `text` string - `textColor` string - `textColorDark` string - `borderColor` string: The border color of the notification in light mode. - `borderColorDark` string: The border color of the notification in dark mode. - `googleAd` object - `general` object, required - `enableConsent` boolean, required - `storageKeys` object: The consent data for various storage keys. - `IABUSPrivacy_String` string - `IABTCF_AddtlConsent` string - `IABTCF_TCString` string: Full encoded TC string - `IABTCF_CmpSdkID` number: The unsigned integer ID of CMP SDK - `IABTCF_CmpSdkVersion` number: The unsigned integer version number of CMP SDK - `IABTCF_PolicyVersion` number: The unsigned integer representing the version of the TCF that these consents adhere to - `IABTCF_gdprApplies` number: 2 - GDPR applies in current context, 0 - GDPR does not apply in current context - `IABTCF_PublisherCC` string: Two-letter ISO 3166-1 alpha-2 code - Default: AA (unknown) - `IABTCF_PurposeOneTreatment` number: 1 - no special treatment of purpose one, 1 - purpose one not disclosed. Vendors can use this value to determine whether consent for purpose one is required. - `IABTCF_UseNonStandardTexts` number: 2 - CMP uses customized stack descriptions and/or modified or supplemented standard Illustrations, 0 - CMP did not use a non-standard stack desc. and/or modified or supplemented Illustrations - `IABTCF_UseNonStandardStacks` number - `IABTCF_VendorConsents` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the consent status for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is consent true for vendor ID 2 - `IABTCF_VendorLegitimateInterests` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the legitimate interest status for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is legitimate interest established true for vendor ID 2 - `IABTCF_PurposeConsents` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the consent status for purpose ID n+1; false and true respectively. eg. '1' at index 0 is consent true for purpose ID 2 - `IABTCF_PurposeLegitimateInterests` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the legitimate interest status for purpose ID n+1; false and true respectively. eg. '1' at index 0 is legitimate interest established true for purpose ID 2 - `IABTCF_SpecialFeaturesOptIns` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the opt-in status for special feature ID n+1; false and true respectively. eg. '1' at index 0 is opt-in true for special feature ID 2 - `IABTCF_PublisherRestrictions` object: The value at position n - where n's indexing begins at 0 - indicates the publisher restriction type (0-2) for vendor n+1; (see Publisher Restrictions Types). eg. '2' at index 0 is restrictionType 2 for vendor ID 1. {ID} refers to the purpose ID. - `IABTCF_PublisherConsent` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose consent status for purpose ID n+1 for the publisher as they correspond to the Global Vendor List Purposes; false and true respectively. eg. '1' at index 0 is consent true for purpose ID 2 - `IABTCF_PublisherLegitimateInterests` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose legitimate interest status for purpose ID n+1 for the publisher as they correspond to the Global Vendor List Purposes; false and true respectively. eg. '1' at index 0 is legitimate interest established true for purpose ID 2 - `IABTCF_PublisherCustomPurposesConsents` string, nullable: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose consent status for the publisher's custom purpose ID n+1 for the publisher; false and true respectively. eg. '1' at index 0 is consent true for custom purpose ID 2 - `IABTCF_PublisherCustomPurposesLegitimateInterests` string, nullable: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose legitimate interest status for the publisher's custom purpose ID n+1 for the publisher; false and true respectively. eg. '1' at index 0 is legitimate interest established true for custom purpose ID 2 - `IABTCF_EnableAdvertiserConsentMode` number - `IABTCF_DisclosedVendors` string - `IABGPP_2_String` string - `IABGPP_TCFEU2_CmpSdkID` number: The unsigned integer ID of CMP SDK - `IABGPP_TCFEU2_CmpSdkVersion` number: The unsigned integer version number of CMP SDK - `IABGPP_TCFEU2_PolicyVersion` number: The unsigned integer representing the version of the TCF that these consents adhere to - `IABGPP_TCFEU2_gdprApplies` number: 2 - GDPR applies in current context, 0 - GDPR does not apply in current context - `IABGPP_TCFEU2_PublisherCC` string: Two-letter ISO 3166-1 alpha-2 code - Default: AA (unknown) - `IABGPP_TCFEU2_PurposeOneTreatment` number: 1 - no special treatment of purpose one, 1 - purpose one not disclosed. Vendors can use this value to determine whether consent for purpose one is required. - `IABGPP_TCFEU2_UseNonStandardTexts` number: 2 - CMP uses customized stack descriptions and/or modified or supplemented standard Illustrations, 0 - CMP did not use a non-standard stack desc. and/or modified or supplemented Illustrations - `IABGPP_TCFEU2_UseNonStandardStacks` number - `IABGPP_TCFEU2_VendorConsents` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the consent status for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is consent true for vendor ID 2 - `IABGPP_TCFEU2_VendorLegitimateInterests` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the legitimate interest status for Vendor ID n+1; false and true respectively. eg. '1' at index 0 is legitimate interest established true for vendor ID 2 - `IABGPP_TCFEU2_PurposeConsents` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the consent status for purpose ID n+1; false and true respectively. eg. '1' at index 0 is consent true for purpose ID 2 - `IABGPP_TCFEU2_PurposeLegitimateInterests` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the legitimate interest status for purpose ID n+1; false and true respectively. eg. '1' at index 0 is legitimate interest established true for purpose ID 2 - `IABGPP_TCFEU2_SpecialFeaturesOptIns` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the opt-in status for special feature ID n+1; false and true respectively. eg. '1' at index 0 is opt-in true for special feature ID 2 - `IABGPP_TCFEU2_PublisherRestrictions` object: The value at position n - where n's indexing begins at 0 - indicates the publisher restriction type (0-2) for vendor n+1; (see Publisher Restrictions Types). eg. '2' at index 0 is restrictionType 2 for vendor ID 1. {ID} refers to the purpose ID. - `IABGPP_TCFEU2_PublisherConsent` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose consent status for purpose ID n+1 for the publisher as they correspond to the Global Vendor List Purposes; false and true respectively. eg. '1' at index 0 is consent true for purpose ID 2 - `IABGPP_TCFEU2_PublisherLegitimateInterests` string: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose legitimate interest status for purpose ID n+1 for the publisher as they correspond to the Global Vendor List Purposes; false and true respectively. eg. '1' at index 0 is legitimate interest established true for purpose ID 2 - `IABGPP_TCFEU2_PublisherCustomPurposesConsents` string, nullable: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose consent status for the publisher's custom purpose ID n+1 for the publisher; false and true respectively. eg. '1' at index 0 is consent true for custom purpose ID 2 - `IABGPP_TCFEU2_PublisherCustomPurposesLegitimateInterests` string, nullable: Binary String: The '0' or '1' at position n - where n's indexing begins at 0 - indicates the purpose legitimate interest status for the publisher's custom purpose ID n+1 for the publisher; false and true respectively. eg. '1' at index 0 is legitimate interest established true for custom purpose ID 2 - `IABGPP_TCFEU2_DisclosedVendors` string - `OT_GroupConsents` object - `OT_GroupLIConsents` object - `OT_SdkConsents` object - `OT_UCPConsents` object - `OT_GeneralVendorsConsents` object: The consent status for general vendors. - `OT_LastConsentedDate` string: The date and time when the consent was last updated. - `OT_Identifier` string: The unique identifier for the data subject. - `OT_AlwaysActiveIds` object - `groups` string[] - `sdks` string[] - `OT_AgeGate` object - `lastUpdated` number, required - `lowerBound` number - `upperBound` number - `groupsHierarchy` object, required - `otConsentString` string ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `429`: Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500`: Internal Server Error --- [API](https://skmtc.dev/onetrust/apis/consent-preferences-consent-management-platform-cmp.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-consent-management-platform-cmp/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-consent-management-platform-cmp/revisions/563a5ce3f382?raw)