Phone Number / Email Verification

This endpoint is used to verify a phone number or email address by sending One Time Password (OTP) to the provided email address or phone number.

API Request Body

{  
"verificationId": "12345abc-67de-89fg-01hi-234567",  
"channel": "email",  
"to": "[email protected]",  
"subject": "OTP Request",  
"message": "Your OTP is [code]",  
"codePlaceholder": [ "code" ],  
"codeExpirationTime": 60  
}

OR

{  
"verificationId": "12345abc-67de-89fg-01hi-234567",  
"channel": "phone",  
"to": "+2347035592939",  
"message": "Your OTP is [code]",  
"codePlaceholder": [ "code" ],  
"codeExpirationTime": 60  
}
FieldDescriptionType
VerificationIdThe verification id from the initialized verificationstring
channelThe medium to use for the verificationstring
toThe recipient’s email address or phone numberstring
subjectThe email subjectstring
messageThe OTP message with the code placeholderstring
codePlaceholderThe code placeholder in the message that will be replaced by the OTP codestring
codeExpirationTimeAn optional code expiration time in secondsnumber

API Response

{  
  "message": "Ok",  
  "data": {  
    "to": "[email protected]",  
    "channel": "email",  
    "status": "Sent"  
  }  
}