"Integrated Model" - Utiq & CMP APIs

This page purpose is to guide you what technical steps you will need to make, if you want to go for “Integrated Model”.

Prerequisites to use “Integrated Model”

Make sure you meet the minimum Utiq standards for using the “Integrated Model” by reviewing Option A: Integrated consent model

Configurations in CMP console

For the integration you will need to do some configurations on your CMP.

Please follow the principles and steps as described on Configuration in CMP console.

Adding a new vendor and/or new purpose might trigger a reconsent for your property's end Users.

Ensure the buttons are always visible

Add CMP CSS to allow scrollbar, so that buttons are always visible

#id { max-height: 300px; overflow-y: scroll; }

Change #id with your CMP's respective text element id

Technical Implementation

On top of the CMP configurations, there are the following technical integration actions that need to be done.

For any technical questions, you can reach out to our Customer Success team at csm@utiq.com

Code

Please implement the following code to be executed after your CMP code has completed.

Follow the below code examples, to combine the required actions, as described above.

JS

// Call 'handleConsentChange' when CMP Consent change
// Get utiqPurposeConsent and utiqVendorConsent from the CMP
window.Utiq.API.handleConsentChange(utiqPurposeConsent === true && utiqVendorConsent !== false);
// If the website’s CMP is not listing any other vendors (and only listing the purposes), the utiqVendorConsent parameter can be omitted

// Check if Utiq Consent was revoked from Manage Utiq page
window.Utiq ||= {};
window.Utiq.queue ||= [];

window.Utiq.queue.push(() => {
  if (!window.Utiq.API.getUtiqConsentStatus()) {
    // Turn Utiq purpose AND vendor to false on CMP if needed
  }
});

// Set 'none' on window.Utiq.config.CMP
// Set 'onConsentUpdateFinished' listener for the consent syncronization
window.Utiq ||= {};
window.Utiq.config = {
  CMP: 'none', // Needed for Utiq SDK to *not* show Utiq Separate Pop-up
  customizationOptions: { // Needed for consent revocation pop-up in Manage Utiq
    buttons: {
      bodyColor: '#ff0066',
      textColor: '#000000',
      radius: 5,
    },
    contentTextColor: '#000000'
  },
  listeners: {
    onConsentUpdateFinished: ({ isConsentGranted }) => {
      setTimeout(() => {
        if (!isConsentGranted) {
          // Turn Utiq purpose AND vendor to false on CMP if needed
        }
      }, 250);
    }
  }
};
(() => {
  const s = document.createElement("script")
  s.type = 'text/javascript';
  s.src = "https://utiq.example.com/utiqLoader.js"
  s.async = true;
  document.head.appendChild(s)
})();

For window.Utiq.API.handleConsentChange(utiqPurposeConsent === true && utiqVendorConsent !== false);, if the website’s CMP is not listing any other vendors (and only listing the purposes), the utiqVendorConsent parameter can be omitted.

Using up to ES5 JavaScript Version (Google Tag Manager)

