📘

This integration requires activation of additional services. Contact your MetaRouter representative for assistance.

What is Unified ID 2.0?

Unified ID 2.0 is an open-source identity framework designed to provide a privacy-conscious, interoperable identifier for advertising use cases. It allows publishers and advertisers to match users across platforms using hashed email and phone signals. The framework provides encrypted identifiers that support audience targeting and attribution while enforcing strict privacy controls. MetaRouter’s integration retrieves UID2 values securely through the UID2 Identity Map API.

Product Type: Advertising

Integration Type: ID Sync

Capabilities

• Captures the UID2 encrypted identifier (u) returned from the UID2 Identity Map API.
• Retrieves hashed or non-hashed email and phone values from identify() traits. If non-hashed values are provided, the sync hashes them before sending, and hashed values take precedence when both are present.
• Stores the encrypted UID2 value in first-party storage using the refresh timestamp returned directly by the UID2 service; this vendor-defined timestamp fully determines the cookie expiration.
• Adds the resolved UID2 identity to server-side event payloads for downstream attribution and audience matching.
• Records a failure marker when UID2 resolution fails, allowing automated retry after expiration.

Considerations

• Important Activation Details: This integration requires activation of additional MetaRouter services to enable UID2 identity resolution. Once enabled, the resolved UID2 value can be securely retrieved and applied across other third-party vendor integrations. For assistance enabling these services, contact your MetaRouter representative.

Sync Details

• IDs:

  • u – The encrypted Unified ID 2.0 identifier returned by the UID2 Identity Map API and used for audience targeting and attribution.

• Description:

  • The sync captures hashedEmail, email, hashedPhone, and phone from the identify() event in strict priority order—hashedEmail, then email, then hashedPhone, and finally phone. Any non-hashed values are hashed before being sent, and UID2 always returns results under email_hash or phone_hash regardless of the original input type.
  • Each value is stored in first-party storage for a duration determined by UID2's returned refresh timestamp; if no timestamp is provided, a 1-day lifetime is applied.
  • Values are refreshed when the stored TTL expires or when UID2 returns a new refresh timestamp.
  • A failure marker is stored for 1 day whenever the API request fails, after which the sync retries.
  • The resolved UID2 identifier is added to server-side event payloads for attribution and targeting.

• Response Example:

  • { "body": { "email": [], "email_hash": [{ "u": "AdvIvSEnkWSbYM=", "p": "EObwtHBUqenlue4=", "r": 1735689600000 }], "phone": [], "phone_hash": [] }, "status": "success"}

• Server-side Event Payload: Server-side Event Payload: Upon completion of all vendor's sync, the server-side events will incorporate all resolved identifiers as described above. The following object will be appended to the context.providers property within the event's JSON payload.

{
   "unifiedId2": {
      "data: "R2P3wxeK7QFyMBK9ec5CrdhqhBPM0YQWMKIBC" // Encrypted uid shown in Response example at FetchSync section. When this value gets to MetaRouter forwarder it will get decrypted back to normal "uid" values.
   }
}

• Cookie Name:
  • Cookie: _meta_unifiedId2_data, _meta_unifiedId2_data_failure
  • IndexedDB: [your storage prefix]_unifiedId2_data, [your storage prefix]_unifiedId2_data_failure
  • For a general guide on ID Sync validation, see https://docs.metarouter.io/docs/identity-syncs#validating-identity-syncs.

Sync Setup Guide

1. Gather Credentials

• To enable this sync, you must obtain your Unified ID 2.0 API Key and Client Secret. These credentials are generated through the UID2 onboarding process documented here: Unified ID 2.0 Auth
• Once obtained, securely store these values for use in the integration request.

2. Add a Unified ID 2.0 Sync in MetaRouter

• Submit Integration Request Ticket

  • Submit a request through our support portal to enable UID2 enrichment services and configure your Unified ID 2.0 API Key and Client Secret. MetaRouter will implement these credentials on your behalf in a secure configuration file.
  • Example ticket description:
    • Ticket Name: Enable UID2 Enrichment and Credential Implementation
    • Ticket Description: Please enable enrichment services for our Unified ID 2.0 integration and implement our UID2 API credentials (attached securely).

• Add the Unified ID 2.0 Sync

  • To gather the u identifier returned by Unified ID 2.0, you must add a Unified ID 2.0 sync.

    1. From the Pipelines page, find the pipeline associated with the web property you’d like to add a sync to. Hover over the three dot dropdown and select “Build AJS File.”

    2. In the Identity Syncs section, select the Unified ID 2.0 sync.

    3. Fill out the following fields:

       1. API Timeout (in milliseconds) – Maximum amount of time the Sync Injector waits for a response. Example: 300.
       2. MetaRouter Ingestor URL – Base domain for your MetaRouter ingestor. Do not include https:// or anything after .com. Example: mr.example.com.

    4. Scroll down and click the Save and Build File button.

    5. Deploy your AJS file to propagate changes to your web property.