Create an OTP template

POST

verification

management

templates

curl --request POST \
  --url https://api.prelude.dev/v2/verification/management/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Bank",
  "suffix": "AcmeBank",
  "code_size": 6,
  "ttl_minutes": 10,
  "max_retries": 3,
  "retry_delay_seconds": 30,
  "per_phone_number_limit": 5,
  "sliding_window_hours": 24,
  "max_auto_retries": 1,
  "auto_expire_previous_attempts": true
}
'

import requests

url = "https://api.prelude.dev/v2/verification/management/templates"

payload = {
    "name": "Acme Bank",
    "suffix": "AcmeBank",
    "code_size": 6,
    "ttl_minutes": 10,
    "max_retries": 3,
    "retry_delay_seconds": 30,
    "per_phone_number_limit": 5,
    "sliding_window_hours": 24,
    "max_auto_retries": 1,
    "auto_expire_previous_attempts": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Bank',
    suffix: 'AcmeBank',
    code_size: 6,
    ttl_minutes: 10,
    max_retries: 3,
    retry_delay_seconds: 30,
    per_phone_number_limit: 5,
    sliding_window_hours: 24,
    max_auto_retries: 1,
    auto_expire_previous_attempts: true
  })
};

fetch('https://api.prelude.dev/v2/verification/management/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/verification/management/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Acme Bank',
    'suffix' => 'AcmeBank',
    'code_size' => 6,
    'ttl_minutes' => 10,
    'max_retries' => 3,
    'retry_delay_seconds' => 30,
    'per_phone_number_limit' => 5,
    'sliding_window_hours' => 24,
    'max_auto_retries' => 1,
    'auto_expire_previous_attempts' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/verification/management/templates"

	payload := strings.NewReader("{\n  \"name\": \"Acme Bank\",\n  \"suffix\": \"AcmeBank\",\n  \"code_size\": 6,\n  \"ttl_minutes\": 10,\n  \"max_retries\": 3,\n  \"retry_delay_seconds\": 30,\n  \"per_phone_number_limit\": 5,\n  \"sliding_window_hours\": 24,\n  \"max_auto_retries\": 1,\n  \"auto_expire_previous_attempts\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prelude.dev/v2/verification/management/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Bank\",\n  \"suffix\": \"AcmeBank\",\n  \"code_size\": 6,\n  \"ttl_minutes\": 10,\n  \"max_retries\": 3,\n  \"retry_delay_seconds\": 30,\n  \"per_phone_number_limit\": 5,\n  \"sliding_window_hours\": 24,\n  \"max_auto_retries\": 1,\n  \"auto_expire_previous_attempts\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/verification/management/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Bank\",\n  \"suffix\": \"AcmeBank\",\n  \"code_size\": 6,\n  \"ttl_minutes\": 10,\n  \"max_retries\": 3,\n  \"retry_delay_seconds\": 30,\n  \"per_phone_number_limit\": 5,\n  \"sliding_window_hours\": 24,\n  \"max_auto_retries\": 1,\n  \"auto_expire_previous_attempts\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "template_01k8ap1btqf5r9fq2c8ax5fhc9",
  "name": "Acme Bank",
  "kind": "optimized",
  "code_size": 6,
  "ttl_minutes": 10,
  "max_retries": 3,
  "retry_delay_seconds": 30,
  "per_phone_number_limit": 5,
  "sliding_window_hours": 24,
  "security_suffix_type": "none",
  "max_auto_retries": 1,
  "auto_expire_previous_attempts": true,
  "suffix": "AcmeBank",
  "created_at": "2024-01-01T12:00:00Z"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Create an OTP template. Only name is required: every other field falls back to your account default, so you can create a template per sub-customer with nothing but a name and a suffix. A create is refused once your account holds 500 templates. Custom suffixes are checked before they are stored. Sending a suffix while custom suffixes are not enabled on your account is refused with custom_suffix_not_enabled. A suffix that is malformed is refused with invalid_suffix, one that reads like another company or a public institution with suffix_not_allowed, and one written in an alphabet we do not support yet with suffix_script_not_supported.

Access to the management API is opt-in. Contact our support team to enable it on your account.

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

The name of the template.

Example:

"Acme Bank"

kind

enum<string>

The kind of message the template sends. Defaults to optimized.

Available options:

optimized,

psd2,

account-takeover

suffix

string

The custom text appended to the message. Requires custom suffixes to be enabled on your account.

Example:

"AcmeBank"

code_size

integer

The number of digits in the verification code, between 4 and 8.

Example:

6

ttl_minutes

integer

How many minutes a code stays valid after it was sent, between 1 and 1440.

Example:

10

max_retries

integer

How many times the end user may ask for the code to be sent again, between 1 and 50.

Example:

3

retry_delay_seconds

integer

How many seconds the end user must wait between two of those manual retries, between 1 and 3600.

Example:

30

per_phone_number_limit

integer

How many verifications one phone number may run over sliding_window_hours, between 1 and 1000.

Example:

5

sliding_window_hours

integer

The number of hours the per_phone_number_limit rate limit is measured over, between 1 and 72.

Example:

24

security_suffix_type

enum<string>

The security wording appended to the message.

Available options:

none,

basic,

expiration,

anti_phishing

max_auto_retries

integer

How many times Prelude resends the code on its own, between 1 and 5.

Example:

1

auto_expire_previous_attempts

boolean

Whether requesting a new code invalidates the codes sent before it.

Example:

true

Response

Created

string

required

The identifier of the template, to pass as template_id when creating a verification.

Example:

"template_01k8ap1btqf5r9fq2c8ax5fhc9"

name

string

required

The name of the template.

Example:

"Acme Bank"

kind

enum<string>

required

The kind of message the template sends. Possible values are:

optimized - A standard OTP message.
psd2 - A PSD2 strong customer authentication message.
account-takeover - An account takeover confirmation message.

Available options:

optimized,

psd2,

account-takeover

code_size

integer

required

The number of digits in the verification code.

Example:

6

ttl_minutes

integer

required

How many minutes a code stays valid after it was sent.

Example:

10

max_retries

integer

required

How many times the end user may ask for the code to be sent again.

Example:

3

retry_delay_seconds

integer

required

How many seconds the end user must wait between two of those manual retries.

Example:

30

per_phone_number_limit

integer

required

How many verifications one phone number may run over sliding_window_hours.

Example:

5

sliding_window_hours

integer

required

The number of hours the per_phone_number_limit rate limit is measured over.

Example:

24

security_suffix_type

enum<string>

required

The security wording appended to the message. Possible values are:

none - No security wording.
basic - A short do-not-share warning.
expiration - The basic warning plus the code expiration.
anti_phishing - The strongest anti-phishing wording.

Available options:

none,

basic,

expiration,

anti_phishing

max_auto_retries

integer

required

How many times Prelude resends the code on its own, without the end user asking.

Example:

1

auto_expire_previous_attempts

boolean

required

Whether requesting a new code invalidates the codes sent before it, so only the most recently sent code is valid.

Example:

true

suffix

string

The custom text appended to the message. Absent when the template appends none.

Example:

"AcmeBank"

created_at

string<date-time>

The date and time when the template was created. Absent on templates created before this was recorded.

Example:

"2024-01-01T12:00:00Z"

Create an OTP template

curl --request POST \
  --url https://api.prelude.dev/v2/verification/management/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Bank",
  "suffix": "AcmeBank",
  "code_size": 6,
  "ttl_minutes": 10,
  "max_retries": 3,
  "retry_delay_seconds": 30,
  "per_phone_number_limit": 5,
  "sliding_window_hours": 24,
  "max_auto_retries": 1,
  "auto_expire_previous_attempts": true
}
'

import requests

url = "https://api.prelude.dev/v2/verification/management/templates"

payload = {
    "name": "Acme Bank",
    "suffix": "AcmeBank",
    "code_size": 6,
    "ttl_minutes": 10,
    "max_retries": 3,
    "retry_delay_seconds": 30,
    "per_phone_number_limit": 5,
    "sliding_window_hours": 24,
    "max_auto_retries": 1,
    "auto_expire_previous_attempts": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Acme Bank',
    suffix: 'AcmeBank',
    code_size: 6,
    ttl_minutes: 10,
    max_retries: 3,
    retry_delay_seconds: 30,
    per_phone_number_limit: 5,
    sliding_window_hours: 24,
    max_auto_retries: 1,
    auto_expire_previous_attempts: true
  })
};

