CEQUENS API
Developer HubCEQUENS Console
HomeAPI ReferenceSDKsContext Plugin
M F A

Track OTP Verification

GET
/mfa/v2/verifications

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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

checkCode*string

Checkcode value returned from “SendVerifcation“ API

Header Parameters

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

Request Body

application/json

body?unknown

Response Body

application/json

application/json

curl -X GET "https://example.com/mfa/v2/verifications?checkCode=string" \  -H "Content-Type: application/json; charset=utf-8" \  -H "Content-Type: application/json" \  -d '{    "checkCode": "LA2WCDQSJBSSEHLJ"  }'

"{\n    \"status\": 200,\n    \"requestId\": \"8e785c1b-6c52-4ce4-9207-dfa3c68c41ec\",\n    \"requestTime\": \"2022-02-16T17:35:35.684\",\n    \"replyMessage\": \"[Request handled successfully]\",\n    \"data\": {\n        \"recipientIdentifier\": \"+2010xxxxxxxx\",\n        \"sendDate\": \"2022-02-16T17:34:08.046\",\n        \"channel\": \"SMS\",\n        \"otpExpiryMinutes\": 1,\n        \"ChecksList\": [\n            {\n                \"otpStatus\": 2,\n                \"verificationDate\": \"2022-02-16T17:34:22.274\",\n                \"verificationStatus\": false\n            },\n            {\n                \"otpStatus\": 2,\n                \"verificationDate\": \"2022-02-16T17:34:32.559\",\n                \"verificationStatus\": false\n            },\n            {\n                \"otpStatus\": 1,\n                \"verificationDate\": \"2022-02-16T17:34:48.855\",\n                \"verificationStatus\": true\n            }\n        ]\n    }\n  \n}"

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.

Send OTP Verification POST

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.