CEcequens

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.

post/v1/destinations/verification

Request

  • Base URL
    https://apis.cequens.com/mfa
  • URL
    https://apis.cequens.com/mfa/v1/destinations/verification
  • Auth
    API key in header Authorization

Request body

numberstring required

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.

senderstring

string that defines the sender name of the verification passcode SMS. The default value of this parameter is “Cequens”.

codeLengthstring

integer that defines the length of the passCode between 4 and 6, . The default value of this parameter is 6.

codeExpstring

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.

languagestring

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"

Response

200

replyCodeinteger
replyMessagestring
requestIdstring
clientRequestIdinteger
requestTimestring

Example response

{
  "replyMessage": "[Request handled successfully] Passcode sent successfully.",
  "requestId": "8420b820-bfff-11e4-9d9a-dfdc18052754",
  "requestTime": "2016-01-23T05:15:00.374Z",
  "data": {
    "checkCode": "f23869c0aac711e89250617d6c45aa6c1f507207726cd2f1fe3d2bdd822e43d7"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.