Skip to main content
POST
/
check
Check a code
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": "<string>"
}
'
{
  "authentication_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "valid"
}

Documentation Index

Fetch the complete documentation index at: https://docs.prelude.so/llms.txt

Use this file to discover all available pages before exploring further.

The V1 API is deprecated. Starting November 1st 2025, no support will be provided for the V1 API and it will be removed by April 2026. No new features nor functionality will be added to the V1 API. Please use the V2 Verify API instead. For more information refer to the V2 Migration Guide.
V2 equivalent: Check a code. The V2 endpoint no longer requires a verification ID — you check with the phone number and the code directly.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
customer_uuid
string<uuid>
required

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

​
authentication_uuid
string<uuid>
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

OK

​
authentication_uuid
string<uuid>

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"