The V1 API is deprecated. Technical support will end by October 2025 and 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.

The Prelude API is a REST API and uses standard HTTP features and statuses.

The current URL is https://api.ding.live/v1.

​
Authentication

To perform requests on the API, you need to provide two secrets:

  • API_KEY - a key that identifies your application in the X-API-Key header.
  • CUSTOMER_UUID - your app’s unique identifier in the customer_uuid request body field.

You can get them in the Settings > API Keys tab of the Dashboard, under the Legacy Credentials section.

Example request
curl --request POST \
     --url 'https://api.ding.live/v1/*' \
     --header 'Accept: application/json' \
     --header 'X-API-Key: <API_KEY>'

​
Errors

The Prelude API returns errors using a JSON object in the response body with a machine-readable code and a human-readable message.

See Errors for more details.

​
SDKs

Prelude offers SDKs for the most popular languages:

Node

Python

Go

Java

PHP

Ruby

C#

​
Reference

Explore the Prelude API reference to learn more about the available endpoints:

OTP

Send OTP codes to your users.

Errors

Handle errors in your integration.