Send OTP codes worldwide using the Verify API
Integrate the Prelude Verify API from any language to start sending OTP messages to your users worldwide using multiple messaging channels.
The Verify API replaces the OTP v1 API. The
main difference between the two APIs is that with the Verify API, you only
query the API with the phone number and any state is handled automatically by
our backend, removing the need for storing the AuthID
until the session has
ended.
API
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.
Errors
Prelude uses conventional HTTP statuses to indicate the success or failure of a request:
- Codes in the
2xx
range indicate success. - Codes in the
4xx
range indicate an error that failed given the information provided (e.g. required parameter was omitted or an authentication failed). - Codes in the
5xx
range indicate an error with Prelude's servers (these are rare).
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 as well as a list of all possible error codes.
Reference
Explore the Prelude API reference to learn more about the available endpoints: