WAwavix
2FA

Validate a code

Changed on

Validates the OTP submitted by the end user against the verification identified by session_id. Non-idempotent — each call consumes one of a limited number of attempts tracked server-side; once exhausted, the verification returns 429 until a new verification is created.

post/v1/two-fa/verification/{session_id}/check

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/two-fa/verification/{session_id}/check
  • Auth
    HTTP bearer

Path parameters

session_idstring required
Example:2953d4308f2e11ecb75fcdafd6d2d687

The unique ID of the 2FA verification session.

Request body

codestring required

The code entered by an end user

Example request

{
  "code": "123456"
}

Response

Returns the validation result in is_valid.

is_validboolean required

Indicates whether the entered code is valid

Example response

{
  "is_valid": true
}

Changes

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

  • 76b9bb35619fRevision changes
    • warning

      removed the optional property from the response with the status