is_litigator tool checks if one or more phone numbers are associated with individuals who have filed TCPA (Telephone Consumer Protection Act) or related consumer-protection lawsuits.
Parameters
Phone numbers in 10-digit North American format (e.g.,
"8663625478").API key. Only required if not provided via the
x-dncscrub-api-key HTTP header.Campaign ID in DNCScrub for usage tracking and sensitivity configuration.
Project ID in DNCScrub for usage tracking and sensitivity configuration.
Response
Whether the API call succeeded.
Array of phone check results (when successful).
Machine-readable error code (when failed).
Human-readable error description (when failed).
Error Codes
| Code | Description |
|---|---|
MISSING_API_KEY | No API key provided in header or parameter |
INVALID_API_KEY | The API key is invalid or unauthorized |
API_ERROR | DNCScrub API returned an error |
MISSING_INPUT | Required parameters are missing |
Examples
- Request
- Success Response
- Error Response
Usage Notes
- Check multiple numbers in a single request for better performance
- Results are returned in the same order as the input array
- Phone numbers should be 10 digits without formatting (no dashes, spaces, or country code)