Endpoints
Check a code (V1 API)
This page presents how to check a code with our Legacy API, V1.
POST
For more recent documentation, please refer to our API V2
Authorizations
Body
application/json
Your customer UUID, which can be found in the API settings in the Dashboard.
The authentication UUID that was returned when you created the authentication.
The code that the user entered.
Response
200
application/json
OK
The UUID of the corresponding authentication.
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.
Available options:
unknown
, valid
, invalid
, without_attempt
, rate_limited
, already_validated
, expired_auth