Retrieve an OTP template

GET

verification

management

templates

{template_id}

Retrieve an OTP template

curl --request GET \
  --url https://api.prelude.dev/v2/verification/management/templates/{template_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/verification/management/templates/{template_id}', 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/{template_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
}

Retrieve a single OTP template by its identifier.

Authorizations

Authorization

string

header

required

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

Path Parameters

template_id

string

required

The identifier of the template.

Response

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"

Retrieve an OTP template

curl --request GET \
  --url https://api.prelude.dev/v2/verification/management/templates/{template_id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.prelude.dev/v2/verification/management/templates/{template_id}', 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/{template_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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"
}

Documentation

API Reference

Retrieve an OTP template

Authorizations

Path Parameters

Response