CEcequens

Track OTP Verification

After your user’s phone number or email address is verified, you can check the history of the request 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.  Note: Historical Track OTP data is available for 6 hours starting from request time. 

get/v2/verifications

Request

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

Query parameters

checkCodestring required

Checkcode value returned from “SendVerifcation“ API

Headers

Content-Typestring required

Request body

unknown required

Response

200

OR

Example response

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

Changes

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