Routing

Get the routing configuration

Retrieve the countries Prelude supports and, for each one, whether it is open for your account and which channels Prelude can attempt there.

Use this endpoint to decide which channels to offer to a user before you create a verification. For example, show a WhatsApp option only in countries where whatsapp is listed.

The list does not say whether a specific phone number can receive a channel. For example, it does not say whether the user has WhatsApp. If a channel cannot reach the phone number, Prelude falls back to the next channel.

voice and silent can appear in the list, but they are not values of the channels option of the create verification endpoint. Request voice with the method option set to voice. Silent verification needs the Prelude SDK on the user’s device.

The list is per country. It does not show channels that are closed for one platform only (for example web only) in the dashboard.

The result changes rarely. Refresh it periodically (for example once a day) instead of calling it before every verification.

In order to get access to this endpoint, contact our support team.

GET

verification

management

routing

Get the routing configuration

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

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

fetch('https://api.prelude.dev/v2/verification/management/routing', 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/routing",
  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/routing"

	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/routing")

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

{
  "regions": [
    {
      "region_code": "CU",
      "status": "closed",
      "channels": []
    },
    {
      "region_code": "FR",
      "status": "open",
      "channels": [
        "rcs",
        "sms",
        "whatsapp"
      ]
    }
  ]
}

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

Get the countries Prelude supports and, for each one, whether it is open for your account and which channels Prelude can attempt there. Use this endpoint to decide which channels to offer to a user before you create a verification. For example, show a WhatsApp option only in countries where whatsapp is listed. The list does not say whether a specific phone number can receive a channel. For example, it does not say whether the user has WhatsApp. If a channel cannot reach the phone number, Prelude falls back to the next channel. voice and silent can appear in the list, but they are not values of the channels option of the create verification endpoint. Request voice with the method option set to voice. Silent verification needs the Prelude SDK on the user’s device. The list is per country. It does not show channels that are closed for one platform only (for example web only) in the dashboard. The result changes rarely. Refresh it periodically (for example once a day) instead of calling it before every verification.

Access to the management API is opt-in. Contact our support team to enable it on your account. To learn how channels are used during a verification, see the Create Verification endpoint.

Authorizations

Authorization

string

header

required

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

Response

The routing configuration of your account.

regions

object[]

required

One entry for each country Prelude supports, sorted by region_code.

Show child attributes

Get the routing configuration

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

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

fetch('https://api.prelude.dev/v2/verification/management/routing', 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/routing",
  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/routing"

	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/routing")

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

{
  "regions": [
    {
      "region_code": "CU",
      "status": "closed",
      "channels": []
    },
    {
      "region_code": "FR",
      "status": "open",
      "channels": [
        "rcs",
        "sms",
        "whatsapp"
      ]
    }
  ]
}

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

Get the routing configuration

Authorizations

Response