You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/endpoints/post-token-validate.md
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,16 +40,18 @@ The integration environment and the production environment require different <Li
40
40
41
41
### Unencrypted JSON Body Parameters
42
42
43
-
- Include only one of the following four valid options, as listed in the Body Parameter table: `email`, `email_hash`, `phone`, or `phone_hash`. For the parameter you choose to test with, use the exact value listed.
44
-
- Include the required body parameters as key-value pairs in the JSON body of a request when encrypting it.
43
+
Here are some key points about using this endpoint:
44
+
45
+
- Include only one of the following four valid options, as listed in the Body Parameter table: `email`, `email_hash`, `phone`, or `phone_hash`.
46
+
- Include the required body parameters as key-value pairs in the JSON body of the request when encrypting it.
45
47
46
48
| Body Parameter | Data Type | Attribute | Description |
47
49
| :--- | :--- | :--- | :--- |
48
-
|`token`| string | Required | The advertising token returned by the [POST /token/generate](post-token-generate.md) response.|
49
-
|`email`| string | Conditionally Required | The email address for token validation.<br/>The only valid value is: `[email protected]`. |
50
-
|`email_hash`| string | Conditionally Required | The [Base64-encoded SHA-256](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding) hash of the [normalized](../getting-started/gs-normalization-encoding.md#email-address-normalization) email address for token validation (`[email protected]`).<br/>The only valid value is: `ntI244ZRTXwAwpki6/M5cyBYW7h/Wq576lnN3l9+W/c=`. |
51
-
|`phone`| string | Conditionally Required | The [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number for which to generate tokens.<br/>The only valid value is: `+12345678901`. |
52
-
|`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.<br/>The only valid value is: `EObwtHBUqDNZR33LNSMdtt5cafsYFuGmuY4ZLenlue4=`. |
50
+
| `token` | string | Required | The advertising token returned by the [POST /token/generate](post-token-generate.md) response.<br/>You can only validate an advertising token that has been generated with your own credentials.
51
+
|`email`| string | Conditionally Required | The email address for token validation. You can use any valid email value, normalized or not. |
52
+
|`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. |
53
+
|`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). |
54
+
|`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. |
53
55
54
56
### Request Examples
55
57
@@ -109,9 +111,11 @@ A successful decrypted response returns a boolean value that indicates the valid
109
111
110
112
## Body Response Properties
111
113
114
+
The following table provides information about the response body.
115
+
112
116
| Property | Data Type | Description |
113
117
| :--- | :--- | :--- |
114
-
|`body`| boolean | A value of `true` indicates that the email address, phone number, or the respective hash specified in the request is the same as the one used to generate the advertising token.<br/>A value of `false` indicates any of the following:<br/>- The request included an invalid advertising token.<br/>- The email address, phone number, or the respective hash specified in the request is not one of the four valid values specified in the [Unencrypted JSON Body Parameters](#unencrypted-json-body-parameters) table. |
118
+
|`body`| boolean | A value of `true` indicates that the email address, phone number, or the respective hash specified in the request is the same as the one used to generate the advertising token.<br/>A value of `false` indicates that the email address, phone number, or the respective hash specified in the request is not the same as the one used to generated the advertising token. |
115
119
116
120
### Response Status Codes
117
121
@@ -120,7 +124,7 @@ The following table lists the `status` property values and their HTTP status cod
120
124
| Status | HTTP Status Code | Description |
121
125
| :--- | :--- | :--- |
122
126
|`success`| 200 | The request was successful. The response will be encrypted. |
123
-
|`client_error`| 400 | The request had missing or invalid parameters.|
127
+
|`client_error`| 400 | The request had missing or invalid parameters.|
124
128
|`unauthorized`| 401 | The request did not include a bearer token, included an invalid bearer token, or included a bearer token unauthorized to perform the requested operation. |
125
129
126
130
If the `status` value is anything other than `success`, the `message` field provides additional information about the issue.
@@ -129,8 +133,7 @@ If the `status` value is anything other than `success`, the `message` field prov
129
133
130
134
You can use this endpoint to test whether the <Linkhref="../ref-info/glossary-uid#gl-dii">DII</Link> that you are sending through [POST /token/generate](../endpoints/post-token-generate.md) is valid. Follow these steps.
131
135
132
-
1. Depending on whether the DII is a hashed or unhashed email address or phone number, send a [POST /token/generate](../endpoints/post-token-generate.md) request using one of the four valid options listed in the [Unencrypted JSON Body Parameters](#unencrypted-json-body-parameters) table—`email`, `email_hash`, `phone`, or `phone_hash`—with the corresponding value as listed in the table.
133
-
136
+
1. Send a [POST /token/generate](../endpoints/post-token-generate.md) request using an `email`, `email_hash`, `phone` or `phone_hash` to generate an advertising token to validate.
134
137
2. Store the returned `advertising_token` value for use in the next step.
135
138
3. Send a `POST /token/validate` request using the `email`, `email_hash`, `phone`, or `phone_hash` value that you sent in Step 1, with the `advertising_token` that you saved in Step 2 as the `token` property value.
136
139
4. Check the response to the `POST /token/validate` request. The results indicate the success of your process, as follows:
0 commit comments