TrustPilot

API Documentation

API Authentication

To use our API please use Basic Authentication.

Generate API Keys you can here



Our main API server: https://api.tcpalitigatorlist.com

Note: In case of API unexpected fails, you can switch traffic to our backup server. Keep in mind it`s for emergencies, not for constant use: https://api101.tcpalitigatorlist.com

Note: Our public API servers are limiting every client with 50 calls/second. Click here for details.

Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phone/tcpa/1000000000';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_endpoint);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);
$response_array = json_decode($output,true);
https://api.tcpalitigatorlist.com/scrub/phone/ Method: POST
Check if phone number is in our TCPA/DNC list
Params:
  • [phone_number] (required) Phone number to check
  • [contact_name] (optional) Name of contact person
  • [use_nra] (optional) Use NRA or not. Available values: true, false. Default: false
  • [type] (optional) List type to scrub against.
    Available values:
    - all
    - tcpa (default) - Scrub out TCPA, TCPA Troll
    - dnc_complainers - Scrub out DNC complainers
    - dnc_state - Scrub out State DNC
    Or array of the values.
  • [state] (optional) Country states codes array. Example: ['FL','NY','CA'].
    If specified application will be scrubing out phone numbers of requested states.
    Available states
  • [sub_user] (optional) Your own identificator for your own use. Can be any value up to 16 chars.
  • [return] (optional) Specifies the format of the returned value. Available values: boolean (1 - match, 0 - clean)
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phone/';
$api_username = '$api_username';
$api_password = '$api_password';

$types = ["tcpa", "dnc"];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('type' => json_encode($types), 'phone_number' => '2012510414', 'contact_name' => 'John')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true); Response example: 
{
    "results": {
        "first_name": "John",
        "middle_name": "",
        "last_name": "",
        "case_title": "",
        "multiple_cases": "",
        "phone_type": "",
        "status_array": [
            "dnc_complainers"
        ],
        "phone_status": "",
        "clean": 0,
        "is_bad_number": true,
        "phone_number": "2012510414",
        "created_at": "",
        "updated_at": "",
        "status": "DNC Complainers"
    }
}
https://api.tcpalitigatorlist.com/scrub/phone/[type]/[phone_number]/[contact_name] Method: GET
Check if phone number is in our TCPA/DNC list
Params:
  • [type] (required) List type to scrub against.
    Available values:
    - all
    - tcpa (default) - Scrub out TCPA, TCPA Troll
    - dnc_complainers - Scrub out DNC complainers
    - dnc_state - Scrub out State DNC
    Or array of the values.
  • [phone_number] (required) Phone number to check
  • [contact_name] (optional) Name of contact person
  • [state] (optional) Country states code. Example: ['FL','NY','CA'].
    If specified application will be scrubing out phone numbers of requested states only.
    Available states
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phone/all/2012510414/John';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_endpoint);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);
$response_array = json_decode($output,true); Response example: 
{
    "results": {
        "first_name": "John",
        "middle_name": "",
        "last_name": "",
        "case_title": "",
        "multiple_cases": "",
        "phone_type": "",
        "status_array": [
            "dnc_complainers"
        ],
        "phone_status": "",
        "clean": 0,
        "is_bad_number": true,
        "phone_number": "2012510414",
        "created_at": "",
        "updated_at": "",
        "status": "DNC Complainers"
    }
}
https://api.tcpalitigatorlist.com/scrub/name/[type]/[contact_name] Method: GET
Check if contact name is in our TCPA/DNC list
Params:
  • [type] (required) List type to scrub against.
    Available values:
    - all
    - tcpa (default) - Scrub out TCPA, TCPA Troll
    - dnc_complainers - Scrub out DNC complainers
    - dnc_state - Scrub out State DNC
    Or array of the values.
  • [contact_name] (optional) Name of contact person
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/name/tcpa/John vitorino';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_endpoint);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);
$response_array = json_decode($output,true); Response example: 
{
    "results": {
        "first_name": "John",
        "middle_name": "",
        "last_name": "Vitorino",
        "case_title": "",
        "multiple_cases": "1",
        "phone_type": "Mobile",
        "status_array": [
            "tcpa",
            "federal_dnc"
        ],
        "phone_status": "Listed in Complaint",
        "clean": 0,
        "is_bad_number": true,
        "phone_number": "7276089538",
        "created_at": "2018-07-27 10:31:16",
        "updated_at": "2018-07-27 10:31:16",
        "status": "TCPA | Federal DNC",
        "name": "John Vitorino"
    }
}
Match tcpa: 
{
    "results": {
        "first_name": "John",
        "middle_name": "",
        "last_name": "Vitorino",
        "case_title": "",
        "multiple_cases": "1",
        "phone_type": "Mobile",
        "status_array": [
            "tcpa",
            "federal_dnc"
        ],
        "phone_status": "Listed in Complaint",
        "clean": 0,
        "is_bad_number": true,
        "phone_number": "7276089538",
        "created_at": "2018-07-27 10:31:16",
        "updated_at": "2018-07-27 10:31:16",
        "status": "TCPA | Federal DNC",
        "name": "John Vitorino"
    }
}
Match DNC Complainers or Federal DNC: 
{
    "results": {
        "first_name": "",
        "middle_name": "",
        "last_name": "",
        "case_title": "",
        "multiple_cases": "",
        "phone_type": "",
        "status_array": [
            "dnc_complainers"
        ],
        "phone_status": "",
        "clean": 0,
        "is_bad_number": true,
        "phone_number": "2012510414",
        "created_at": "",
        "updated_at": "",
        "status": "DNC Complainers"
    }
}
Clean: 
{
    "results": {
        "phone_number": 9258492311,
        "clean": 1,
        "is_bad_number": false
    }
}
Not enough credits: 
{
    "error": "You do not have enough credits"
}
API subscription is not active or incorrect API credentials: 
{
    "code": "rest_forbidden",
    "message": "Sorry, you are not allowed to do that.",
    "data": {
        "status": 401
    }
}

Mass records scrub

How to do mass scrub?

There are two ways to do mass scrub for small lists and big lists (take a look at difference /scrub/phones/).

If want to scrub small list, you need to do next steps:

  1. Send your phone numbers with /scrub/phones/ endpoint, using the small_list param
  2. As result you will get clean and match phone numbers.
    For example: 
    {
    "results" : {
        {
            "phone_number": "6024223200"
            "clean": "1"
        },
        {
            "phone_number": "6028912045"
            "clean": "1"
        },
        {
            "phone_number": "6319796917",
            "status": "TCPA",
            "first_name":"John",
            "middle_name":"",
            "last_name":"Vitorino",
            "case_title": "",
            "multiple_cases": "0",
            "phone_type": "Mobile",
            "phone_status":"Listed In Complaint",
            "created_at": "2018-07-27 10:31:15",
            "updated_at": "2018-07-27 10:31:15",
            "status_array": [
                "federal_dnc",
                "tcpa"
            ],
            "is_bad_number": true,
            "clean": 0
        }
    }
}

If want to scrub big list, you need to do next steps:

  1. Send your phone numbers with /scrub/phones/ endpoint.
    As result you will get a unique key. The key is an id of your job in jobs queue. With the key you can check the job status and get its result.
    For example: 
    {
	"status": "in_queue",
	"job_key": "2959996d31374622d45c20f57388912f"
}
  2. Check the job with the key you got earlier until you get the job result. To check a job status use /scrub/phones/get/ or /scrub/phones/jobs/ endpoint.
    Example you can find here /scrub/phones/.
    Instead of checking the job in a loop, you can set up a Webhook URL and we will notify your server when the job is finished. See Webhooks.
https://api.tcpalitigatorlist.com/scrub/phones/ Method: POST
How to scrub?
Check if phone numbers are in our TCPA/DNC list. There are two ways to do mass scrub for small lists (less then 3000 phone numbers) and big lists (more then 3000 phone numbers).
The different between them is if you use this endpoint with small_list flag, you will get result right away, but there is 3000 phone numbers limit.
If you use this endpoint without small_list flag, you will be added in common queue and as response you will get a unique key, with that key you can get scrub result in the future.
To get scrub result you need to send request to /scrub/phones/get/ endpoint with the key you got earlier. Using this endpoint without small_list flag, you have no limits.

What does sub_user means?
The sub_user param is a request marker. This marker is needed for grouping requests. Here you can find statistics of these groups.

The big list scrub speed test
790K numbers - TCPA = 1 minute 10 seconds
790K numbers - DNC = 56 seconds
790K numbers - DNC FED = 1 minute 7 seconds
790K numbers - ALL = 1 minute 53 seconds
Params:
  • [phones] (required) Phone numbers list.
    Example: 
    [
    "6319796917",
    "6038980045",
    "6014250300"
]

    If you use NRA, you need to send phones in a tabular format, where each line has the phone number (index 0) and full name (index 1) fields.
    Example: 
    [
    ["12312312","Bob Tom"],
    ["12312313","Alice Johnson"]
]
  • [type] (optional) List type to scrub against.
    Available values:
    - tcpa (default) - Scrub out TCPA, TCPA Troll
    - dnc_fed - Scrub out Federal DNC
    - dnc_complainers - Scrub out DNC complainers
    - dnc_state - Scrub out State DNC
    Additional ways of request. Alliases and arrays.
  • [small_list] (optional) If true, scrub result will be returned immediately. Available values: true, false. Default: false
  • [use_suppression_list] (optional) Use your suppression list uploaded on the site or not. Available values: true, false. Default: false
  • [use_nra] (optional) Use NRA or not. Available values: true, false. Default: false
  • [state] (optional) Country states codes array. Example: ['FL','NY','CA'].
    If specified application will be scrubing out phone numbers of requested states.
    Available states
  • [sub_user] (optional) Your own identificator for your own use. Can be any value up to 16 chars.

Small list (up to 3000) scrub example

PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones';
$api_username = '$api_username';
$api_password = '$api_password';

$numbers = ["6319796917", "6024223200", "6028912045"];

$types = ["tcpa", "dnc"];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('phones' => json_encode($numbers), 'type' => json_encode($types), 'sub_user' => 'Some user', 'small_list' => 'true')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true); Response example: 
{
    "results" : {
        {
            "phone_number": "6024223200"
            "clean": "1"
        },
        {
            "phone_number": "6028912045"
            "clean": "1"
        },
        {
            "phone_number": "6319796917",
            "status": "TCPA",
            "first_name":"John",
            "middle_name":"",
            "last_name":"Vitorino",
            "case_title": "",
            "multiple_cases": "0",
            "phone_type": "Mobile",
            "phone_status":"Listed In Complaint",
            "created_at": "2018-07-27 10:31:15",
            "updated_at": "2018-07-27 10:31:15",
            "status_array": [
                "federal_dnc",
                "tcpa"
            ],
            "is_bad_number": true,
            "clean": 0
        }
    }
}

Big list (over 3000) scrub example

PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones';
$api_username = '$api_username';
$api_password = '$api_password';

$numbers = ["6319796917", "6024223200", "6028912045"];

$types = ["tcpa", "dnc"];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('phones' => json_encode($numbers), 'type' => json_encode($types), 'sub_user' => 'Some user')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true); Response example: 
{
    "status": "in_queue",
    "job_key": "3e3c21b74b5de356c6a0c42190836c6f"
}
Get result
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones/get/';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('key' => "'3e3c21b74b5de356c6a0c42190836c6f'")));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$interval = 10;

while(true) {

sleep($interval);

$output = curl_exec($ch);

$response_array = json_decode($output,true);

if(
isset($response_array['status']) &&
($response_array['status'] == 'in_queue' ||
$response_array['status'] == 'processing')
) {
//Result not ready yet
continue;
} else if(isset($response_array['match'])) {
//Result ready
$result = $response_array;
break;
} else {
//Something went wrong
break;
}
}

curl_close ($ch);

$response_array = json_decode($output,true); Response example: 
{
    "results" : {
        {
            "phone_number": "6024223200"
            "clean": "1"
        },
        {
            "phone_number": "6028912045"
            "clean": "1"
        },
        {
            "phone_number": "6319796917",
            "status": "TCPA",
            "first_name":"John",
            "middle_name":"",
            "last_name":"Vitorino",
            "case_title": "",
            "multiple_cases": "0",
            "phone_type": "Mobile",
            "phone_status":"Listed In Complaint",
            "created_at": "2018-07-27 10:31:15",
            "updated_at": "2018-07-27 10:31:15",
            "status_array": [
                "federal_dnc",
                "tcpa"
            ],
            "is_bad_number": true,
            "clean": 0
        }
    }
}
https://api.tcpalitigatorlist.com/scrub/phones/get/ Method: POST
Get result of the job
Params:
  • [key] (required) A key of the job
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones/get/';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('key' => '972a569d8bdcaeee1ac30404c05054aa')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true); Response example: 
{
    "results" : {
        {
            "phone_number": "6024223200"
            "clean": "1"
        },
        {
            "phone_number": "6028912045"
            "clean": "1"
        },
        {
            "phone_number": "6319796917",
            "status": "TCPA",
            "first_name":"John",
            "middle_name":"",
            "last_name":"Vitorino",
            "case_title": "",
            "multiple_cases": "0",
            "phone_type": "Mobile",
            "phone_status":"Listed In Complaint",
            "created_at": "2018-07-27 10:31:15",
            "updated_at": "2018-07-27 10:31:15",
            "status_array": [
                "federal_dnc",
                "tcpa"
            ],
            "is_bad_number": true,
            "clean": 0
        }
    }
}
https://api.tcpalitigatorlist.com/scrub/phones/jobs Method: POST
Get all queue jobs
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones/jobs';
$api_username = '$api_username';
$api_password = '$api_password';
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true); Response example: 
{
	"jobs": [
		{
			"key": "b8c6e9f019be06b581e888c0474eafee",
			"status": "result_ready",
			"create_ts": "2020-05-15 07:46:18"
		},
		{
			"key": "0700d5c294e6fb31e36e826b471e536c",
			"status": "result_ready",
			"create_ts": "2020-05-15 07:46:51"
		},
		{
			"key": "8da181132f2b63d53972b49f44dd7fc4",
			"status": "result_ready",
			"create_ts": "2020-05-15 08:00:11"
		}
	]
}

Webhooks

Webhooks let us notify your server when a queued mass scrub job is finished, so you don't need to poll the /scrub/phones/get/ endpoint in a loop.

Webhooks apply to queued (big list) jobs only: when you send a request to /scrub/phones/ without the small_list flag (lists over 3000 numbers are always queued), you get a response like this:

{
    "status": "in_queue",
    "job_key": "3e3c21b74b5de356c6a0c42190836c6f"
}

When the job finishes, we send an HTTP POST request with the same job_key to your Webhook URL.

How to enable webhooks?
Set your Webhook URL on the API keys page (the same page where you manage your API keys). Leave the field empty to disable webhooks.
Saving a URL also generates your webhook signing secret. The secret is shown on the same page.
Use the "Send test webhook" button on that page to check your endpoint. The test request has the same shape, with body {"job_key":"test","status":"test"}.

Webhook URL requirements
The URL must be http or https and publicly reachable. Private/internal addresses are rejected.
Request headers:
  • Content-Type application/json
  • X-Webhook-Signature sha256=<signature>, where signature is the hex encoded HMAC-SHA256 of the raw request body, using your webhook secret as the key.
Request body fields:
  • [job_key] The same 32-char job_key you got from the /scrub/phones/ response.
  • [status] result_ready - the job is finished and the result can be fetched.
    error - the job failed (for example, insufficient credits).
Example of the request your server receives
POST /your-webhook-path HTTP/1.1
Host: example.com
Content-Type: application/json
X-Webhook-Signature: sha256=7d38b5cd25a2baf85ad3bb5b9311c2708edebcbdbe35b6a9a2071ec9a1f2d0b4

{"job_key":"3e3c21b74b5de356c6a0c42190836c6f","status":"result_ready"}
If the job failed (for example, insufficient credits), the body is: 
{"job_key":"3e3c21b74b5de356c6a0c42190836c6f","status":"error"}
PHP Example. Verify the signature
$webhook_secret = 'your webhook secret from the API keys page';

$raw_body = file_get_contents('php://input');
$signature_header = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'] ?? '';

$expected = 'sha256=' . hash_hmac('sha256', $raw_body, $webhook_secret);

if (!hash_equals($expected, $signature_header)) {
http_response_code(401);
exit;
}

// Respond with 2xx as fast as possible, process the job_key afterwards
http_response_code(200);

$data = json_decode($raw_body, true);

$job_key = $data['job_key'];
$status = $data['status'];
Responding and retries
Your endpoint should respond with an HTTP 2xx status code as fast as possible.
If your endpoint responds with a non-2xx status or is unreachable, we retry up to 3 more times: after 1 minute, after 5 minutes and after 30 minutes. After that we give up.
Example
Get result
After you receive a webhook with the result_ready status, fetch the result the usual way - send your job_key to the /scrub/phones/get/ endpoint. No polling loop is needed, the result is already ready.
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones/get/';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('key' => '3e3c21b74b5de356c6a0c42190836c6f')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true);
https://api.tcpalitigatorlist.com/scrub/stats/[start_date]/[end_date] Method: GET
Show API statistics
Params:
  • [start_date] (optional) Start date. Format: YYYY-MM-DD
  • [end_date] (optional) End date. Format: YYYY-MM-DD
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/stats/2020-05-16/2020-05-16';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api_endpoint);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
$output = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);
$response_array = json_decode($output,true); Response: 
{
    "total": {
        "count": "1",
        "price": 0
    },
    "user": {
        "count": "0",
        "price": 0
    },
    "sub_users": [
        {
            "sub_user": "someone",
            "count": 1,
            "price": 0
        }
    ],
    "applied_dates": {
        "start": "2022-12-10",
        "end": "2023-01-09"
    }
}
https://api.tcpalitigatorlist.com/scrub/stats/ Method: POST
Show API statistics
Params:
  • [start_date] (optional) Start date. Format: YYYY-MM-DD
  • [end_date] (optional) End date. Format: YYYY-MM-DD
Example
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/stats/';
$api_username = '$api_username';
$api_password = '$api_password';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('start_date' => '2020-05-16', 'end_date' => '2020-06-16')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$output = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);
$response_array = json_decode($output,true); Response: 
{
    "total": {
        "count": "1",
        "price": 0
    },
    "user": {
        "count": "0",
        "price": 0
    },
    "sub_users": [
        {
            "sub_user": "someone",
            "count": 1,
            "price": 0
        }
    ],
    "applied_dates": {
        "start": "2022-12-10",
        "end": "2023-01-09"
    }
}
phone_status
Phone status
Can be one of the following possible values:
  • TCPA Trolls Description
  • TCPA Attorney Description
  • Associated with Litigator Description
  • Listed in Complaint Description
phone_type
Phone type
Can be one of the following possible values:
  • Landline A landline phone is an apparatus that is connected to the landline network to communicate.
  • Mobile A mobile phone is a phone that is portable and works through radio technology.
  • Voip A VoIP phone is a phone that is connected to internet to call.
status
A string of concatenated phone statuses separated by the " | " symbol.
Example: "TCPA | DNC Complainers"
Can contain the following values:
  • TCPA
  • TCPA troll
  • NRA
  • DNC Complainers
  • Federal DNC
  • State DNC
status_array
Array of phone statuses
Array of the following possible values:
  • tcpa TCPA
  • troll TCPA Troll
  • nra NRA
  • dnc_complainers DNC Complainers
  • federal_dnc Federal DNC
  • state_dnc State DNC

Array scrub example

To use our API please use Basic Authentication
PHP Example
$api_endpoint = 'https://api.tcpalitigatorlist.com/scrub/phones/all/';
$api_username = '$api_username';
$api_password = '$api_password';

$numbers = ["6319796917", "6038980045", "6014250300"];

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL,$api_endpoint);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array('phones' => json_encode($numbers), 'small_list' => 'true')));
curl_setopt($ch, CURLOPT_USERPWD, "$api_username:$api_password");
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$output = curl_exec($ch);
curl_close ($ch);

$response_array = json_decode($output,true);

Results examples

TCPA Match 
{
    "results": {
        "first_name": "Ken",
        "middle_name": "",
        "last_name": "Murakami",
        "case_title": "",
        "multiple_cases": "1",
        "phone_type": "Landline",
        "status_array": [
            "tcpa"
        ],
        "phone_status": "Associated with Litigator",
        "clean": 0,
        "is_bad_number": true,
        "phone_number": "9257350671",
        "created_at": "2019-02-09 09:06:13",
        "updated_at": "2019-02-09 09:06:13",
        "status": "TCPA",
        "name": "Ken Murakami"
    }
}
Clean phone number 
{
    "results": {
        {
            "phone_number": "92573506711",
            "clean": 1,
        }
    }
}

Easily scrub your phone numbers using our API SDK

Our repository you can find here https://github.com/StreetYo/TCPA-SDK

API SDK

SDK stands for software development kit or devkit for short. It’s a set of software tools and programs used by developers to create applications for specific platforms.

SDK tools will include a range of things, including libraries, documentation, code samples, processes, and guides that developers can use and integrate into their own apps.


Make it before use

Login to your account. Generate your API keys here if you don't have them yet.

Example

Set your API login and password. You can run this code with the GET phone or phones parameters and get their scrub statuses.

if ( isset($_GET['phone']) ){
	print_r(tcpa_scrub_single_number($_GET['phone']));
}

if ( isset($_GET['phones']) ){
	print_r(tcpa_mass_scrub(explode(',', $_GET['phones'])));
}

function tcpa_scrub_single_number($phone_number, $fields = []){
	$api_config = [
		'api_username' => 'YOUR API LOGIN',
		'api_password' => 'YOUR API PASSWORD',
		'response_format' => 'json',
		'response_type' => isset($_GET['boolean']) ? 'boolean' : 'regular',
		'check_types' => isset($_GET['type']) ? [$_GET['type']] : ['all'],
	];
    $api = new TCPA_API($api_config);
    return $api->request_single_number($phone_number, $fields);
}

function tcpa_mass_scrub($phone_numbers, $fields = []) {
    $api_config = [
        'api_username' => 'YOUR API LOGIN',
        'api_password' => 'YOUR API PASSWORD',
        'check_types' => isset($_GET['type']) ? [$_GET['type']] : ['all'],
    ];
    $api = new TCPA_API($api_config);
    return $api->mass_scrub($phone_numbers, $fields);
}
Download SDK

Our public API servers have limits for inbound calls.
Single scrub endpoints are limiting every client with 50 calls/second.
Mass scrub endpoints are limiting every client with 5 calls/second.

You can get a dedicated API to take off all limits!
Dedicated server price is $250 per month.

Contact us to request your dedicated server!