Skip to content

Commit e91dbd1

Browse files
committed
minor updates
1 parent 9c55516 commit e91dbd1

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/endpoints/post-token-validate.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,18 @@ The integration environment and the production environment require different <Li
4040

4141
### Unencrypted JSON Body Parameters
4242

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.
4547

4648
| Body Parameter | Data Type | Attribute | Description |
4749
| :--- | :--- | :--- | :--- |
48-
| `token` | string | Required | The advertising token returned by the [POST&nbsp;/token/generate](post-token-generate.md) response.<br/>You can only validate advertising tokens that have been generated with your own credentials. |
49-
| `email` | string | Conditionally Required | The email address for token validation. |
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. |
51-
| `phone` | string | Conditionally Required | The [normalized](../getting-started/gs-normalization-encoding.md#phone-number-normalization) phone number for which to generate tokens. |
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. |
50+
| `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.
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 which to generate tokens. 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. |
5355

5456
### Request Examples
5557

@@ -109,9 +111,11 @@ A successful decrypted response returns a boolean value that indicates the valid
109111

110112
## Body Response Properties
111113

114+
The following table provides information about the response body.
115+
112116
| Property | Data Type | Description |
113117
| :--- | :--- | :--- |
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/><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. |
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. |
115119

116120
### Response Status Codes
117121

0 commit comments

Comments
 (0)