Sign in

v34

latestOpenAPI 3.1.0raw.githubusercontent.com2025-05-1961327.8 KB
OTP

Check a code

Check that a code entered by a user is valid.

post/check

Request body

customer_uuidstring uuid required

Your customer UUID, which can be found in the API settings in the Dashboard.

authentication_uuidstring uuid required

The authentication UUID that was returned when you created the authentication.

check_codestring required

The code that the user entered.

Example request

{
  "check_code": "123456"
}

Response

OK

authentication_uuidstring uuid

The UUID of the corresponding authentication.

status'unknown' | 'valid' | 'invalid' | 'without_attempt' | 'rate_limited' | 'already_validated' | 'expired_auth'

The status of the check. Possible values are:

  • unknown - The status is unknown.
  • valid - The code is valid.
  • invalid - The code is invalid.
  • without_attempt - No attempt was sent yet, so a check cannot be completed.
  • rate_limited - The authentication was rate limited and cannot be checked.
  • already_validated - The authentication has already been validated.
  • expired_auth - The authentication has expired and cannot be checked.

Example response

{
  "status": "valid"
}