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

The current URL is https://api.prelude.dev/v2.

​
Authentication

To perform requests on the API, you need to provide a v2 API key in the Authorization header.

You can create an API key in the Dashboard, under the API Keys section of the settings.

Example request
curl --request POST \
     --url 'https://api.prelude.dev/v2/*' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer <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 and a param field.

See Errors for more details.

Verify API

Verify a phone number using OTP messages.

Transactional

Send transactional messages to your users.

Watch

Identify trustworthy phone numbers to mitigate fake trafic or trafic involved in fraud and international revenue share fraud (IRSF).

Was this page helpful?

Introduction