{
"id": "vc8f92c20",
"valid": false,
"status": "pending",
"to": "+16315551111",
"channel": "sms"
}Verify
Check a verification
Checks a verification with a phone number, an email address, or a verification ID.
A pending verification status changes to approved once you receive a response with the valid parameter is true. An approved verification cannot be checked anymore.
POST
https://api.ycloud.com/v2
/
verify
/
verificationChecks
{
"id": "vc8f92c20",
"valid": false,
"status": "pending",
"to": "+16315551111",
"channel": "sms"
}Authorizations
Body
application/json
Response
200 - application/json
Successfully processed the verification check.
ID of this verification check.
Example:
"vc8f92c20"
Whether the verification code is valid for this check.
Example:
false
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.
Available options:
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.
Available options:
sms, voice, email_code, whatsapp Example:
"sms"