v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Vendors

Get IAB and Google Vendors

Use this API to retrieve a list of active IAB and Google Vendors to be displayed on the Preference Center.

get/cfw/cmp/v1/vendors

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.

The location of the CDN.

OT-App-Idstring required

The unique identifier for the app or domain.

Example:95c1b37a-c271-44e8-9dd3-1742d82ec948-test

The unique identifier for the app or domain.

OT-Device-Type'mobile' | 'ctv' required

The type of device.

The type of device.

OT-SDK-Versionstring required

The published version of the app or domain.

Example:202403.2.0

The published version of the app or domain.

OT-SDK-Identificationstring nullable

The OT SDK identification.

Example:iOS/17.0/202411.1.0

The OT SDK identification.

OT-Languagestring nullable

The language in which the user interface should be displayed.

Example:en

The language in which the user interface should be displayed.

OT-Country-Codestring nullable

The country code from which the user is accessing the app or website.

Example:US

The country code from which the user is accessing the app or website.

OT-Region-Codestring nullable

The region code from which the user is accessing the app or website.

Example:GA

The region code from which the user is accessing the app or website.

OT-Fetch-Type'APP_DATA_ONLY' | 'APP_DATA_AND_PROFILE' | 'APP_DATA_AND_SYNC_PROFILE' nullable

The type of data to download.

The type of data to download.

OT-Consent-Stringstring nullable

The encoded consent string that contains the interface's metadata.

Example:eyJsYXN0TGF1bmNoRGF0ZSI6MTcxMjMzMDgyOTEwMywic2hvdWxkU2hvd0Jhbm5lciI6MSwiZHNJZCI6IjljZDFjZGM1LTMwNmUtNGQ0Yi05MWFiLTg2MzdjODQ3ZjA3NyIsImFwcElkIjoiOTVjMWIzN2EtYzI3MS00NGU4LTlkZDMtMTc0MmQ4MmVjOTQ4LXRlc3QiLCJjZG4iOiJjZG4uY29va2llbGF3Lm9yZyIsImlzQW5vbnltb3VzIjoxLCJleHBpcnlEYXRlIjpudWxsfQ==

The encoded consent string that contains the interface's metadata.

OT-Identifierstring nullable

The unique identifier for the data subject.

Example:9cd1cdc5-306e-4d4b-91ab-8637c847f077

The unique identifier for the data subject.

OT-Identifier-Typestring nullable

The identifier type associated with the unique identifier in OT-Identifier header

Example:Email

The identifier type associated with the unique identifier in 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-Authstring nullable

The JSON Web Token (JWT) generated using Public Keys within the OneTrust application.

Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJncGJ1cmRlbGxAb25ldHJ1c3QuY29tIiwibmFtZSI6Ikdlb3JnZSBQLiBCdXJkZWxsIiwiaWF0IjoxNTE2MjM5MDIyfQ.qisq7xmfAqXkkSckWpeJKs86JlXuKmClEgMaooSaih0

The JSON Web Token (JWT) generated using Public Keys within the OneTrust application.

OT-Platform'Apple' | 'Android' nullable

To handle platform-specific features like ATT (App Tracking Transparency for Apple) or GoogleAdId (for Android) in a structured way, you can send the platform type in the parameters of an API or request.

To handle platform-specific features like ATT (App Tracking Transparency for Apple) or GoogleAdId (for Android) in a structured way, you can send the platform type in the parameters of an API or request.

OT-Exclude-Html-Tagsboolean nullable

This is specifically to unbold the vendor numbers only.

This is specifically to unbold the vendor numbers only.

OT-Tcf-Eu2v2-Consent-Stringstring nullable

The IAB TCF string that contains information on consent preferences.

Example:CP68pYAP68pYAAcABBENAKEsAP_gAEPgAChQg1NX_H__bW9j8Xr1aft0eY1P99j7ruQxBhfJE-4FyLvW_JwXx2ExNA36pqIKmRIEu3bBIQFlHIHUTUigaogVryHMakWMhTNKJ6BkiFMRM2dYCF5vmYlD-QKY5_p9d3dx2D-t_dv83dzyz81Hn3f5_2e0eLCdQ58tDfv9bROb-9INd_78v4AAAAAAAAAAAAAAAAAAAAAAAAAAABU-9_fff78AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEQaoWoACIAFAAXAA4AD4AKAAqABcADgAHgAQAAkABdADAAMoAaABqADwAH4ARAAjgBMAChAFIAUwAqwBbAF0AMQAZgA0ABvAD0AHwAPwAhABDQCIAIkARwAlgBNACjAFKAMAAYcAygDLAGaANEAbIA5ABzwDuAO8AewA-IB9gH7AP8BAICDgIQAREAikBFgEYAI1ARwBHQCRAElAJSATQAn4BQYCoAKiAVcAsQBcwC6wF5AXoAvoBigDRAGvANoAbgA4gBxwDpAHUAO2Ae0A-wB_QD_gIQARMAi8BHsCRAJFASsAmKBMgEygJtATsAoeBR4FIgKTgU0BTYCnwFSAKsAVyArsBYUCxALFAWUAtEBakC2ALZAW4AuABcgC6AF2gLvgXkBeYC-gF_gMEAYMAw0BiADFgGPAMhgZGBkkDJgMnAZUAywBmYDOQGeANEgaMBo4DTQGpgNVgauBrIDXgG0ANsgbcBt8DcgN1AcEA4sBx4Dk4HLAcuA50Bz4DrAHigPHgeSB5QD2gHxQPkA-UB9cD7QPugfsB-4D-wH_AQBAgIBAwCB4EEQIJgQYAg3BMwEzgJqATYgm2CbkE3gTfAnDBOUE5gJ0gTrgnaCdwE8AJ5hBqAEEAAQBlDgAQCdAG2EAAQAuQDTlAAICdA.f_wACHwAAAAA

The IAB TCF string that contains information on consent preferences.

OT-Addtl-Consent-Stringstring nullable

The Additional Consent string for Google Vendors.

Example:1~1584.2292.2392.3100.14332.24431.25731.25931.26031.26831.27731.28031

The Additional Consent string for Google Vendors.

Response

Success

generalVendorsobject
otConsentStringstring

Example response

