Back to User ID Module

ID5 ID

The ID5 ID is a shared, neutral identifier that publishers and ad tech platforms can use to recognise users even in environments where 3rd party cookies are not available. The ID5 ID is designed to respect users’ privacy choices and publishers’ preferences throughout the advertising value chain. For more information about the ID5 ID and detailed integration docs, please visit our documentation.

ID5 ID Registration

The ID5 ID is free to use, but requires a simple registration with ID5. Please visit our website to sign up and request your ID5 Partner Number to get started.

The ID5 privacy policy is at id5.io/platform-privacy-policy.

ID5 ID Configuration

First, make sure to add the ID5 submodule to your Prebid.js package with:

gulp build --modules=id5IdSystem,userId

The following configuration parameters are available:

NOTE: The ID5 ID that is delivered to Prebid will be encrypted by ID5 with a rotating key to avoid unauthorized usage and to enforce privacy requirements. Therefore, we strongly recommend setting storage.refreshInSeconds to 2 hours (7200 seconds) or less to ensure all demand partners receive an ID that has been encrypted with the latest key, has up-to-date privacy signals, and allows them to transact against it.

A Note on A/B Testing

Publishers may want to test the value of the ID5 ID with their downstream partners. While there are various ways to do this, A/B testing is a standard approach. Instead of publishers manually enabling or disabling the ID5 User ID Module based on their control group settings (which leads to fewer calls to ID5, reducing our ability to recognize the user), we have baked this in to our module directly.

To turn on A/B Testing, simply edit the configuration (see above table) to enable it and set what percentage of users you would like to set for the control group. The control group is the set of user where an ID5 ID will not be exposed in to bid adapters or in the various user id functions available on the pbjs global. An additional value of ext.abTestingControlGroup will be set to true or false that can be used to inform reporting systems that the user was in the control group or not. It’s important to note that the control group is user based, and not request based. In other words, from one page view to another, a user will always be in or out of the control group.

A Note on Using Multiple Wrappers

If you or your monetization partners are deploying multiple Prebid wrappers on your websites, you should make sure you add the ID5 ID User ID module to every wrapper. Only the bidders configured in the Prebid wrapper where the ID5 ID User ID module is installed and configured will be able to pick up the ID5 ID. Bidders from other Prebid instances will not be able to pick up the ID5 ID.

ID5 ID Examples

Publisher wants to retrieve the ID5 ID through Prebid.js

pbjs.setConfig({
  userSync: {
    userIds: [{
      name: 'id5Id',
      params: {
        partner: 173,            // change to the Partner Number you received from ID5
        externalModuleUrl: 'https://cdn.id5-sync.com/api/1.0/id5PrebidModule.js',
        pd: 'MT1iNTBjY...',      // optional, see table above for a link to how to generate this
        abTesting: {             // optional
          enabled: true,         // false by default
          controlGroupPct: 0.1   // valid values are 0.0 - 1.0 (inclusive)
        }
      },
      storage: {
        type: 'html5',           // "html5" is the recommended storage type
        name: 'id5id',           // "id5id" is the recommended storage name
        expires: 90,             // storage lasts for 90 days
        refreshInSeconds: 7200   // refresh ID every 2 hours to ensure it's fresh
      }
    }],
    auctionDelay: 50             // 50ms maximum auction delay, applies to all userId modules
  }
});

ATTENTION: As of Prebid.js v8.33.0, to ensure the ID5 module in Prebid.js interoperates properly with the ID5 API, it’s possible to provide the externalModuleUrl parameter and set it to the latest available module version at https://cdn.id5-sync.com/api/1.0/id5PrebidModule.js. If you have any questions, please reach out to us at prebid@id5.io.

Provided eids

The module provides following eids:

[
  {
    source: 'id5-sync.com',
    uids: [
      {
        id: 'some-random-id-value',
        atype: 1,
        ext: {
          linkType: 2,
          abTestingControlGroup: false
        }
      }
    ]
  },
  {
    source: 'true-link-id5-sync.com',
    uids: [
      {
        id: 'some-publisher-true-link-id',
        atype: 1
      }
    ]
  },
  {
    source: 'uidapi.com',
    uids: [
      {
        id: 'some-uid2',
        atype: 3,
        ext: {
          provider: 'id5-sync.com'
        }
      }
    ]
  }
]

The id from id5-sync.com should be always present (though the id provided will be ‘0’ in case of no consent or optout)

The id from true-link-id5-sync.com will be available if the page is integrated with TrueLink (if you are an ID5 partner you can learn more at ID5 wiki)

The id from uidapi.com will be available if the partner that is used in ID5 user module has the EUID2 integration enabled (it has to be enabled on the ID5 side)

Providing TrueLinkId as a Google PPID

TrueLinkId can be provided as a PPID - to use, it the true-link-id5-sync.com needs to be provided as a ppid source in prebid userSync configuration:

pbjs.setConfig({
  userSync: {
    ppid: 'true-link-id5-sync.com',
    userIds: [],  //userIds modules should be configured here
  }
});

Back to User ID Module