CEcequens

Send OTP Verification

Send an OTP code to the recipient’s phone number or email address to verify his identity, and that the given phone number or email is valid. OTP is sent through supported Channels.

The following channels are supported : SMS ,Voice, Email and Whatsapp.

post/v2/verifications

Request

  • Base URL
    https://apis.cequens.com/mfa
  • URL
    https://apis.cequens.com/mfa/v2/verifications
  • Auth
    API key in header Authorization

Headers

Content-Typestring required

Request body

channelstring required

Channel name which correspond to supported channels ; "SMS" or "Email" or "Whatsapp" or "Voice"

recipientIdentifierstring required

Recipient email address - for “Email” channel OR mobile number – for “SMS”| "Voice" | "Whatsapp" channels

templateCodestring

Template code to use when sending OTP code. If not provided , API uses the value defined in account configuration

otpCodeLengthstring

OTP code length with range 4-10 . If not provided , API uses the value defined in account configuration

otpCodeExpirystring

Time in minutes after which the OTP code expires ; range 3-10 mins. If not provided , API uses the value defined in account configuration

wabTemplateNamestring

Whatsapp template name as defined in Whatsapp manager prefixed with "verify_" (Mandatory in case of Whatsapp channel)

wabTemplateLanguagestring

The language of Whatsapp template as defined in Whatsapp manager (Mandatory in case of Whatsapp)

Response

201

statusinteger
replyMessagestring
requestIdstring
requestTimestring

Example response

{
  "status": 201,
  "replyMessage": "[Request handled successfully] Passcode Sent",
  "requestId": "32a6d7340-405e-11ea-9ffd-47489e6dbc08",
  "requestTime": "2020-01-26T19:06:30.912",
  "data": {
    "checkCode": "NUAGYJBQMAYDSXAD"
  }
}

Changes

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