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

# get_phone_type Tool

> Check if a phone number is residential or business

The `get_phone_type` tool returns whether a phone number is registered as residential or business. This is useful for B2B campaigns or compliance scenarios where different rules apply.

## When to Use

* B2B campaigns that should only target business numbers
* Compliance scenarios where residential vs business distinction matters
* Lead qualification and routing decisions

## Parameters

<ParamField body="phone" type="string" required>
  10-digit North American phone number to check (e.g., `"5039367187"`).
</ParamField>

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

## Response

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

<ResponseField name="phone" type="string">
  The phone number checked.
</ResponseField>

<ResponseField name="type" type="string">
  * `R` - Residential
  * `B` - Business
  * `U` - Unknown
</ResponseField>

<ResponseField name="typeDescription" type="string">
  Human-readable description of the type.
</ResponseField>

<ResponseField name="isResidential" type="boolean">
  `true` if the number is residential.
</ResponseField>

<ResponseField name="isBusiness" type="boolean">
  `true` if the number is a business line.
</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>

## Examples

<Tabs>
  <Tab title="Request">
    ```json theme={null}
    {
      "phone": "5039367187"
    }
    ```
  </Tab>

  <Tab title="Residential">
    ```json theme={null}
    {
      "success": true,
      "phone": "5039367187",
      "type": "R",
      "typeDescription": "Residential phone number",
      "isResidential": true,
      "isBusiness": false
    }
    ```
  </Tab>

  <Tab title="Business">
    ```json theme={null}
    {
      "success": true,
      "phone": "5039367187",
      "type": "B",
      "typeDescription": "Business phone number",
      "isResidential": false,
      "isBusiness": true
    }
    ```
  </Tab>
</Tabs>

## Usage Notes

* Some numbers may return `U` (Unknown) if classification data is not available
* Business numbers may have different DNC exemptions depending on your campaign type
* Consider combining with `scrub_phone_numbers` for complete compliance checking