| title | Documentation Updates |
|---|---|
| description | A summary of significant UID2 documentation updates. |
| hide_table_of_contents | false |
| sidebar_position | 6 |
| displayed_sidebar | docs |
import Link from '@docusaurus/Link'; import CustomTagsFilters from '@site/src/components/CustomTags/CustomTagsFilters'; import CustomTagsContainer from '@site/src/components/CustomTags/CustomTagsContainer';
Check out the latest updates to our UID2 documentation resources.
:::tip Use the Tags toolbar to view a subset of documentation updates. :::
The following documents were released in the first quarter of 2026.
April 1, 2026
The POST /identity/map endpoint documentation has been updated with the following changes:
- Added a new Rate Limiting section documenting that the endpoint enforces rate limits to safeguard against bursts of incoming traffic.
- Removed the previous recommendation to send batches sequentially over a single HTTP connection.
These changes apply to both v2 and v3 endpoints.
February 10, 2026
The optout_check parameter has been removed from the POST /token/generate endpoint. Opt-out checks are now handled automatically so publishers no longer need to include this parameter in their requests.
Related SDK functions have also been deprecated and removed from documentation:
- Java SDK:
doNotGenerateTokensForOptedOut() - Python SDK:
do_not_generate_tokens_for_opted_out()
All code examples and integration guides have been updated to reflect these changes.
The following documents were released in this quarter.
December 2, 2025
We've added an integration guide for the UID2 Databricks integration.
For details, see Databricks Clean Rooms Integration Guide.
The following documents were released in this quarter.
July 31, 2025
We've released updated versions of two additional docs to reflect adoption of the new version of the Identity Map API (v3), announced 11 July, which provides significant improvements for advertisers and data providers.
We updated the following additional implementations and corresponding documentation:
- Python SDK: see SDK for Python Reference Guide
- Snowflake: see Snowflake Integration Guide
July 11, 2025
We've released a new version of the Identity Map API (v3) that provides significant improvements for advertisers and data providers. This update includes documentation for the POST /identity/map endpoint, the SDK for Java Reference Guide, and the Advertiser/Data Provider Integration Overview.
The following documents were released in the first quarter of 2025.
March 19, 2025
A UID2 participant who wants to be a Private Operator can now set up the UID2 Operator Service as a Private Operator in an Azure Kubernetes Service (AKS) cluster, running on virtual nodes on Azure Container Instances (ACI).
For details, see UID2 Private Operator for AKS Integration Guide.
March 18, 2025
We've added a guide for mobile app publishers who want to manage the UID2 token entirely on the server side.
For details, see UID2 Server-Side Integration Guide for Mobile.
March 11, 2025
We've significantly expanded and clarified the documentation for configuring sharing permissions in the UID2 Portal.
For details, see Sharing Permissions.
March 7, 2025
We've added documentation for the recently released update of the UID2 SDK for JavaScript, version 4.
For details, see SDK for JavaScript Reference Guide.
March 7, 2025
We've added a page with high-level information about the steps for creating a UID2 token, including steps, roles, and a diagram.
For details, see How the UID2 Token Is Created.
February 12, 2025
We've significantly updated the UID2 Snowflake integration, and updated the documentation to match.
For details, see Snowflake Integration Guide.
February 10, 2025
We've updated the instructions in the UID2 integration guides, SDK docs, and endpoint docs to include information about account setup in the UID2 Portal.
For details, see any implementation guide: for example, Client-Side Integration Guide for JavaScript or SDK for Android Reference Guide.
These changes also clarify the different procedures for getting credentials depending on the environment: see expanded information on the Credentials and Environments pages.
January 10, 2025
We've significantly expanded and restructured the Advertiser/Data Provider documentation. We now have one significantly updated overview doc, and separate docs for the three main integration options that come into play: Snowflake, AWS Entity Resolution, and HTTP endpoints.
For details, including a summary of all integration options for advertisers and data providers, see Advertiser/Data Provider Integration Overview.
January 8, 2025
We've added a reference page for publishers who integrate with one or more SSO providers to offer SSO login, and want to retrieve the logged-in user's email address from the SSO provider to generate UID2 tokens.
For details, see Publisher Integration with SSO Providers.
The following documents were released in the fourth quarter of 2024.
December 15, 2024
The UID2 docs site now includes a zoom-in tool for images.
Just hover over the image and the tool appears as a magnifying glass, then click to view a magnified version of the image.
November 15, 2024
We've added the following page to the UID2 Portal documentation: Audit Trail.
The Audit Trail page in the UID2 Portal allows users who have the Admin role (see User Roles) to view a detailed log of all past actions performed by or on behalf of the current participant.
November 14, 2024
We've added a reference page with tips for publishers who are using LiveRamp's Authenticated Traffic Solution (ATS) to generate UID2 tokens to be passed in the bid request.
For details, see LiveRamp Integration Tips.
The following documents were released in the third quarter of 2024.
September 10, 2024
We've added a reference page with information about tokens.
For details, see UID2 Tokens and Refresh Tokens.
August 28, 2024
We've added a page with information about Private Operator integrations.
For details, see UID2 Private Operator Integration Overview.
August 22, 2024
We've added a guide for DSPs who are not using UID2 SDKs.
For details, see DSP Direct Integration Instructions.
July 23, 2024
We've added a page with information about the different integration approaches: client-side, client-server, and server-side.
For details, see Integration Approaches.
July 3, 2024
We've added a reference page with information for publishers generating the UID2 token on the server side.
For details, see Server-Side Token Generation.
July 2, 2024
We've added a section to the two mobile integration guides with instructions for mobile integration using Prebid, currently for Android only:
- UID2 Client-Side Integration Guide for Mobile: Prebid Integration
- UID2 Client-Server Integration Guide for Mobile: Prebid Integration
The following documents were released in the second quarter of 2024.
June 21, 2024
We've just added a guide for CTV publishers who want to integrate with UID2.
For details, see CTV Integration Guide.
May 24, 2024
We added documentation for a new API call that checks the opt-out status of raw UID2s.
Given a list of raw UID2s, this endpoint returns the raw UID2s that have opted out, as well as the time that the opt-out took place.
For details, see POST /optout/status.
May 17, 2024
We've added the following integration guides to support publishers who want to implement UID2 for their Android or iOS mobile apps:
- UID2 Mobile Integration Overview for Android and iOS
- UID2 Client-Side Integration Guide for Mobile
- UID2 Client-Server Integration Guide for Mobile
May 6, 2024
We've added the following page to the UID2 Portal documentation: Client-Side Integration.
The Client-Side Integration page in the UID2 Portal allows you to set up and manage the values that are needed if you are generating UID2 tokens on the client side, such as specifying your domains.
April 25, 2024
The UID2 Portal documentation now includes a new page, API Keys.
The API Keys page in the UID2 Portal allows you to perform all activities relating to managing API keys, and their associated secret values and permission settings, for your UID2 account.
April 22, 2024
We've completely reworked and significantly expanded the sharing documentation to include instructions for all sharing scenarios.
The documentation now supports additional sharing scenarios, including the ability to share raw UID2s when senders and receivers follow the applicable legal, security, and technical requirements.
For details, see UID2 Sharing: Overview.
The following documents were released in the first quarter of 2024.
March 4, 2024
We've added a UID2 hashing tool so that you can check that you're normalizing and encoding correctly.
For details, see UID2 Hashing Tool in the Normalization and Encoding documentation.
February 28, 2024
The Java SDK now supports Advertisers and Data Providers wanting to use the POST /identity/map (v2) endpoint.
For details, see the updated documentation in the SDK for Java Reference Guide: Usage for Advertisers and Data Providers.
February 9, 2024
We've improved the website so that specific users clicking through on the links at the top of the UID2 home page (Publishers, Advertisers, DSPs, Data Providers) now have a custom left sidebar, with the specific documentation that's applicable to that audience.
Anyone wanting to see the full set of docs for all audiences can just click through on the Documentation link on the UID2 home page.
Note that many docs are applicable to multiple audiences, and there are many interlinks between docs, so the sidebar view might change on your journey through the site. You can always get back to your specific view by clicking the link at the top: these links appear on all pages.
To view the custom sidebars, go to https://unifiedid.com and click on one of the audience links at the top: Publishers. Advertisers, DSPs, or Data Providers.
January 26, 2024
We've added an overview guide summarizing the options for publishers using the SDK for JavaScript for client-side or client-server integration. In addition, the existing guides have been renamed for consistency, with minor updates.
For details, see:
- UID2 Integration Overview for JavaScript
- Client-Side Integration Guide for JavaScript
- Client-Server Integration Guide for JavaScript
January 22, 2024
We've added sections in the SDK for Java documentation to help publishers implementing the SDK.
For details, see Usage for Publishers in the SDK for Java Reference Guide.
January 19, 2024
We've expanded and clarified the existing Normalization and Encoding doc, and added an examples section to help you make sure that you're following the process correctly.
For details, see Normalization and Encoding.
January 16, 2024
We've added a page summarizing the web integration options available to publishers integrating with UID2.
For details, see Publisher Web Integration Overview.
January 3, 2024
We've added a reference page explaining what the UID2 Operator does and the differences between a Public Operator and a Private Operator.
For details, see The UID2 Operator.
The following documents were released in the fourth quarter of 2023.
December 20, 2023
We've added an overview guide that summarizes the publisher options for integrating Prebid with UID2.
In addition, the existing guides have been restructured and simplified.
For details, see:
- UID2 Integration Overview for Prebid
- UID2 Client-Side Integration Guide for Prebid.js
- UID2 Client-Server Integration Guide for Prebid.js
December 14, 2023
We've added instructions and code examples for encrypting UID2 requests and decrypting responses in additional programming languages. To the existing Python example, we've added Java and C#.
For details, see Encryption and Decryption Code Examples.
November 30, 2023
A UID2 participant who wants to be a Private Operator can now set up the UID2 Operator Service in an instance of Confidential Containers, a confidential computing option from Microsoft Azure.
For details, see UID2 Private Operator for Azure Integration Guide.
November 22, 2023
We've added an article in the Getting Started section of the UID2 website that provides information about the key UID2 permissions, the types of participants that commonly use them, and the key associated activities.
For details, see API Permissions.
November 21, 2023
We've replaced the previous API Keys page with a page that includes information about the credentials for those following a server-side implementation strategy.
For details, see UID2 Credentials.
November 21, 2023
The Client-Side Integration Guide for JavaScript is a completely new document at the existing URL, covering a way of using the SDK for JavaScript for a client-side publisher implementation.
For details, see Client-Side Integration Guide for JavaScript.
The content that was in the previous SDK for JavaScript Integration Guide is now in a supplementary document for publishers who want to implement the JavaScript SDK on the server side.
:::note This document was updated in January 2024 to Client-Side Integration Guide for JavaScript, and the JavaScript Standard Integration Guide is now the Client-Server Integration Guide for JavaScript. :::
November 2, 2023
The UID2 Client-Side Integration Guide for Prebid.js is a completely new document at the existing URL, covering a way of integrating UID2 with Prebid that does not require any server-side work.
The content that was in the previous version of the Prebid document is now in a supplementary document, Prebid.js Advanced Integration Guide, for publishers who are using a Private Operator or who prefer to implement token generate on the server side.
:::note These documents were further updated in later revisions. Updated links are as follows:
- UID2 Integration Overview for Prebid
- UID2 Client-Side Integration Guide for Prebid.js
- UID2 Client-Server Integration Guide for Prebid.js :::
October 31, 2023
This reference topic provides an overview of user opt-out.
For details, see User Opt-Out.
October 19, 2023
This guide provides information for using AWS Entity Resolution, an identity resolution product from Amazon Web Services that allows AWS customers to integrate with the UID2 framework.
This service allows you to map DII (email addresses or phone numbers) to raw UID2s swiftly and securely.
For details, see AWS Entity Resolution Integration Guide.
October 10, 2023
Significant documentation updates reflect the enhanced functionality of Version 3 of the SDK for JavaScript. The new documentation includes a migration guide for those upgrading from an earlier version of the SDK.
For details, see:
The following documents were released in the third quarter of 2023.
September 30, 2023
This guide provides information for setting up the UID2 Operator Service in Confidential Space, a confidential computing option from the Google Cloud Platform.
For details, see UID2 Private Operator for GCP Integration Guide.
September 7, 2023
We clarified the instructions for normalizing and encoding directly identifying information (DII) to create a raw UID2 or UID2 token.
For details, see:
August 8, 2023
A guide for publishers that provides information about the UID2 Interactive Media Ads (IMA) Plugin for Android. This plugin enables publishers who use the Google IMA SDK for Android to send UID2 tokens as secure signals in ad requests from Android apps.
For details, see UID2 IMA Plugin for Android Integration Guide.
August 8, 2023
A guide for publishers that provides information about the UID2 Interactive Media Ads (IMA) Plugin for iOS. This plugin enables publishers who use the Google IMA SDK for iOS to send UID2 tokens as secure signals in ad requests from iOS apps.
For details, see UID2 IMA Plugin for iOS Integration Guide.
August 4, 2023
A guide for publishers that provides information about the UID2 Google Mobile Ads (GMA) Plugin for Android. This plugin enables publishers who use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from Android apps.
For details, see UID2 GMA Plugin for Android Integration Guide.
August 4, 2023
A guide for publishers that provides information about the UID2 Google Mobile Ads (GMA) Plugin for iOS. This plugin enables publishers who use the Google GMA SDK to send UID2 tokens as secure signals in ad requests from iOS apps.
For details, see UID2 GMA Plugin for iOS Integration Guide.
August 3, 2023
The entire UID2 website is now available in Japanese as well as English.
For details, use the language drop-down at the top of any site page, or go straight to the Unified ID 2.0 page in Japanese.
August 3, 2023
We published several documentation pages to help users navigating the UID2 Portal user interface, where you can manage your UID2 account.
For details, see UID2 Portal: Overview.
August 3, 2023
We published the following new and updated documents to support use of the UID2 Sharing feature:
-
A set of pages providing information relating to UID2 sharing, including an overview, use cases, implementation instructions, best practices, and more. See UID2 Sharing: Overview.
-
Updates to the four server-side SDKs to support UID2 sharing:
-
Updates to the Snowflake feature to support UID2 sharing. See Snowflake Integration Guide: Usage for UID2 Sharers.
August 3, 2023
A guide for publishers that provides information about the SDK for Android, an SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers who need to support Android apps.
For details, see SDK for Android Reference Guide.
August 3, 2023
A guide for publishers that provides information about the SDK for iOS, an SDK that facilitates the process of establishing client identity using UID2 and retrieving UID2 tokens for publishers who need to support iOS apps.
For details, see SDK for iOS Reference Guide.