Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
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/verify/verificationChecks

Request body

verificationIdstring

ID of the verification to be checked. One of verificationId or to is required.

tostring

The recipient's phone number or email address. One of verificationId or to is required.

codestring

The verification to be checked.

Example request

{
  "verificationId": "vid",
  "to": "+16315551111",
  "code": "123456"
}

Response

Successfully processed the verification check.

idstring required

ID of this verification check.

validboolean required

Whether the verification code is valid for this check.

status'pending' | 'approved' | 'blocked' | 'expired' | 'undelivered'

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. A pending verification status changes to approved when you call the 'Check a verification' API and receive a response with the valid parameter is true. 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.
tostring

The recipient's phone number in E.164 format or email address.

channel'sms' | 'voice' | 'email_code' | 'whatsapp'

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.

Example response

{
  "id": "vc8f92c20",
  "to": "+16315551111",
  "channel": "sms"
}