API Reference
Help Center
Start typing to search…

Start a verification

post
https://api.ycloud.com/v2/verify/verifications

Starts a verification by sending an SMS, voice, or email message to the recipient. This verification is charged once the message is sent successfully.

Body Params

Verification request that needs to be sent.

string
enum
required

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.
Allowed:
string
required

The recipient's phone number or email address depending on channel.

  • Phone number: In E.164 format. Applicable when channel is sms or voice.
  • Email address: For example, [email protected]. Applicable when channel is email_code.
string
length between 4 and 8

Verification code to be sent. This field is optional. If not provided, we will automatically generate a code.

string

Sender ID to be used.

string

This parameter is only required for Chinese mainland SMS messages. You must specify an approved signature such as Brand. It will be added to the beginning of SMS body and wrapped with 【】, e.g. 【Brand】Your verification code is 123456.

string

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

string

A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems. If present, this value will also be attached to the externalId of message objects.

Response

Updated 11 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago