From d4c0dc46f700f90f432d394d1553205d65eab996 Mon Sep 17 00:00:00 2001 From: "v-kristin.vancuyck" Date: Wed, 30 Sep 2026 12:23:20 -0700 Subject: [PATCH] APIDOCS-4292: Update email and phone number docs --- docs/endpoints/post-identity-map-v2.md | 4 ++-- docs/endpoints/post-identity-map.md | 4 ++-- docs/endpoints/post-token-generate.md | 4 ++-- docs/endpoints/post-token-validate.md | 4 ++-- docs/getting-started/gs-normalization-encoding.md | 2 +- docs/guides/integration-javascript-client-side.md | 2 +- docs/guides/integration-mobile-client-side.md | 2 +- docs/ref-info/ref-how-uid-is-created.md | 4 ++-- .../ref-preparing-emails-and-phone-numbers-for-processing.md | 4 ++-- 9 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/endpoints/post-identity-map-v2.md b/docs/endpoints/post-identity-map-v2.md index ec4258684..369f444a4 100644 --- a/docs/endpoints/post-identity-map-v2.md +++ b/docs/endpoints/post-identity-map-v2.md @@ -65,9 +65,9 @@ You must include only **one** of the following four conditional parameters as a | Body parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `email` | string array | Conditionally Required | The list of email addresses to be mapped. | -| `email_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email addresses to be mapped. | +| `email_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email addresses to be mapped. | | `phone` | string array | Conditionally Required | The list of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | -| `phone_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | +| `phone_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | ### Request examples diff --git a/docs/endpoints/post-identity-map.md b/docs/endpoints/post-identity-map.md index 6e4797550..75bfee20e 100644 --- a/docs/endpoints/post-identity-map.md +++ b/docs/endpoints/post-identity-map.md @@ -65,9 +65,9 @@ Include one or more of the following four parameters as key-value pairs in the J | Body parameter | Data type | Attribute | Description | |:---------------|:----------------------------|:-----------------------| :--- | | `email` | string array | Conditionally Required | The list of email addresses to be mapped. | -| `email_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email addresses to be mapped. | +| `email_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email addresses to be mapped. | | `phone` | string array | Conditionally Required | The list of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | -| `phone_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | +| `phone_hash` | string array | Conditionally Required | The list of [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding) hashes of [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone numbers to be mapped. | ### Request examples diff --git a/docs/endpoints/post-token-generate.md b/docs/endpoints/post-token-generate.md index 05ae62a36..21fde9437 100644 --- a/docs/endpoints/post-token-generate.md +++ b/docs/endpoints/post-token-generate.md @@ -47,9 +47,9 @@ You must include only **one** of the following four conditional parameters as ke | Body parameter | Data type | Attribute | Description | | :--- | :--- | :--- | :--- | | `email` | string | Conditionally Required | The email address for which to generate tokens. | -| `email_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hash of a [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email address. | +| `email_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding) hash of a [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email address. | | `phone` | string | Conditionally Required | The [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number for which to generate tokens. | -| `phone_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hash of a [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number. | +| `phone_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding) hash of a [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number. | ### Request examples diff --git a/docs/endpoints/post-token-validate.md b/docs/endpoints/post-token-validate.md index 556ea017c..c69c1294f 100644 --- a/docs/endpoints/post-token-validate.md +++ b/docs/endpoints/post-token-validate.md @@ -48,9 +48,9 @@ Here are some key points about using this endpoint: | :--- | :--- | :--- | :--- | | `token` | string | Required | The advertising token returned by the [POST /token/generate](post-token-generate.md) response.
You can only validate an advertising token that has been generated with your own credentials. | `email` | string | Conditionally Required | The email address for token validation. You can use any valid email value, normalized or not. | -| `email_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hash of any valid [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email address. | +| `email_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding) hash of any valid [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email address. | | `phone` | string | Conditionally Required | The phone number for token validation. You can use any valid phone number value, but it must be [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization). | -| `phone_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) hash of any valid [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number. | +| `phone_hash` | string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding) hash of any valid [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number. | ### Request examples diff --git a/docs/getting-started/gs-normalization-encoding.md b/docs/getting-started/gs-normalization-encoding.md index 642d09aad..69a1fa0d4 100644 --- a/docs/getting-started/gs-normalization-encoding.md +++ b/docs/getting-started/gs-normalization-encoding.md @@ -213,4 +213,4 @@ If you're having trouble or getting errors, or if you just want to be sure you'r - **Use the Base64-encoded value**: The process includes normalizing, then hashing, then Base64-encoding the bytes of the hash value. When generating UID2s, the input is the Base64-encoded value. Make sure you're using this 44-character string value. -- You might see the following error message: "The hashing value must be 44 characters." In this scenario, there is an error with the hashing function you're using. Use the hex to Base64 encoding of the SHA-256 hash. For details, see [Email address hashing and encoding](#email-address-hash-encoding) or [Phone number hashing and encoding](#phone-number-hash-encoding). To cross-check, test using the [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/). \ No newline at end of file +- You might see the following error message: "The hashing value must be 44 characters." In this scenario, there is an error with the hashing function you're using. Use the hex to Base64 encoding of the SHA-256 hash. For details, see [Email address hashing and encoding](#email-address-hashing-and-encoding) or [Phone number hashing and encoding](#phone-number-hashing-and-encoding). To cross-check, test using the [UID2 hashing tool](https://hashing-tool.samples.uidapi.com/). \ No newline at end of file diff --git a/docs/guides/integration-javascript-client-side.md b/docs/guides/integration-javascript-client-side.md index 9e355b2ce..e01021af5 100644 --- a/docs/guides/integration-javascript-client-side.md +++ b/docs/guides/integration-javascript-client-side.md @@ -177,7 +177,7 @@ To configure the SDK, call one of the following methods, with an object containi * `__uid2.setIdentityFromPhoneHash` :::important -For `__uid2.setIdentityFromEmailHash` or `__uid2.setIdentityFromPhoneHash`, the `emailHash` or `PhoneHash` argument must be the Base64-encoded value. For details, see [Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) and [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding). +For `__uid2.setIdentityFromEmailHash` or `__uid2.setIdentityFromPhoneHash`, the `emailHash` or `PhoneHash` argument must be the Base64-encoded value. For details, see [Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding) and [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding). ::: The following sections include coding examples for each scenario. diff --git a/docs/guides/integration-mobile-client-side.md b/docs/guides/integration-mobile-client-side.md index 2a5d1e77e..2b1ad749f 100644 --- a/docs/guides/integration-mobile-client-side.md +++ b/docs/guides/integration-mobile-client-side.md @@ -562,7 +562,7 @@ Task { In this scenario: -- The publisher is responsible for normalizing and hashing the phone number. For details, see [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding). +- The publisher is responsible for normalizing and hashing the phone number. For details, see [Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding). - The UID2 mobile SDK encrypts the hashed DII before sending it to the UID2 service. diff --git a/docs/ref-info/ref-how-uid-is-created.md b/docs/ref-info/ref-how-uid-is-created.md index 49519ee5d..0852be85b 100644 --- a/docs/ref-info/ref-how-uid-is-created.md +++ b/docs/ref-info/ref-how-uid-is-created.md @@ -49,13 +49,13 @@ For an example with sample values, see [Creating a UID2 token—example](#cr 2 Apply SHA-256 hashing to the normalized email address. Publisher or UID2 Operator - [Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding)
[Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) + [Email address hashing and encoding](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding)
[Phone number hashing and encoding](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding) 3 Apply Base64 encoding to the SHA-256 hash. Publisher or UID2 Operator - [Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding)
[Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) + [Email address hashing and encoding](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding)
[Phone number hashing and encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding) 4 diff --git a/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md b/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md index 56a1ca641..cc5661cf0 100644 --- a/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md +++ b/docs/ref-info/ref-preparing-emails-and-phone-numbers-for-processing.md @@ -43,12 +43,12 @@ If you're using a UID2 SDK, or other integration solution such as the Prebid.js Email Must be one of the following: - [Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding) + [Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hashing-and-encoding) Phone Number Must be one of the following: - [Phone number normalization](../getting-started/gs-normalization-encoding#email-address-normalization)
[Phone number hashing and encoding](../getting-started/gs-normalization-encoding#phone-number-hashing-and-encoding) + [Phone number normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)
[Phone number hashing and encoding](../getting-started/gs-normalization-encoding#phone-number-hashing-and-encoding)