curl --request POST \
--url https://app.famulor.io/api/v1/phone-numbers/verifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"country": "<string>",
"email": "jsmith@example.com",
"address": {
"customer_name": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>"
},
"replace_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "<string>",
"end_user_attributes": {},
"supporting_documents": [
{}
],
"attachments": [
{
"field": "<string>",
"content_base64": "<string>",
"filename": "<string>",
"content_type": "<string>"
}
]
}
'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/verifications"
payload = {
"country": "<string>",
"email": "jsmith@example.com",
"address": {
"customer_name": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>"
},
"replace_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "<string>",
"end_user_attributes": {},
"supporting_documents": [{}],
"attachments": [
{
"field": "<string>",
"content_base64": "<string>",
"filename": "<string>",
"content_type": "<string>"
}
]
}
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({
country: '<string>',
email: 'jsmith@example.com',
address: {
customer_name: '<string>',
street: '<string>',
city: '<string>',
region: '<string>',
postal_code: '<string>'
},
replace_verification_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prefix: '<string>',
end_user_attributes: {},
supporting_documents: [{}],
attachments: [
{
field: '<string>',
content_base64: '<string>',
filename: '<string>',
content_type: '<string>'
}
]
})
};
fetch('https://app.famulor.io/api/v1/phone-numbers/verifications', 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",
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([
'country' => '<string>',
'email' => 'jsmith@example.com',
'address' => [
'customer_name' => '<string>',
'street' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postal_code' => '<string>'
],
'replace_verification_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prefix' => '<string>',
'end_user_attributes' => [
],
'supporting_documents' => [
[
]
],
'attachments' => [
[
'field' => '<string>',
'content_base64' => '<string>',
'filename' => '<string>',
'content_type' => '<string>'
]
]
]),
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://app.famulor.io/api/v1/phone-numbers/verifications"
payload := strings.NewReader("{\n \"country\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"address\": {\n \"customer_name\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"replace_verification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prefix\": \"<string>\",\n \"end_user_attributes\": {},\n \"supporting_documents\": [\n {}\n ],\n \"attachments\": [\n {\n \"field\": \"<string>\",\n \"content_base64\": \"<string>\",\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ]\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://app.famulor.io/api/v1/phone-numbers/verifications")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"address\": {\n \"customer_name\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"replace_verification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prefix\": \"<string>\",\n \"end_user_attributes\": {},\n \"supporting_documents\": [\n {}\n ],\n \"attachments\": [\n {\n \"field\": \"<string>\",\n \"content_base64\": \"<string>\",\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/verifications")
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 \"country\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"address\": {\n \"customer_name\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"replace_verification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prefix\": \"<string>\",\n \"end_user_attributes\": {},\n \"supporting_documents\": [\n {}\n ],\n \"attachments\": [\n {\n \"field\": \"<string>\",\n \"content_base64\": \"<string>\",\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"country_iso": "DE",
"number_type": "local",
"end_user_type": "business",
"prefix": "<string>",
"has_address": true,
"friendly_name": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rejection_reason": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"approved_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the indicated delay."
}
}{
"error": {
"code": "internal_error",
"message": "Request protection is temporarily unavailable."
}
}Submit regulatory number verification
Submit a number verification case with the required address, registration details, and supporting documents. New verification submissions require an address even when the regulation lists no address document. Whether a purchase needs that address depends on the individual number. Discover supported combinations with GET /phone-numbers/verifications/catalog and load required fields with GET /phone-numbers/verifications/requirements. To correct your own failed, rejected, or draft case instead of opening a new one, send replace_verification_id: GET /phone-numbers/verifications//submission returns its last details, and supporting documents without a new attachment are reused. A submission that fails the automated check is stored as a failed case. Requires a user-scoped API key. Required scope: phone_numbers:write.
curl --request POST \
--url https://app.famulor.io/api/v1/phone-numbers/verifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"country": "<string>",
"email": "jsmith@example.com",
"address": {
"customer_name": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>"
},
"replace_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "<string>",
"end_user_attributes": {},
"supporting_documents": [
{}
],
"attachments": [
{
"field": "<string>",
"content_base64": "<string>",
"filename": "<string>",
"content_type": "<string>"
}
]
}
'import requests
url = "https://app.famulor.io/api/v1/phone-numbers/verifications"
payload = {
"country": "<string>",
"email": "jsmith@example.com",
"address": {
"customer_name": "<string>",
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>"
},
"replace_verification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "<string>",
"end_user_attributes": {},
"supporting_documents": [{}],
"attachments": [
{
"field": "<string>",
"content_base64": "<string>",
"filename": "<string>",
"content_type": "<string>"
}
]
}
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({
country: '<string>',
email: 'jsmith@example.com',
address: {
customer_name: '<string>',
street: '<string>',
city: '<string>',
region: '<string>',
postal_code: '<string>'
},
replace_verification_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
prefix: '<string>',
end_user_attributes: {},
supporting_documents: [{}],
attachments: [
{
field: '<string>',
content_base64: '<string>',
filename: '<string>',
content_type: '<string>'
}
]
})
};
fetch('https://app.famulor.io/api/v1/phone-numbers/verifications', 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",
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([
'country' => '<string>',
'email' => 'jsmith@example.com',
'address' => [
'customer_name' => '<string>',
'street' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postal_code' => '<string>'
],
'replace_verification_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'prefix' => '<string>',
'end_user_attributes' => [
],
'supporting_documents' => [
[
]
],
'attachments' => [
[
'field' => '<string>',
'content_base64' => '<string>',
'filename' => '<string>',
'content_type' => '<string>'
]
]
]),
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://app.famulor.io/api/v1/phone-numbers/verifications"
payload := strings.NewReader("{\n \"country\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"address\": {\n \"customer_name\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"replace_verification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prefix\": \"<string>\",\n \"end_user_attributes\": {},\n \"supporting_documents\": [\n {}\n ],\n \"attachments\": [\n {\n \"field\": \"<string>\",\n \"content_base64\": \"<string>\",\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ]\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://app.famulor.io/api/v1/phone-numbers/verifications")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"country\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"address\": {\n \"customer_name\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"replace_verification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prefix\": \"<string>\",\n \"end_user_attributes\": {},\n \"supporting_documents\": [\n {}\n ],\n \"attachments\": [\n {\n \"field\": \"<string>\",\n \"content_base64\": \"<string>\",\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/phone-numbers/verifications")
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 \"country\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"address\": {\n \"customer_name\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postal_code\": \"<string>\"\n },\n \"replace_verification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"prefix\": \"<string>\",\n \"end_user_attributes\": {},\n \"supporting_documents\": [\n {}\n ],\n \"attachments\": [\n {\n \"field\": \"<string>\",\n \"content_base64\": \"<string>\",\n \"filename\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"country_iso": "DE",
"number_type": "local",
"end_user_type": "business",
"prefix": "<string>",
"has_address": true,
"friendly_name": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rejection_reason": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"approved_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"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.
Body
For local numbers (the default), enter only the area code of the verification address. For Vienna, use 01 or +431 and leave out the subscriber number. For mobile and national numbers, leave this field blank unless restricting the number range. A complete phone number is not a prefix.