AdTech Partner Client Integration

This page is meant for AdTech Partners that need to do a client side integration and be able to see and collect Utiq adtechpass, if the integration is not part of the standard Prebid integration of publishers.

To become eligible to get Utiq ID, for testing, you need to add a testing stub as 'x-cryptip' request header in ModHeader.

Reach out to csm@utiq.com to ask for a testing stub.

Visit a Utiq integrated publisher.

Utiq will be part of the CMP as Integrated model, or after accepting the CMP, you will see Utiq Separate pop-up. In both cases, you should verify in network that utiqLoader.js has loaded.

If it’s not loaded, you can ‘force’ it in console by calling the below.

JS

(() => {
  const s = document.createElement("script")
  s.type = 'text/javascript';
  s.src = "https://utiq.example.com/utiqLoader.js"
  s.async = true;
  document.head.appendChild(s)
})();

After you accept CMP or Utiq Separate pop-up, you will get adtechpass (atid) in 'utiqPass' localStorage.

You can collect the adtechpass (atid) with our API.

If you use a cross-domain iframe and execute your own Prebid there, use Prebid version 10.11 or higher within the iframe, where support has been added to allow Utiq IDs to be cascaded from the parent page to the child frame.

The main focus should be the adtechpass (atid) which is encrypted with daily rotation keys and is meant for open bidding.

In the bidding stream, the atid must be forwarded to SSPs/DSPs as source: "utiq.com" - this is the same source as our Prebid module is setting.

Your goal is to collect the adtechpass and whitelist it to send it to SSPs/DSPs.

Passing Utiq ID in OpenRTB (without Prebid)

When integrating without Prebid, the Utiq ID must be passed using the IAB user.eids structure in the OpenRTB (2.6 or newer) request. The snippet below shows the minimal compliant payload to declare Utiq as an identity source (source = "utiq.com") and attach the user identifier (uids[].id) with the appropriate atype.

JSON

user: {
  eids: [
    {
      source: "utiq.com",
      uids: [
        {
          id: "<Utiq ID>",
          atype: 1
        }
      ]
    }
  ]
}

Example of Utiq adtechpass:
yamfAqTYIPxguXkGjAtKz0r7PWbUT4dgsKhXb66rPmXuCWzjdVR5Eb72jH1x2pI5o+2SowCBZFrzUqiA9xeCkQ==-d3s5i796p2713psst6h0

If you use OpenRTB 2.5 or older, send Utiq ID in user.ext.eids instead

If you add atype, set as 1 else some partners might not ingest the Utiq ID.