Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/endpoints/post-identity-map-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/endpoints/post-identity-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/endpoints/post-token-generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/endpoints/post-token-validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ Here are some key points about using this endpoint:
| :--- | :--- | :--- | :--- |
| `token` | string | Required | The advertising token returned by the [POST&nbsp;/token/generate](post-token-generate.md) response.<br/>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

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/gs-normalization-encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
- 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/).
2 changes: 1 addition & 1 deletion docs/guides/integration-javascript-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-mobile-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ Task<Void, Never> {

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.

</TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/ref-info/ref-how-uid-is-created.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ For an example with sample values, see [Creating a UID2 token&#8212;example](#cr
<td>2</td>
<td>Apply <Link href="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> hashing to the normalized email address.</td>
<td>Publisher or UID2 Operator</td>
<td>[Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding)<br/>[Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding)</td>
<td>[Email address hashing and encoding](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding)<br/>[Phone number hashing and encoding](../getting-started/gs-normalization-encoding.md#phone-number-hashing-and-encoding)</td>
</tr>
<tr>
<td>3</td>
<td>Apply Base64 encoding to the SHA-256 hash.</td>
<td>Publisher or UID2 Operator</td>
<td>[Email address hash encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding)<br/>[Phone number hash encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding)</td>
<td>[Email address hashing and encoding](../getting-started/gs-normalization-encoding.md#email-address-hashing-and-encoding)<br/>[Phone number hashing and encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding)</td>
</tr>
<tr>
<td>4</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ If you're using a UID2 SDK, or other integration solution such as the Prebid.js
<tr>
<td>Email</td>
<td>Must be one of the following:<ul><li>Raw email</li><li>Normalized email</li><li>Normalized, then hashed, then base64-encoded</li></ul></td>
<td>[Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization)<br/>[Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hash-encoding)</td>
<td>[Email address normalization](../getting-started/gs-normalization-encoding#email-address-normalization)<br/>[Email address hash encoding](../getting-started/gs-normalization-encoding#email-address-hashing-and-encoding)</td>
</tr>
<tr>
<td>Phone Number</td>
<td>Must be one of the following:<ul><li>Normalized raw phone number, including country code</li><li>Normalized, then hashed, then base64-encoded</li></ul></td>
<td>[Phone number normalization](../getting-started/gs-normalization-encoding#email-address-normalization)<br/>[Phone number hashing and encoding](../getting-started/gs-normalization-encoding#phone-number-hashing-and-encoding)</td>
<td>[Phone number normalization](../getting-started/gs-normalization-encoding#phone-number-normalization)<br/>[Phone number hashing and encoding](../getting-started/gs-normalization-encoding#phone-number-hashing-and-encoding)</td>
</tr>
</tbody>
</table>
Loading