new ContactVerificationRequest()
Represents request to verify contact information
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
authenticateSession |
boolean |
<optional> |
false | Whether to authenticate the client's session upon verification |
clientOrigin |
string | Origin URL of client that requested contact verification (e.g. "https://example.com") | ||
code |
string |
<optional> |
Secure code generated to fulfill request | |
contact |
string | Contact identifier used to send request using method (e.g. "user@example.com") | ||
createNotificationRequests |
Array.<Object> |
<optional> |
Array of properties for notification requests to create related to user upon verification | |
createNotificationRequests[].event |
event | Event for new notification request | ||
createUser |
boolean |
<optional> |
false | Whether to create a user upon verification if one doesn't already exist with matching contact info |
method |
string | Method used to send request to contact (e.g. "email") | ||
verified |
boolean |
<optional> |
false | Whether document has been verified |