Create or retry a verification - Prelude Documentation

POST

verification

import Prelude from "@prelude.so/sdk";

const client = new Prelude();

async function main() {
  const verification = await client.verification.create({
    target: {
      type: "phone_number",
      value: "+30123456789",
    },
  });

  console.log(verification.id);
}

main();

{
  "id": "vrf_01jc0t6fwwfgfsq1md24mhyztj",
  "status": "success",
  "method": "message",
  "metadata": {
    "correlation_id": "<string>"
  },
  "request_id": "<string>"
}

import Prelude from "@prelude.so/sdk";

const client = new Prelude();

async function main() {
  const verification = await client.verification.create({
    target: {
      type: "phone_number",
      value: "+30123456789",
    },
  });

  console.log(verification.id);
}

main();

Authorizations

Authorization

string

header

required

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

Body

application/json

target

object

required

The verification target. Either a phone number or an email address. To use the email verification feature contact us to discuss your use case.

signals

object

The signals used for anti-fraud. For more details, refer to Signals.

options

object

Verification options

options.template_id

string

The identifier of a verification template. It applies use case-specific settings, such as the message content or certain verification parameters.

Example:

"prelude:psd2"

options.variables

object

The variables to be replaced in the template.

Example:

{ "foo": "bar" }

options.method

enum<string>

default:auto

The method used for verifying this phone number. The 'voice' option provides an accessible alternative for visually impaired users by delivering the verification code through a phone call rather than a text message. It also allows verification of landline numbers that cannot receive SMS messages.

Available options:

auto,

voice

options.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.

Example:

"el-GR"

options.sender_id

string

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

options.app_realm

object

This allows you to automatically retrieve and fill the OTP code on mobile apps. Currently only Android devices are supported.

options.code_size

integer

The size of the code generated. It should be between 4 and 8. Defaults to the code size specified from the Dashboard.

Required range: 4 <= x <= 8

Example:

5

options.custom_code

string

The custom code to use for OTP verification. To use the custom code feature, contact us to enable it for your account. For more details, refer to Custom Code.

Required string length: 4 - 8

Example:

"123456"

options.callback_url

string

The URL where webhooks will be sent when verification events occur, including verification creation, attempt creation, and delivery status changes. For more details, refer to Webhook.

metadata

object

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

dispatch_id

string

The identifier of the dispatch that came from the front-end SDK.

Response

200

application/json

string

required

The verification identifier.

Example:

"vrf_01jc0t6fwwfgfsq1md24mhyztj"

status

enum<string>

required

The status of the verification.

Available options:

success,

retry,

blocked

Example:

"success"

method

enum<string>

required

The method used for verifying this phone number.

Available options:

message

metadata

object

The metadata for this verification.

request_id

string

Auth0 Check a code

import Prelude from "@prelude.so/sdk";

const client = new Prelude();

async function main() {
  const verification = await client.verification.create({
    target: {
      type: "phone_number",
      value: "+30123456789",
    },
  });

  console.log(verification.id);
}

main();

{
  "id": "vrf_01jc0t6fwwfgfsq1md24mhyztj",
  "status": "success",
  "method": "message",
  "metadata": {
    "correlation_id": "<string>"
  },
  "request_id": "<string>"
}

Documentation

API Reference

Authorizations

Body

Response