Skip to main content
POST
SDK

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