> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dncscrub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# is_litigator Tool

> Check if phone numbers belong to known TCPA litigators

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

<ParamField body="phoneNumbers" type="string[]" required>
  Phone numbers in 10-digit North American format (e.g., `"8663625478"`).
</ParamField>

<ParamField body="loginId" type="string">
  API key. Only required if not provided via the `x-dncscrub-api-key` HTTP header.
</ParamField>

<ParamField body="campaignId" type="number">
  Campaign ID in DNCScrub for usage tracking and sensitivity configuration.
</ParamField>

<ParamField body="projId" type="string">
  Project ID in DNCScrub for usage tracking and sensitivity configuration.
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Whether the API call succeeded.
</ResponseField>

<ResponseField name="results" type="array">
  Array of phone check results (when successful).

  <Expandable title="results object">
    <ResponseField name="phone" type="string">
      The phone number that was checked.
    </ResponseField>

    <ResponseField name="isLitigator" type="boolean">
      `true` if the number belongs to a known litigator.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="errorCode" type="string">
  Machine-readable error code (when failed).
</ResponseField>

<ResponseField name="errorMessage" type="string">
  Human-readable error description (when failed).
</ResponseField>

## 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

<Tabs>
  <Tab title="Request">
    ```json theme={null}
    {
      "phoneNumbers": ["8663625478", "5551234567"]
    }
    ```
  </Tab>

  <Tab title="Success Response">
    ```json theme={null}
    {
      "success": true,
      "results": [
        { "phone": "8663625478", "isLitigator": false },
        { "phone": "5551234567", "isLitigator": true }
      ]
    }
    ```
  </Tab>

  <Tab title="Error Response">
    ```json theme={null}
    {
      "success": false,
      "errorCode": "INVALID_API_KEY",
      "errorMessage": "The provided API key is invalid or unauthorized"
    }
    ```
  </Tab>
</Tabs>

## 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)