The code can be integrated using a Tag Manager. Bellow an example using Google Tag Manager, where you need to put the code in <script></script> and change the arrow function (() => { to (function () { to comply with ES5 JavaScript.

JS

<script>
  // Call 'handleConsentChange' when CMP Consent change
  // Get utiqPurposeConsent and utiqVendorConsent from the CMP
  window.Utiq.API.handleConsentChange(utiqPurposeConsent === true && utiqVendorConsent !== false);
  // If the website’s CMP is not listing any other vendors (and only listing the purposes), the utiqVendorConsent parameter can be omitted
  
  // Check if Utiq Consent was revoked from Manage Utiq page
  window.Utiq ||= {};
  window.Utiq.queue ||= [];
  
  window.Utiq.queue.push(() => {
    if (!window.Utiq.API.getUtiqConsentStatus()) {
      // Turn Utiq purpose AND vendor to false on CMP if needed
    }
  });
  
  // Set 'none' on window.Utiq.config.CMP
  // Set 'onConsentUpdateFinished' listener for the consent syncronization
  window.Utiq ||= {};
  window.Utiq.config = {
    CMP: 'none', // Needed for Utiq SDK to *not* show Utiq Separate Pop-up
    customizationOptions: { // Needed for consent revocation pop-up in Manage Utiq
      buttons: {
        bodyColor: '#ff0066',
        textColor: '#000000',
        radius: 5,
      },
      contentTextColor: '#000000'
    },
    listeners: {
      onConsentUpdateFinished: ({ isConsentGranted }) => {
        setTimeout(() => {
          if (!isConsentGranted) {
            // Turn Utiq purpose AND vendor to false on CMP if needed
          }
        }, 250);
      }
    }
  };
  (function () {
    const s = document.createElement("script")
    s.type = 'text/javascript';
    s.src = "https://utiq.example.com/utiqLoader.js"
    s.async = true;
    document.head.appendChild(s)
  })();
</script>

Below are some hyperlinks for above event listeners and APIs, just for further information of their purpose.

handleConsentChange API is used to handle the consent of users' choices in your CMP, to Utiq SDK, based on specific purpose ID and vendor ID (if vendors are used)
getUtiqConsentStatus API is used to get the users consent stored on Utiq
customizationOptions object allows you to style the consent revocation pop-up in Manage Utiq
onConsentUpdateFinished event listener is triggered when Utiq consent has changed

APIs for CMP vendors

Below is a list of APIs you can call, based on your CMP vendor.

Please note that:

[INSERT UTIQ CUSTOM PURPOSE] → add the parameter setup in your CMP for the Utiq custom purpose
[INSERT UTIQ CUSTOM VENDOR] → add the parameter setup in your CMP for the Utiq custom vendor

CMP vendors:

Didomi

Last check on CMP vendor documentation:

Where to add it

Line in code

API

On load and in onConsentUpdateFinished Utiq’s event listener if Utiq consent is false

Line 8 and 27

JS

const transaction = Didomi.openTransaction();
transaction.disablePurpose([INSERT UTIQ CUSTOM PURPOSE]);
transaction.disableVendor([INSERT UTIQ CUSTOM VENDOR]);
transaction.commit();

Before appending utiqLoader.js

Line 1

JS

window.didomiOnReady ||= [];
window.didomiOnReady.push((Didomi) => {
  window.didomiEventListeners ||= [];
  window.didomiEventListeners.push({
    event: 'consent.changed',
    listener() {
    const purposeConsent = Didomi.getUserConsentStatusForPurpose([INSERT UTIQ CUSTOM PURPOSE]);
    const vendorConsent = Didomi.getUserConsentStatusForVendor([INSERT UTIQ CUSTOM VENDOR]);
    window.Utiq.queue.push(() => {
      try {
        window.Utiq.API.handleConsentChange(purposeConsent === true && vendorConsent !== false);
      } catch (err) {
        console.error(
          `handleConsentChange API call failed. Reason: ${err.message}`,
        );
      }
    });
  },
});

Function to open 2nd layer

JS

Didomi.preferences.show()

OneTrust and CookiePro

Last check on CMP vendor documentation:

Where to add it

Line in code

API

On load and in onConsentUpdateFinished Utiq’s event listener if Utiq consent is false

Line 8 and 27

JS

window.Optanon.UpdateConsent('Category', '[INSERT UTIQ CUSTOM PURPOSE]:0');

Before appending utiqLoader.js

Line 1

JS

window.Utiq ||= {};
window.Utiq.queue ||= [];
window.Utiq.queue.push(() => {
  window.addEventListener('consent.onetrust', () => {
    let purposeConsent = null;
    if (OptanonActiveGroups) {
      purposeConsent = OptanonActiveGroups.indexOf('[INSERT UTIQ CUSTOM PURPOSE]') !== -1;
    }
    try {
      window.Utiq.API.handleConsentChange(purposeConsent);
    } catch (err) {
      console.error(
        `handleConsentChange API call failed. Reason: ${err.message}`,
      );
    }
  });
});

Function to open 2nd layer

JS

window.Optanon.ToggleInfoDisplay()

iubenda

Last check on CMP vendor documentation: 12 Nov 2024

Where to add it

Line in code

API

On load and in onConsentUpdateFinished Utiq’s event listener if Utiq consent is false.

Line 8 and 27

JS

_iub.cs?.api?.setPreferences({
    purposes: {
      [INSERT UTIQ CUSTOM PURPOSE]: false,
    },
    vendors: {
      [INSERT UTIQ CUSTOM VENDOR]: false,
    },
  });

Before appending utiqLoader.js

Line 1

JS

_iub.csConfiguration.callback = {
  onPreferenceExpressed() {
    const preferences = _iub.cs?.api?.getPreferences();
    window.Utiq.API.handleConsentChange(preferences?.purposes.[INSERT UTIQ CUSTOM PURPOSE] === true && preferences?.vendors.[INSERT UTIQ CUSTOM VENDOR] !== false);
  },
};

Function to open 2nd layer

JS

_iub.cs.api.openPreferences()

Sourcepoint

Last check on CMP vendor documentation: 23 Apr 2025

Where to add it

Line in code

API

On load and in onConsentUpdateFinished Utiq’s event listener if Utiq consent is false

Line 8 and 27

JS

let purposeIds = [];
let vendorIds = [];
await __tcfapi('getCustomVendorConsents', 2, function (data) {
  purposeIds = data.consentedPurposes.map((item) => item._id);
  vendorIds = data.consentedVendors.map((item) => item._id);
});
__tcfapi('postRejectAll', 2, function () {
  __tcfapi(
    'postCustomConsent',
    2,
    function () {},
    vendorIds.filter((item) => item !== '[INSERT UTIQ CUSTOM VENDOR]'),
    purposeIds.filter((item) => item !== '[INSERT UTIQ CUSTOM PURPOSE]'),
    [],
  );
});

Before appending utiqLoader.js

Line 1

JS

setTimeout(() => {
  const isConsentGranted = await __tcfapi('getCustomVendorConsents', 2, function (data) {
    purposeIds = data.consentedPurposes.map((item) => item._id);
    vendorIds = data.consentedVendors.map((item) => item._id);
    purposeConsent = purposeIds.includes('[INSERT UTIQ CUSTOM PURPOSE]');
    vendorConsent = vendorIds.includes('[INSERT UTIQ CUSTOM VENDOR]');
    if (purposeConsent === true && vendorConsent !== false) {
      resolve(true);
    } else {
      resolve(false);
    }
  });
  try {
    window.Utiq.API.handleConsentChange(isConsentGranted);
  } catch (err) {
    console.error(
      `handleConsentChange API call failed. Reason: ${err.message}`,
    );
  }
}, 250);

Function to open 2nd layer

JS

window._sp_.gdpr.loadPrivacyManagerModal([INSERT]);

Testing

To validate the integration, you will need to run the “Utiq Integrated Model” test cases.