Requesting Verifications
Send an SMS with a verification passcode of six digits to your user’s phone number, so as to verify your user identity, and that the given phone number is valid.
Authorization
bearerAuth JWT access token returned by Signing In (POST /auth/v1/tokens/).
In: header
Request Body
application/json
string to specify the phone number that you want to verify. To submit a valid phone number, you must type a complete phone number with the country and network prefixes.
string that defines the sender name of the verification passcode SMS. The default value of this parameter is “Cequens”.
"Cequens"integer that defines the length of the passCode between 4 and 6, . The default value of this parameter is 6.
"6"integer that defines the time duration in minutes after which the verification passcode will expire. The default value of this parameter is 3. The range values between 1 to 10 minutes.
"3"string that define the language of the sent SMS , the provided languages are English "en" and Arabic "ar" and the default value is English "en"
"en"Response Body
application/json
application/json
curl -X POST "https://example.com/mfa/v1/destinations/verification" \ -H "Content-Type: application/json" \ -d '{ "number": "string" }'"{\n \"replyCode\": 0,\n \"replyMessage\": \"[Request handled successfully] Passcode sent successfully.\",\n \"requestId\": \"8420b820-bfff-11e4-9d9a-dfdc18052754\",\n \"clientRequestId\": 0,\n \"requestTime\": \"2016-01-23T05:15:00.374Z\",\n \"data\":\n {\n \"checkCode\": \"f23869c0aac711e89250617d6c45aa6c1f507207726cd2f1fe3d2bdd822e43d7\"\n }\n}"Tracking Verification Request GET
After your user’s phone number is verified, you can check on the passcode you have received from the user to know its status, whether it is expired, validated, or invalid. Get Passcode Status API takes the check code returned from the Verification : Send Message API, and returns the status of the related passcode.
Checking Verification Request PUT
Compares the received passcode from your user with the check code returned from the Verify Phone Number API. If the codes match, then the passcode is validated, and the user’s phone number is successfully verified.