Skip to main content
POST
/
verify
/
v1
/
start
Start a verification
curl --request POST \
  --url https://api.voyant.travel/verify/v1/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+14155551234",
  "locale": "en"
}
'
{
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "serviceId": "<string>",
    "toValue": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "providerStatus": "<string>",
    "errorMessage": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
​
to
string
required

Destination (phone number or email, per channel).

Required string length: 3 - 320
Example:

"+14155551234"

​
channel
enum<string>

Defaults to sms.

Available options:
sms,
call,
email,
whatsapp
​
locale
string
Maximum string length: 16
Example:

"en"

Response

Verification started

​
data
object
required