{
  "errors": [
    {
      "code": "ERROR_CODE_BLOB_LOCATIONS_UNAVAILABLE",
      "message": "Unable to fetch data for the specified Application ID. Please check your configurations."
    }
  ],
  "warnings": [
    {
      "code": "WARNING_CODE_PUBLISHED_VERSION_MISMATCH",
      "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."
    }
  ],
  "appConfig": {
    "showBanner": true,
    "bannerReason": "Geo rule Banner is enabled and is first launch.",
    "templateType": "IAB2V2",
    "bannerReasonCode": 101,
    "gcmInfo": {
      "gcmConsents": {
        "adStorage": "DENIED",
        "adUserData": "GRANTED",
        "analyticsStorage": "UNDEFINED"
      }
    },
    "countryCode": "US",
    "regionCode": "CA",
    "lastReconsentDate": 1733147973220,
    "rejectAllButtonBehavior": "LIActiveIfLegalBasis"
  },
  "iab2V2Vendors": {
    "groupPrefixes": {
      "stack": "V2STACK",
      "feature": "IFE2V2",
      "purpose": "IAB2V2",
      "specialPurpose": "ISP2V2",
      "specialFeature": "ISF2V2"
    },
    "purposes": {
      "1": {
        "id": 1,
        "name": "Store and/or access information on a device",
        "description": "Cookies, device or similar online identifiers (e.g. login-based identifiers, randomly assigned identifiers, network based identifiers) together with other information (e.g. browser type and information, language, screen size, supported technologies etc.) can be stored or read on your device to recognise it each time it connects to an app or to a website, for one or several of the purposes presented here.",
        "iabIllustrations": [
          "Most purposes explained in this notice rely on the storage or accessing of information from your device when you use an app or visit a website. For example, a vendor or publisher might need to store a cookie on your device during your first visit on a website, to be able to recognise your device during your next visits (by accessing this cookie each time)."
        ]
      }
    },
    "specialPurposes": {
      "1": {
        "id": 1,
        "name": "Ensure security, prevent and detect fraud, and fix errors",
        "description": "Your data can be used to monitor for and prevent unusual and possibly fraudulent activity (for example, regarding advertising, ad clicks by bots), and ensure systems and processes work properly and securely. It can also be used to correct any problems you, the publisher or the advertiser may encounter in the delivery of content and ads and in your interaction with them.",
        "iabIllustrations": [
          "An advertising intermediary delivers ads from various advertisers to its network of partnering websites. It notices a large increase in clicks on ads relating to one advertiser, and uses data regarding the source of the clicks to determine that 80% of the clicks come from bots rather than humans."
        ]
      }
    },
    "features": {
      "1": {
        "id": 1,
        "name": "Match and combine data from other data sources",
        "description": "Information about your activity on this service may be matched and combined with other information relating to you and originating from various sources (for instance your activity on a separate online service, your use of a loyalty card in-store, or your answers to a survey), in support of the purposes explained in this notice.",
        "iabIllustrations": [
          "Information about your activity on this service may be matched and combined with other information relating to you and originating from various sources (for instance your activity on a separate online service, your use of a loyalty card in-store, or your answers to a survey), in support of the purposes explained in this notice."
        ]
      }
    },
    "specialFeatures": {
      "1": {
        "id": 1,
        "name": "Use precise geolocation data",
        "description": "With your acceptance, your precise location (within a radius of less than 500 metres) may be used in support of the purposes explained in this notice.",
        "iabIllustrations": [
          "With your acceptance, your precise location (within a radius of less than 500 metres) may be used in support of the purposes explained in this notice."
        ]
      }
    },
    "vendors": {
      "1": {
        "purposes": [
          1
        ],
        "legIntPurposes": [
          1
        ],
        "flexiblePurposes": [
          2
        ],
        "specialPurposes": [
          1
        ],
        "features": [
          1
        ],
        "specialFeatures": [
          1
        ],
        "id": 1,
        "name": "Exponential Interactive, Inc d/b/a VDX.tv",
        "iab2V2GVLVersion": 7,
        "dataDeclaration": [
          1
        ],
        "urls": {
          "langId": "en",
          "privacy": "https://vdx.tv/privacy/",
          "legIntClaim": "https://cdnx.exponential.com/wp-content/uploads/2018/04/Balancing-Assessment-for-Legitimate-Interest-Publishers-v2.pdf"
        },
        "dataRetention": {
          "stdRetention": 397
        },
        "cookieMaxAgeSeconds": 7776000,
        "usesNonCookieAccess": true,
        "deviceStorageDisclosureUrl": "https://vdxtv.expo.workers.dev",
        "legIntStatus": "-1",
        "consentStatus": "1"
      }
    },
    "iabDataCategories": {
      "1": {
        "id": 1,
        "name": "IP addresses"
      },
      "2": {
        "id": 2,
        "name": "Device characteristics"
      },
      "3": {
        "id": 3,
        "name": "Device identifiers"
      },
      "4": {
        "id": 4,
        "name": "Probabilistic identifiers"
      },
      "5": {
        "id": 5,
        "name": "Authentication-derived identifiers"
      },
      "6": {
        "id": 6,
        "name": "Browsing and interaction data"
      },
      "7": {
        "id": 7,
        "name": "User-provided data"
      },
      "8": {
        "id": 8,
        "name": "Non-precise location data"
      },
      "9": {
        "id": 9,
        "name": "Precise location data"
      },
      "10": {
        "id": 10,
        "name": "Users’ profiles"
      },
      "11": {
        "id": 11,
        "name": "Privacy choices"
      }
    },
    "vendorListVersion": 35,
    "lastUpdated": "2024-01-11T16:07:36Z"
  },
  "googleVendors": {
    "vendors": {
      "320": {
        "id": 320,
        "name": "Merkury",
        "policyUrl": "https://www.merkle.com/getting-know-your-privacy-rights/privacy-notice",
        "consentStatus": 1
      },
      "1085": {
        "id": 1085,
        "name": "activecore",
        "policyUrl": "https://www.activecore.jp/privacy-policy/",
        "consentStatus": 1
      },
      "1421": {
        "id": 1421,
        "name": "Alkami Technology, Inc.",
        "policyUrl": "https://www.alkami.com/privacy-policy/",
        "consentStatus": 1
      }
    },
    "vendorListVersion": 1
  },
  "generalVendors": {
    "V1": {
      "id": "53a7e59b-73cb-4355-bc2b-53772084314d",
      "name": "First General Vendor",
      "vendorCustomId": "V1",
      "description": "First General Vendor Description",
      "privacyPolicyUrl": "https://www.google.com",
      "sdks": [
        "c427872b-7d43-4808-91c1-95698e9ce287"
      ],
      "toggleStatus": 0
    }
  },
  "vendorListUIData": {
    "general": {
      "backgroundColor": "#FFFFFF",
      "backgroundColorDark": "#2F2F2F",
      "toggleActiveColor": "#6CC04A",
      "toggleActiveColorDark": "#6CC04A",
      "toggleInactiveColor": "#FFFFFF",
      "toggleInactiveColorDark": "#FFFFFF",
      "lineBreakColor": "#dedede",
      "lineBreakColorDark": "#767676",
      "titleTextColor": "#696969",
      "titleTextColorDark": "#FFFFFF",
      "disclosureTintColor": "#696969",
      "disclosureTintColorDark": "#FFFFFF",
      "pageHeaderTitle": "IAB Vendors",
      "iabVendorsTitle": "IAB Vendors",
      "googleVendorsTitle": "Google Vendors",
      "allowAllConsentText": "Allow All Consent",
      "filter": {
        "onColor": "#346E4A",
        "onColorDark": "#6CC04A",
        "color": "#696969",
        "colorDark": "#FFFFFF"
      },
      "searchBar": {
        "textColor": "#696969",
        "textColorDark": "#FFFFFF",
        "searchPlaceholderText": "Search…",
        "searchNoResultsFoundText": "No Results Found",
        "searchResultsTotalText": "Total",
        "backgroundColorDark": "#5D5D5D"
      },
      "segmentControl": {
        "foreGroundColor": "#696969",
        "foreGroundColorDark": "#FFFFFF",
        "selectedForeGroundColor": "#FFFFFF",
        "selectedForeGroundColorDark": "#FFFFFF",
        "tintColor": "#346E4A",
        "tintColorDark": "#6CC04A",
        "font": "17",
        "selectedFont": "17"
      },
      "buttons": {
        "savePreferencesButton": {
          "borderRadius": "0",
          "color": "#346E4A",
          "colorDark": "#6CC04A",
          "fontSize": "17",
          "text": "Confirm My Choices",
          "textColor": "#FFFFFF",
          "textColorDark": "#FFFFFF",
          "interactionType": "VENDOR_LIST_CONFIRM"
        },
        "acceptAll": {
          "borderRadius": "0",
          "color": "#346E4A",
          "colorDark": "#6CC04A",
          "fontSize": "17",
          "text": "Allow All",
          "textColor": "#FFFFFF",
          "textColorDark": "#FFFFFF",
          "interactionType": "VENDOR_LIST_ALLOW_ALL"
        },
        "rejectAll": {
          "borderRadius": "0",
          "color": "#346E4A",
          "colorDark": "#6CC04A",
          "fontSize": "17",
          "text": "Reject All",
          "textColor": "#FFFFFF",
          "textColorDark": "#FFFFFF",
          "interactionType": "VENDOR_LIST_REJECT_ALL"
        }
      },
      "generalVendorsTitle": "Other Vendors",
      "generalVendorsPolicyText": "View Privacy Policy",
      "filterVendorListTitle": "Filter Vendor List"
    },
    "vendorDetailsUIData": {
      "backButtonColor": "#696969",
      "backButtonColorDark": "#FFFFFF",
      "vendorsPolicyText": "View Privacy Policy",
      "legIntClaimPolicyText": "View Legitimate Interest Claim",
      "consentToggleText": "Consent",
      "legitInterestToggleText": "Legitimate Interest",
      "consentPurposes": "Consent Purposes",
      "features": "Features",
      "specialFeatures": "Special Features",
      "specialPurposes": "Special Purposes",
      "legitimateInterestPurposesText": "Legitimate Interest Purposes",
      "lifespan": "Lifespan",
      "lifespanDay": "Day",
      "lifespanDays": "Days",
      "lifespanMonth": "Month",
      "lifespanMonths": "Months",
      "disclosureTitle": "Device Storage Disclosure",
      "nonCookieUsageText": "This vendor utilizes other methods of storage or accessing information in addition to cookies.",
      "storageIdentifierText": "Identifier",
      "storageIdentifierType": "Type",
      "storagePurposes": "Purposes",
      "storageDomain": "Domain",
      "dataDeclarationText": "Data Declaration",
      "dataRetentionText": "Data Retention",
      "dataStdRetentionText": "Standard Retention",
      "title": {
        "fontSize": "22",
        "show": true,
        "text": "About Your Privacy",
        "textAlign": "left",
        "textColor": "#696969",
        "textColorDark": "#FFFFFF"
      },
      "description": {
        "show": true,
        "fontSize": "16",
        "text": "We process your data to deliver content or advertisements and measure the delivery of such content or advertisements to extract insights about our website. We share this information with our partners on the basis of consent. You may exercise your right to consent, based on a specific purpose below or at a partner level in the link under each purpose. These choices will be signaled to our vendors participating in the Transparency and Consent Framework.",
        "textAlign": "left",
        "textColor": "#696969",
        "textColorDark": "#FFFFFF"
      },
      "link": {
        "fontSize": "17",
        "show": true,
        "text": "More information",
        "textAlign": "left",
        "textColor": "#3860BE",
        "textColorDark": "#3860BE",
        "url": "https://cookiepedia.co.uk/giving-consent-to-cookies",
        "urlQRCode": "https://cookiesqastorage.blob.core.windows.net/logos/af6aa20c-54ea-4ae1-97e8-068e906702da/1819526c-4eff-495a-af85-03642c1f8510/5d401ebd-469f-49d8-a134-f05cb5282567/865aac1d-af35-4ade-a7e1-7847cf46fe60.png"
      }
    }
  },
  "otConsentString": "eyJMYXN0TGF1bmNoRGF0ZSI6MTcwNDczNzM3OTY1MSwiU2hvdWxkU2hvd0Jhbm5lciI6MSwiRFNJRCI6InN1cC1uZXdsa2diIn0="
}