CEQUENS API
Developer HubCEQUENS Console
HomeAPI ReferenceSDKsContext Plugin
M F A

Send OTP Verification

POST
/mfa/v2/verifications

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.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT access token returned by Signing In (POST /auth/v1/tokens/).

In: header

Header Parameters

Content-Type*string
Default"application/json; charset=utf-8"

Request Body

application/json

channel*string

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

recipientIdentifier*string

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

templateCode?string

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

otpCodeLength?string

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

otpCodeExpiry?string

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

wabTemplateName?string

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

wabTemplateLanguage?string

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/mfa/v2/verifications" \  -H "Content-Type: application/json; charset=utf-8" \  -H "Content-Type: application/json" \  -d '{    "channel": "SMS",    "recipientIdentifier": "+20100xxxxxx",    "templateCode": "7226942d-23dc-4962-ba37-fd12d12b2448",    "otpCodeLength": 10,    "otpCodeExpiry": 9  }'
"{ \n \"status\":201,\n \"replyMessage\": \"[Request handled successfully] Passcode Sent\",\n \"requestId\": \"32a6d7340-405e-11ea-9ffd-47489e6dbc08\",\n \"requestTime\": \"2020-01-26T19:06:30.912\",\n \"data\": {\n    \"checkCode\": \"NUAGYJBQMAYDSXAD\"\n  }\n}"

Track OTP Verification GET

After your user’s phone number or email address is verified, you can check on the OTP you have received from the user to know its status, whether it is expired, validated, or invalid. Track OTP API takes the check code returned from "Send OTP" API, and returns all checks done using Check OTP code API.

Check OTP Verification PUT

Validates the received OTP from your user with the check code returned from the Send OTP code API. If the codes match, then the OTP is validated, and the recipient’s phone number or email address is successfully verified.