Once the user with a trustworthy phone number demonstrates authentic behavior, call this endpoint to report their authenticity to our systems.

Feedback

The target. Currently this can only be an E.164 formatted phone number.

The type of the target. Currently this can only be "phone_number".

An E.164 formatted phone number to verify.

apiToken

Prelude Documentation

Explore our guides and examples to implement Prelude, our powerful and easy-to-use API that lets you send OTP codes and transactional messages worldwide.

Overview

Understand how Prelude works to leverage its full potential.

How Prelude works

Send and verify a code in 2 minutes and 3 simple steps with our SDKs, available for many popular languages to make your life easier.

Quickstart

Learn how Prelude partners with multiple providers and channels to guarantee the highest possible delivery rate at the lowest possible cost.

Multi-Routing

Multi-Routing explained

Understand how Prelude's fraud prevention algorithm works, the type of fraud it prevents and how to configure it.

Anti-Fraud

Anti-Fraud explained

Monitor your performance and configure your integration with your Dashboard. To get access to the dashboard, you must first sign up and create an app.

Analytics

Analytics explained

Learn how to easily register a webhook with Prelude to get notified when your messages are delivered and billed.

Webhook

Learn how to confirm that your integration is working properly by simulating OTPs without incurring charges using special test numbers.

Testing

Send OTPs to test your integration

Configure your integration to protect your application against fraud like SMS pumping or IRSF fraud with Prelude’s machine learning models.

Prevent Fraud

Learn how to use our iOS SDK. It allows you to capture certain device signals that will be reported back to Prelude.

iOS SDK

Learn how to use our Android SDK. It allows you to capture certain device signals that will be reported back to Prelude.

Android

Android SDK

Learn how to use our Expo React Native SDK. It allows you to capture certain device signals (both in Android and iOS) that will be reported back to Prelude.

React Native

React Native SDK

Learn how to integrate the Prelude APIs and SDKs with other platforms.

Integrations

Everything you need to integrate the V2 API from any language and access our Verify, Transactional and Watch APIs and features.

Introduction

Introduction to the V2 API

Learn how to troubleshoot errors like invalid custom code or unauthorized Sender ID to ensure a robust integration.

Errors

Troubleshooting errors

Introduction to the V1 API (Legacy)

This page presents how to handle errors with our Legacy API, V1.

Troubleshooting errors (V1 API)

API Reference

Github

Get started

Book a demo

Everything you need to know about Prelude Transactional API to start sending transactional messages to your users via SMS and online messaging channels.

Introduction to the Transactional API

Prelude Transactional API can notify your application about events using webhooks. Get notified when your messages are delivered and billed.

Webhook for the Transactional API

Integrate the Prelude Verify API from any language to start sending OTP messages to your users worldwide using multiple messaging channels.

Send OTP codes worldwide using the Verify API

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

V2 API

V1 API (Legacy)

Feedback

Authorizations

Body

Response