Introduction

Make sure to learn more about the use cases behind this API by reading the Use case.

The /validate API aims to solve the following use cases:

• Accepts the :request_id , received as a part of request API response as request_id
• Accepts the 2FA code which has been entered by the recipient via code
• Returns the information whether the recipient has been successfully validated

An example request toward /validate is:

{
  "code": "123456",
  "request_id": "9135605a-7e48-4be8-860c-ecf5840d2770"
}

API responses

The following responses and error codes are being returned as a part of the API response.

HTTP STATUS 200

• verified - boolean
• status - string, where values are
  • success the 2FA code which has been provided to the API was properly entered by the recipient
  • not_matched the 2FA code which has been provided to the API was not properly entered by the recipient

HTTP STATUS 404

• verified - boolean
• status - string, where values are
  • not_found the 2FA code request was not found due to ttl (time to live, default of 5 minutes) has been reached (in this case the user of the API should re-initiate the process by using the request endpoint)