Skip to content

Commit

Permalink
Merge pull request #369 from IABTechLab/ian-UID2-2286-remove-optout_c…
Browse files Browse the repository at this point in the history
…heck-from-identity-map

remove optout_check references from identity map documentation
  • Loading branch information
Ian-Nara authored Dec 5, 2023
2 parents 4a30a58 + 4bd348e commit 94f1934
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions docs/endpoints/post-identity-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,14 @@ Here's what you need to know:
### Unencrypted JSON Body Parameters

>IMPORTANT: You must include only **one** of the following four conditional parameters, plus the required `optout_check` parameter with a value of `1`, as key-value pairs in the JSON body of the request when encrypting it.
>IMPORTANT: You must include only **one** of the following four conditional parameters as a key-value pair in the JSON body of the request when encrypting it.
| 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. |
| `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. |
| `optout_check` | integer | Required | Checks whether the user has opted out. Include this parameter with a value of `1`.|

### Request Examples

Expand All @@ -55,42 +54,38 @@ The following are unencrypted JSON request body examples for each parameter, one
"email":[
"[email protected]",
"[email protected]"
],
"optout_check":1
]
}
```
```json
{
"email_hash":[
"eVvLS/Vg+YZ6+z3i0NOpSXYyQAfEXqCZ7BTpAjFUBUc=",
"tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
],
"optout_check":1
]
}
```
```json
{
"phone":[
"+1111111111",
"+2222222222"
],
"optout_check":1
]
}
```
```json
{
"phone_hash":[
"eVvLS/Vg+YZ6+z3i0NOpSXYyQAfEXqCZ7BTpAjFUBUc=",
"tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ="
],
"optout_check":1
]
}
```

Here's an encrypted identity mapping request example for a phone number:

```sh
echo '{"phone": ["+1111111111", "+2222222222"],"optout_check":1}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
echo '{"phone": ["+1111111111", "+2222222222"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk= DELPabG/hsJsZk4Xm9Xr10Wb8qoKarg4ochUdY9e+Ow=
```

For details and Python script examples, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md).
Expand Down

0 comments on commit 94f1934

Please sign in to comment.