curl --request GET \
--url https://app.famulor.io/api/v1/phone-numbers/verifications/requirements \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/verifications/requirements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/phone-numbers/verifications/requirements', 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://app.famulor.io/api/v1/phone-numbers/verifications/requirements",
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://app.famulor.io/api/v1/phone-numbers/verifications/requirements"
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))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/phone-numbers/verifications/requirements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/verifications/requirements")
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{
"data": {
"iso_country": "DE",
"number_type": "local",
"end_user_type": "business",
"friendly_name": "<string>",
"requires_address": true,
"address_description": "<string>",
"end_user": [
{
"name": "<string>",
"type": "<string>",
"fields": [
"<string>"
],
"detailed_fields": [
{
"machine_name": "<string>",
"friendly_name": "<string>",
"description": "<string>",
"constraint": "<string>"
}
],
"requirement_name": "<string>"
}
],
"supporting_document": [
[
{
"name": "<string>",
"requirement_name": "<string>",
"description": "<string>",
"type": "<string>",
"accepted_documents": [
{
"name": "<string>",
"type": "<string>",
"fields": [
"<string>"
],
"detailed_fields": [
{
"machine_name": "<string>",
"friendly_name": "<string>",
"description": "<string>",
"constraint": "<string>"
}
]
}
]
}
]
]
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Get number verification requirements
Returns the current registration fields, accepted document types, and address requirements for a supported catalog combination. Field names are used as keys when submitting registration details. Required address information is supplied through the address object; internal address references are managed automatically. Unsupported registration types return 400. No verification case is created. Required scope: phone_numbers:read.
curl --request GET \
--url https://app.famulor.io/api/v1/phone-numbers/verifications/requirements \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/verifications/requirements"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/phone-numbers/verifications/requirements', 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://app.famulor.io/api/v1/phone-numbers/verifications/requirements",
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://app.famulor.io/api/v1/phone-numbers/verifications/requirements"
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))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/phone-numbers/verifications/requirements")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/verifications/requirements")
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{
"data": {
"iso_country": "DE",
"number_type": "local",
"end_user_type": "business",
"friendly_name": "<string>",
"requires_address": true,
"address_description": "<string>",
"end_user": [
{
"name": "<string>",
"type": "<string>",
"fields": [
"<string>"
],
"detailed_fields": [
{
"machine_name": "<string>",
"friendly_name": "<string>",
"description": "<string>",
"constraint": "<string>"
}
],
"requirement_name": "<string>"
}
],
"supporting_document": [
[
{
"name": "<string>",
"requirement_name": "<string>",
"description": "<string>",
"type": "<string>",
"accepted_documents": [
{
"name": "<string>",
"type": "<string>",
"fields": [
"<string>"
],
"detailed_fields": [
{
"machine_name": "<string>",
"friendly_name": "<string>",
"description": "<string>",
"constraint": "<string>"
}
]
}
]
}
]
]
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Query Parameters
ISO-2 country code, for example DE.
2local, mobile, national business, individual Response
Current verification requirements
Show child attributes
Show child attributes