Endpoints
Check a code
POST
/
check
Authorizations
x-api-key
string
headerrequiredBody
application/json
customer_uuid
string
requiredYour customer UUID, which can be found in the API settings in the Dashboard.
authentication_uuid
string
requiredThe authentication UUID that was returned when you created the authentication.
check_code
string
requiredThe code that the user entered.
Response
200 - application/json
authentication_uuid
string
The UUID of the corresponding authentication.
status
enum<string>
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
Was this page helpful?