The tcpa_authority tool provides phone number reassignment using carrier deactivation data.
Parameters
Array of objects containing phone numbers and consent dates.
10-digit North American phone number (e.g., "5039367187").
Date consent was given in YYYYMMDD, MM/DD/YYYY, or YYYY-MM-DD format.
API key. Only required if not provided via the x-dncscrub-api-key HTTP
header.
Response
Whether the API call succeeded.
Array of results, one per phone number.
The phone number checked.
true - Number has been reassigned (do not call)false - Number has not been reassigned (safe to call)null - Insufficient data to determine
Whether this is a valid, callable phone number.
true if valid and not reassigned.
Wireless, VoIP, Landline, Paging, or Unknown.
Original carrier the number was assigned to.
City based on original number assignment.
Two-letter ISO country code.
Timezone in IANA format (e.g., America/Los_Angeles).
Machine-readable error code (when failed).
Human-readable error description (when failed).
Examples
{
"phoneNumbers": [
{
"phoneNumber": "5039367187",
"consentDate": "2023-06-15"
}
]
}
{
"success": true,
"results": [
{
"phone": "5039367187",
"isReassigned": false,
"isValid": true,
"isSafeToCall": true,
"lineType": "Wireless",
"carrier": "Verizon Wireless",
"city": "Portland",
"state": "OR",
"country": "US",
"timezone": "America/Los_Angeles",
"utcOffset": -480
}
]
}
Usage Notes
- Requires Reassigned Authority access on your DNCScrub account
