From 9c5e07d27714d00ec882c91b4a25b7be0d74b06f Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Mon, 9 Feb 2026 11:00:53 +1100 Subject: [PATCH 01/10] remove optout_check and deprecated SDK functions --- docs/endpoints/post-token-generate.md | 20 ++++++------------- .../gs-encryption-decryption.md | 16 +++++++-------- docs/getting-started/gs-faqs.md | 2 +- docs/getting-started/gs-opt-out.md | 2 +- docs/sdks/sdk-ref-java.md | 9 ++------- docs/sdks/sdk-ref-python.md | 2 +- 6 files changed, 19 insertions(+), 32 deletions(-) diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index d2240de62..51fab452c 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -15,9 +15,6 @@ Requests a UID2 token generated from a user's ' | python3 uid2_request.py Example: - echo '{"email": "test@example.com", "optout_check": 1}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= - + echo '{"email": "test@example.com"}' | python3 uid2_request.py https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= + Refresh Token Usage: python3 uid2_request.py --refresh-token @@ -356,7 +356,7 @@ public class Uid2Request { + "java -jar Uid2Request-jar-with-dependencies.jar " + "\n\n" + "Example:" + "\n " - + "echo '{\"email\": \"test@example.com\", \"optout_check\": 1}' | java -jar Uid2Request-jar-with-dependencies.jar https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=" + "\n\n\n" + + "echo '{\"email\": \"test@example.com\"}' | java -jar Uid2Request-jar-with-dependencies.jar https://prod.uidapi.com/v2/token/generate PRODGwJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg=" + "\n\n\n" + "Refresh Token Usage:" + "\n " + "java -jar Uid2Request-jar-with-dependencies.jar --refresh-token " + "\n\n" @@ -466,8 +466,8 @@ Usage: echo '' | .\uid2_request Example: - echo '{"email": "test@example.com", "optout_check": 1}' | .\uid2_request https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= - + echo '{"email": "test@example.com"}' | .\uid2_request https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= + Refresh Token Usage: .\uid2_request --refresh-token @@ -810,8 +810,8 @@ func printUsage() { echo '' | go run uid2_request.go Example: - echo '{"email": "test@example.com", "optout_check": 1}' | go run uid2_request.go https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= - + echo '{"email": "test@example.com"}' | go run uid2_request.go https://prod.uidapi.com/v2/token/generate UID2-C-L-999-fCXrMM.fsR3mDqAXELtWWMS+xG1s7RdgRTMqdOH2qaAo= wJ0hP19QU4hmpB64Y3fV2dAed8t/mupw3sjN5jNRFzg= + Refresh Token Usage: go run uid2_request.go --refresh-token diff --git a/docs/getting-started/gs-faqs.md b/docs/getting-started/gs-faqs.md index 96092f99e..addc47e1d 100644 --- a/docs/getting-started/gs-faqs.md +++ b/docs/getting-started/gs-faqs.md @@ -92,7 +92,7 @@ No, publishers do not need to decrypt directly identifying information (DII) to UID2 tokens for targeted advertising. - - - --> Always apply `doNotGenerateTokensForOptedOut()`. This applies a parameter similar to setting `optout_check=1` in the call to the POST /token/generate endpoint (see [Unencrypted JSON Body Parameters](../endpoints/post-token-generate.md#unencrypted-json-body-parameters)). ::: @@ -224,7 +222,7 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve 2. Call a function that takes the user's email address or phone number as input and creates a secure request data envelope. See [Encrypting requests](../getting-started/gs-encryption-decryption.md#encrypting-requests). The following example uses an email address: ```java - EnvelopeV2 envelope = publisherUid2Helper.createEnvelopeForTokenGenerateRequest(TokenGenerateInput.fromEmail("user@example.com").doNotGenerateTokensForOptedOut()); + EnvelopeV2 envelope = publisherUid2Helper.createEnvelopeForTokenGenerateRequest(TokenGenerateInput.fromEmail("user@example.com")); ``` 3. Using an HTTP client library of your choice, post this envelope to the [POST token/generate](../endpoints/post-token-generate.md) endpoint, including headers and body: 1. Headers: Depending on your HTTP library, this might look something like the following: @@ -235,9 +233,6 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve :::important Always apply `doNotGenerateTokensForOptedOut()`. This applies a parameter similar to setting `optout_check=1` in the call to the POST /token/generate endpoint (see [Unencrypted JSON Body Parameters](../endpoints/post-token-generate.md#unencrypted-json-body-parameters)). - ::: - 4. If the HTTP response status code is _not_ 200, see [Response Status Codes](../endpoints/post-token-generate.md#response-status-codes) to determine next steps. Otherwise, convert the UID2 identity response content into a `TokenGenerateResponse` object: diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index 49a297fb7..bf2edf03b 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -158,7 +158,7 @@ Decryption response codes, and their meanings, are shown in the following table. 2. Call a function that takes the user's email address or phone number as input and generates a `TokenGenerateResponse` object. The following example uses an email address: ```py - token_generate_response = client.generate_token(TokenGenerateInput.from_email("user@example.com").do_not_generate_tokens_for_opted_out()) + token_generate_response = client.generate_token(TokenGenerateInput.from_email("user@example.com")) ``` @@ -230,8 +230,10 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve `.putHeader("Authorization", "Bearer " + UID2_API_KEY)` `.putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHttpHeader())` 2. Body: `envelope.getEnvelope()` - :::important - diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index bf2edf03b..5273afbdc 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -163,12 +163,10 @@ Decryption response codes, and their meanings, are shown in the following table. - `do_not_generate_tokens_for_opted_out()` applies `optout_check=1` in the [POST /token/generate](../endpoints/post-token-generate.md) call. Without this, `optout_check` is omitted to maintain backwards compatibility. - ### Client-Server Integration If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: From 45e8d27c4636b164a3dd1b7536bb010051ee2087 Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Tue, 10 Feb 2026 16:01:00 +1100 Subject: [PATCH 03/10] Add removal of optout_check to doc updates --- docs/ref-info/updates-doc.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/ref-info/updates-doc.md b/docs/ref-info/updates-doc.md index 6ace08c5a..6870c8874 100644 --- a/docs/ref-info/updates-doc.md +++ b/docs/ref-info/updates-doc.md @@ -20,6 +20,28 @@ Check out the latest updates to our UID2 documentation resources. Use the Tags toolbar to view a subset of documentation updates. ::: +## Q1 2026 + +The following documents were released in the first quarter of 2026. + + + +### Removal of optout_check Parameter + +February 10, 2026 + +The `optout_check` parameter has been removed from the [POST /token/generate](../endpoints/post-token-generate.md) 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. + + + + + ## Q4 2025 The following documents were released in this quarter. From 7ee34e0e602957c3c9cdad4576817ee8292321f2 Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Thu, 12 Feb 2026 10:44:51 +1100 Subject: [PATCH 04/10] remove comments indicating EUID diff --- docs/sdks/sdk-ref-java.md | 6 ------ docs/sdks/sdk-ref-python.md | 6 ------ 2 files changed, 12 deletions(-) diff --git a/docs/sdks/sdk-ref-java.md b/docs/sdks/sdk-ref-java.md index ebf5b3850..2a35ed32b 100644 --- a/docs/sdks/sdk-ref-java.md +++ b/docs/sdks/sdk-ref-java.md @@ -150,12 +150,6 @@ If you're using the SDK's HTTP implementation, follow these steps. TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail("user@example.com")); ``` - - - - #### Basic Usage, Client-Server Integration If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index 5273afbdc..e2fb5ee2f 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -161,12 +161,6 @@ Decryption response codes, and their meanings, are shown in the following table. token_generate_response = client.generate_token(TokenGenerateInput.from_email("user@example.com")) ``` - - - - ### Client-Server Integration If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: From 1e04d4c0929534bedfbaa59064241ab2047a2b2c Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Fri, 13 Feb 2026 11:11:18 +1100 Subject: [PATCH 05/10] remove more comments indicating EUID diff --- docs/endpoints/post-token-generate.md | 3 --- docs/sdks/sdk-ref-java.md | 6 ------ 2 files changed, 9 deletions(-) diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index 51fab452c..31e5c1ed9 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -15,9 +15,6 @@ Requests a UID2 token generated from a user's directly identifying information (DII) to UID2 tokens for targeted advertising. - ::: --> - - - 4. If the HTTP response status code is _not_ 200, see [Response Status Codes](../endpoints/post-token-generate.md#response-status-codes) to determine next steps. Otherwise, convert the UID2 identity response content into a `TokenGenerateResponse` object: ```java From bd6319bb38c4addf12960ae5a936708a885f89ae Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Fri, 13 Feb 2026 11:14:49 +1100 Subject: [PATCH 06/10] add Opt-Out tag to doc update --- docs/ref-info/updates-doc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref-info/updates-doc.md b/docs/ref-info/updates-doc.md index 6870c8874..4691e371b 100644 --- a/docs/ref-info/updates-doc.md +++ b/docs/ref-info/updates-doc.md @@ -24,7 +24,7 @@ Use the Tags toolbar to view a subset of documentation updates. The following documents were released in the first quarter of 2026. - + ### Removal of optout_check Parameter From aabb5c1c4966651891dc6d13810f767286ce346c Mon Sep 17 00:00:00 2001 From: swibi-ttd Date: Fri, 13 Feb 2026 13:20:11 +1100 Subject: [PATCH 07/10] Update docs/sdks/sdk-ref-python.md Reinstate uid2_euid_diff comment Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com> --- docs/sdks/sdk-ref-python.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index e2fb5ee2f..d34eb6198 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -160,7 +160,7 @@ Decryption response codes, and their meanings, are shown in the following table. ```py token_generate_response = client.generate_token(TokenGenerateInput.from_email("user@example.com")) ``` - + ### Client-Server Integration If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: From b16d9751f76b5279ab5c8a4b2af9ea61f9ba097a Mon Sep 17 00:00:00 2001 From: swibi-ttd Date: Fri, 13 Feb 2026 13:21:00 +1100 Subject: [PATCH 08/10] Update docs/endpoints/post-token-generate.md Reinstate uid2_euid_diff comment Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com> --- docs/endpoints/post-token-generate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index 31e5c1ed9..f9e571295 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -14,7 +14,7 @@ import SnptIdentityGenerateResponse from '../snippets/_snpt-example-identity-gen Requests a UID2 token generated from a user's DII (email address or phone number). If the DII is valid, and the user has not opted out of UID2, this operation returns a UID2 token and associated values. Used by: This endpoint is used mainly by publishers. - + Rather than calling this endpoint directly, you could use one of the SDKs to manage it for you. For a summary of options, see [SDKs: Summary](../sdks/summary-sdks.md). :::important From 62f099c2a0770c50c5334a94a07c1fdda43af8e2 Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Fri, 13 Feb 2026 13:23:18 +1100 Subject: [PATCH 09/10] add empty lines around comments --- docs/endpoints/post-token-generate.md | 2 ++ docs/sdks/sdk-ref-python.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index f9e571295..023d0d2d8 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -14,7 +14,9 @@ import SnptIdentityGenerateResponse from '../snippets/_snpt-example-identity-gen Requests a UID2 token generated from a user's DII (email address or phone number). If the DII is valid, and the user has not opted out of UID2, this operation returns a UID2 token and associated values. Used by: This endpoint is used mainly by publishers. + + Rather than calling this endpoint directly, you could use one of the SDKs to manage it for you. For a summary of options, see [SDKs: Summary](../sdks/summary-sdks.md). :::important diff --git a/docs/sdks/sdk-ref-python.md b/docs/sdks/sdk-ref-python.md index d34eb6198..421f0c335 100644 --- a/docs/sdks/sdk-ref-python.md +++ b/docs/sdks/sdk-ref-python.md @@ -160,7 +160,9 @@ Decryption response codes, and their meanings, are shown in the following table. ```py token_generate_response = client.generate_token(TokenGenerateInput.from_email("user@example.com")) ``` + + ### Client-Server Integration If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: From e0f38c8bffb05b8e535bd52b88c1f7cf4a2e8c70 Mon Sep 17 00:00:00 2001 From: sean wibisono Date: Fri, 13 Feb 2026 13:26:12 +1100 Subject: [PATCH 10/10] also reinstate uid2_euid_diff comments to java docs --- docs/sdks/sdk-ref-java.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/sdks/sdk-ref-java.md b/docs/sdks/sdk-ref-java.md index 30ac9c6fd..349ef83c6 100644 --- a/docs/sdks/sdk-ref-java.md +++ b/docs/sdks/sdk-ref-java.md @@ -150,6 +150,8 @@ If you're using the SDK's HTTP implementation, follow these steps. TokenGenerateResponse tokenGenerateResponse = publisherUid2Client.generateTokenResponse(TokenGenerateInput.fromEmail("user@example.com")); ``` + + #### Basic Usage, Client-Server Integration If you're using client-server integration (see [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), follow this step: @@ -225,6 +227,8 @@ If you're using server-side integration (see [Publisher Integration Guide, Serve `.putHeader("X-UID2-Client-Version", PublisherUid2Helper.getVersionHttpHeader())` 2. Body: `envelope.getEnvelope()` + + 4. If the HTTP response status code is _not_ 200, see [Response Status Codes](../endpoints/post-token-generate.md#response-status-codes) to determine next steps. Otherwise, convert the UID2 identity response content into a `TokenGenerateResponse` object: ```java