fetch('https://api.prelude.dev/v2/verification/management/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.prelude.dev/v2/verification/management/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Acme Bank',
    'suffix' => 'AcmeBank',
    'code_size' => 6,
    'ttl_minutes' => 10,
    'max_retries' => 3,
    'retry_delay_seconds' => 30,
    'per_phone_number_limit' => 5,
    'sliding_window_hours' => 24,
    'max_auto_retries' => 1,
    'auto_expire_previous_attempts' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prelude.dev/v2/verification/management/templates"

	payload := strings.NewReader("{\n  \"name\": \"Acme Bank\",\n  \"suffix\": \"AcmeBank\",\n  \"code_size\": 6,\n  \"ttl_minutes\": 10,\n  \"max_retries\": 3,\n  \"retry_delay_seconds\": 30,\n  \"per_phone_number_limit\": 5,\n  \"sliding_window_hours\": 24,\n  \"max_auto_retries\": 1,\n  \"auto_expire_previous_attempts\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.prelude.dev/v2/verification/management/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Bank\",\n  \"suffix\": \"AcmeBank\",\n  \"code_size\": 6,\n  \"ttl_minutes\": 10,\n  \"max_retries\": 3,\n  \"retry_delay_seconds\": 30,\n  \"per_phone_number_limit\": 5,\n  \"sliding_window_hours\": 24,\n  \"max_auto_retries\": 1,\n  \"auto_expire_previous_attempts\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/verification/management/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Acme Bank\",\n  \"suffix\": \"AcmeBank\",\n  \"code_size\": 6,\n  \"ttl_minutes\": 10,\n  \"max_retries\": 3,\n  \"retry_delay_seconds\": 30,\n  \"per_phone_number_limit\": 5,\n  \"sliding_window_hours\": 24,\n  \"max_auto_retries\": 1,\n  \"auto_expire_previous_attempts\": true\n}"

response = http.request(request)
puts response.read_body

{
  "id": "template_01k8ap1btqf5r9fq2c8ax5fhc9",
  "name": "Acme Bank",
  "kind": "optimized",
  "code_size": 6,
  "ttl_minutes": 10,
  "max_retries": 3,
  "retry_delay_seconds": 30,
  "per_phone_number_limit": 5,
  "sliding_window_hours": 24,
  "security_suffix_type": "none",
  "max_auto_retries": 1,
  "auto_expire_previous_attempts": true,
  "suffix": "AcmeBank",
  "created_at": "2024-01-01T12:00:00Z"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Documentation

API Reference

Authorizations

Body

Response