Get started
Book a demo
Get started

Endpoints

Create or retry a verification

Documentation

API Reference

Github

V2 API

Introduction
Transactional API
Verify API (beta)
- Introduction
- Endpoints
  - POST
    Create or retry a verification
  - POST
    Check a code
Watch API (coming soon)
Errors
SDKs

V1 API (Legacy)

Introduction
Errors
Endpoints
SDKs

Endpoints

Create or retry a verification

Create a new verification for a specific phone number. If another non-expired verification exists (the request is performed within the verification window), this endpoint will perform a retry instead.

POST

verification

Authorization

string

Bearer

Authorization

Required

string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

object

target

object

target

Required

object

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

type

enum<string>

type

Required

enum<string>

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

value

string

value

Required

string

An E.164 formatted phone number to verify.

Add Example Value

signals

object

signals

object

The signals used for anti-fraud.

string

The IP address of the user's device.

Add Example Value

device_id

string

device_id

string

The unique identifier for the user's device. For Android, this corresponds to the ANDROID_ID and for iOS, this corresponds to the identifierForVendor.

Add Example Value

device_platform

enum<string>

device_platform

enum<string>

The type of the user's device.

Add Example Value

device_model

string

device_model

string

The model of the user's device.

Add Example Value

os_version

string

os_version

string

The version of the user's device operating system.

Add Example Value

app_version

string

app_version

string

The version of your application.

Add Example Value

is_trusted_user

boolean

is_trusted_user

boolean

This signal should provide a higher level of trust, indicating that the user is genuine. For more details, refer to Signals.

Add Example Value

options

object

options

object

Verification options

template_id

string

template_id

string

The identifier of a verification settings template. It is used to be able to switch behavior for specific use cases. Contact us if you need to use this functionality.

locale

string

locale

string

A BCP-47 formatted locale string with the language the text message will be sent to. If there's no locale set, the language will be determined by the country code of the phone number. If the language specified doesn't exist, it defaults to US English.

Add Example Value

sender_id

string

sender_id

string

The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.

app_realm

string

app_realm

string

The Android SMS Retriever API hash code that identifies your app. This allows you to automatically retrieve and fill the OTP code on Android devices.

custom_code

string

custom_code

string

The custom code to use for OTP verification. This feature is only available for compatibility purposes and subject to Prelude’s approval. Contact us to discuss your use case.

metadata

object

metadata

object

The metadata for this verification. This object will be returned with every response or webhook sent that refers to this verification.

correlation_id

string

correlation_id

string

A user-defined identifier to correlate this verification with.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

target

object

required

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

target.type

enum<string>

required

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

Available options:

phone_number

target.value

string

required

An E.164 formatted phone number to verify.

signals

object

The signals used for anti-fraud.

signals.ip

string

The IP address of the user's device.

signals.device_id

string

The unique identifier for the user's device. For Android, this corresponds to the ANDROID_ID and for iOS, this corresponds to the identifierForVendor.

signals.device_platform

enum<string>

The type of the user's device.

Available options:

android,

ios,

ipados,

tvos,

web

signals.device_model

string

The model of the user's device.

signals.os_version

string

The version of the user's device operating system.

signals.app_version

string

The version of your application.

signals.is_trusted_user

boolean

This signal should provide a higher level of trust, indicating that the user is genuine. For more details, refer to Signals.

options

object

Verification options

options.template_id

string

The identifier of a verification settings template. It is used to be able to switch behavior for specific use cases. Contact us if you need to use this functionality.

options.locale

string

options.sender_id

string

The Sender ID to use for this message. The Sender ID needs to be enabled by Prelude.

options.app_realm

string

The Android SMS Retriever API hash code that identifies your app. This allows you to automatically retrieve and fill the OTP code on Android devices.

options.custom_code

string

The custom code to use for OTP verification. This feature is only available for compatibility purposes and subject to Prelude’s approval. Contact us to discuss your use case.

metadata

object

The metadata for this verification. This object will be returned with every response or webhook sent that refers to this verification.

metadata.correlation_id

string

A user-defined identifier to correlate this verification with.

Response

200 - application/json

string

required

The verification identifier.

status

enum<string>

required

The status of the verification.

Available options:

success,

retry,

blocked

method

enum<string>

required

The method used for verifying this phone number.

Available options:

message

metadata

object

The metadata for this verification.

metadata.correlation_id

string

request_id

string

Was this page helpful?

Introduction Check a code

twitter github linkedin