v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB

Two Factor Codes

Verify User Code

This endpoint allows you to verify the security code to Validate the user, Cancel the security code and check the Status of the code. You need to provide the code generator <code>id</code>, the request id and the security code of the user once he entered it into your app to perform each action as mentioned above.

patch/v1/2fa/{id}/codes

Path parameters

idinteger required

Provide the unique ID of the code generator

Request body

actionstring required

action to be executed on the code

requestIdstring required

id of the request

codestring required

code

Example request

{
  "action": "VERIFY|verify|CANCEL|cancel|STATUS|status",
  "requestId": "HFTHJDL445HDBASL",
  "code": "1234"
}

Response

Success, Code is Valid

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  }
}