Skip to main content
The 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

phoneNumbers
string[]
required
Phone numbers in 10-digit North American format (e.g., "8663625478").
loginId
string
API key. Only required if not provided via the x-dncscrub-api-key HTTP header.
campaignId
number
Campaign ID in DNCScrub for usage tracking and sensitivity configuration.
projId
string
Project ID in DNCScrub for usage tracking and sensitivity configuration.

Response

success
boolean
Whether the API call succeeded.
results
array
Array of phone check results (when successful).
errorCode
string
Machine-readable error code (when failed).
errorMessage
string
Human-readable error description (when failed).

Error Codes

CodeDescription
MISSING_API_KEYNo API key provided in header or parameter
INVALID_API_KEYThe API key is invalid or unauthorized
API_ERRORDNCScrub API returned an error
MISSING_INPUTRequired parameters are missing

Examples

{
  "phoneNumbers": ["8663625478", "5551234567"]
}

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)