{
"id": "ve6j7n8i",
"status": "pending",
"to": "+16315551111",
"channel": "sms",
"sendTime": "2022-06-01T12:00:00.000Z",
"totalPrice": 0.0085,
"currency": "USD",
"smsFallbackEnabled": true,
"smsFallback": {
"supported": true,
"unsupportedReason": "SENDER_ID_UNAVAILABLE",
"unsupportedDetail": "This Sender ID is not registered."
},
"externalId": "<string>"
}Start a verification
Starts a verification by sending an SMS, voice, or email message to the recipient. This verification is charged once the message is sent successfully.
{
"id": "ve6j7n8i",
"status": "pending",
"to": "+16315551111",
"channel": "sms",
"sendTime": "2022-06-01T12:00:00.000Z",
"totalPrice": 0.0085,
"currency": "USD",
"smsFallbackEnabled": true,
"smsFallback": {
"supported": true,
"unsupportedReason": "SENDER_ID_UNAVAILABLE",
"unsupportedDetail": "This Sender ID is not registered."
},
"externalId": "<string>"
}Body
Verification request that needs to be sent.
The recipient's phone number or email address depending on channel.
- Phone number: In E.164 format. Applicable when
channelissmsorvoice. - Email address: For example,
tom@example.com. Applicable whenchannelisemail_code.
"+16315551111"
Sender ID to be used.
"Brand"
ISO 639 Language Code. If not specified, language will be set as en by default. Notably, in certain countries or regions, language will be automatically set as the local language due to the regional restrictions.
Applicable languages:
ar: Arabic
de: German
en: English
es: Spanish
fr: French
id: Indonesian
it: Italian
pt_BR: Portuguese
ru: Russian
tr: Turkish
vi: Vietnamese
zh_CN: Simplified Chinese
zh_HK: Traditional Chinese
"en"
Response
The request is successfully accepted.
Status of the verification.
pending: The verification message (SMS, Voice, etc.) is sent, waiting to be checked. This happens when you call the 'Start a verification' API successfully.approved: The verification has been successfully checked. Apendingverification status changes toapprovedwhen you call the 'Check a verification' API and receive a response with thevalidparameter istrue. An approved verification cannot be checked anymore.blocked: The verification is blocked by user-defined rules such as denylist, and geographical permission restrictions. A blocked verification cannot be checked.expired: The verification has expired and cannot be checked anymore.undelivered: Our system has received a delivery receipt indicating that the verification message was not delivered. An undelivered verification cannot be checked anymore.
pending, approved, blocked, expired, undelivered Supports several independent channels for verification:
sms: Sends an SMS message with a verification code.voice: Makes a voice call with a verification code.email_code: Sends an email with a verification code.whatsapp: Sends a WhatsApp message with a verification code.
sms, voice, email_code, whatsapp "sms"
The time at which this verification was sent, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.
"2022-06-01T12:00:00.000Z"
Price currency. ISO 4217 currency code.
"USD"

