POST
/
check
curl --request POST \
  --url https://api.ding.live/v1/check \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "customer_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authentication_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "check_code": "123456"
}'
{
  "authentication_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "valid"
}

For more recent documentation, please refer to our API V2

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
customer_uuid
string
required

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

​
authentication_uuid
string
required

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

​
check_code
string
required

The code that the user entered.

Example:

"123456"

Response

200
application/json
OK
​
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
Example:

"valid"