Accessing the Utiq Passes

The Utiq passes and metadata you can access, are the following:

mtid → martechpass
atid → adtechpass
attrid → attributionpass
category → ‘mobile’ or ‘fixed’, to differentiate if Utiq IDs are generated based the mobile connection, or the fixed (household) connection
ttl → The TTL (Time To Live) of when the martechpass expires
domain → The domain for which the consent has been granted for

These passes are enabled based on agreement with Utiq - reach out to csm@utiq.com

There are two ways to retrieve these values:

1. Using the onIdsAvailable event listener (recommended)

Example using Utiq configuration, if you are the one invoking utiqLoader.js:

JS

window.Utiq ||= {};
window.Utiq.config = {
  listeners: {
    onIdsAvailable: ({ mtid, atid, attrid, category, ttl, domain }) => {
      // Single callback action
    }
  }
};

Example using the addEventListener API, if you are a third party, ensuring you can interact with Utiq SDK, regardless of which script gets loaded first, avoiding race conditioning issues:

JS

window.Utiq ||= {};
window.Utiq.queue ||= [];

const handleIdsAvailable = ({ mtid, atid, attrid, category, ttl, domain }) => {
  // Callback action for onIdsAvailable
};

window.Utiq.queue.push(() => {
  window.Utiq.API.addEventListener('onIdsAvailable', handleIdsAvailable);
});

2. Using the getIdGraphEntry API method

Example:

JS

try {
  const martechpass = window.Utiq.API.getIdGraphEntry('mtid')
  console.log(`Utiq martechpass: ${martechpass}`)
  const adtechpass = window.Utiq.API.getIdGraphEntry('atid')
  console.log(`Utiq adtechpass: ${adtechpass}`)
  const attributionpass = window.Utiq.API.getIdGraphEntry('attrid')
  console.log(`Utiq attributionpass: ${attributionpass}`)
  const category = window.Utiq.API.getIdGraphEntry('category')
  console.log(`Utiq category: ${category}`)
  const ttl = window.Utiq.API.getIdGraphEntry('ttl')
  console.log(`Utiq category: ${ttl}`)
  const domain = window.Utiq.API.getIdGraphEntry('domain')
  console.log(`Utiq category: ${domain}`)
} catch (err) {
  console.error(`getIdGraphEntry API call failed. Reason: ${err.message}`)
}

First Page Utiq Passes Optimization

If you want to optimize the Utiq Passes timing on the first page of your website, and be available on those bid requests and/or other marketing platform integrations, and not from second page only, so that you can get more value out of Utiq, then you could consider using our event listener onFlowCompleted, with the below logic.

Don't call Prebid and/or other marketing platform integrations after CMP acceptance but wait to call them when this event listener fires.

This event is dispatched when Utiq has completed its flow, either user was eligible and accepted/rejected, user had accepted/rejected on previous session, or user was not eligible.