List Toll-Free Verifications
curl --request GET \
--url https://api.politicalcomms.com/v1/toll-free-verifications \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.politicalcomms.com/v1/toll-free-verifications"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.politicalcomms.com/v1/toll-free-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://api.politicalcomms.com/v1/toll-free-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.politicalcomms.com/v1/toll-free-verifications"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.politicalcomms.com/v1/toll-free-verifications")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/toll-free-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "tfv_abc123",
"name": "Smith Campaign TFN",
"status": "Verified",
"verification_request_id": "TFV-1234567890",
"org_id": "org_123",
"org_name": "Smith Campaign 2024",
"business_name": "Smith for Senate",
"use_case": "Political",
"phone_number_count": 2,
"submitted_at": "2024-02-20T09:00:00Z",
"verified_at": "2024-02-28T17:30:00Z",
"created_at": "2024-02-19T10:00:00Z"
}
]
}{
"success": false,
"error": "The provided API key is invalid or has been revoked",
"code": "INVALID_API_KEY",
"statusCode": 401
}{
"success": false,
"error": "API key lacks the permission scope this endpoint requires",
"code": "PERMISSION_DENIED",
"statusCode": 403
}{
"success": false,
"error": "Rate limit exceeded",
"message": "Maximum 100 requests per 60 seconds",
"code": "RATE_LIMIT_EXCEEDED",
"statusCode": 429,
"retryAfter": 12
}{
"success": true,
"error": "<string>",
"code": "<string>",
"statusCode": 123
}Toll-Free Verifications
List Toll-Free Verifications
List toll-free verifications (the carrier registrations behind your toll-free numbers) across your organization hierarchy. Filter by organization or by submission status.
GET
/
toll-free-verifications
List Toll-Free Verifications
curl --request GET \
--url https://api.politicalcomms.com/v1/toll-free-verifications \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.politicalcomms.com/v1/toll-free-verifications"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.politicalcomms.com/v1/toll-free-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://api.politicalcomms.com/v1/toll-free-verifications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.politicalcomms.com/v1/toll-free-verifications"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.politicalcomms.com/v1/toll-free-verifications")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.politicalcomms.com/v1/toll-free-verifications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"id": "tfv_abc123",
"name": "Smith Campaign TFN",
"status": "Verified",
"verification_request_id": "TFV-1234567890",
"org_id": "org_123",
"org_name": "Smith Campaign 2024",
"business_name": "Smith for Senate",
"use_case": "Political",
"phone_number_count": 2,
"submitted_at": "2024-02-20T09:00:00Z",
"verified_at": "2024-02-28T17:30:00Z",
"created_at": "2024-02-19T10:00:00Z"
}
]
}{
"success": false,
"error": "The provided API key is invalid or has been revoked",
"code": "INVALID_API_KEY",
"statusCode": 401
}{
"success": false,
"error": "API key lacks the permission scope this endpoint requires",
"code": "PERMISSION_DENIED",
"statusCode": 403
}{
"success": false,
"error": "Rate limit exceeded",
"message": "Maximum 100 requests per 60 seconds",
"code": "RATE_LIMIT_EXCEEDED",
"statusCode": 429,
"retryAfter": 12
}{
"success": true,
"error": "<string>",
"code": "<string>",
"statusCode": 123
}Authorizations
Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.
Query Parameters
Filter to a specific descendant organization
Filter by submission status
Available options:
draft, In Progress, Verified, Rejected ⌘I
