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

# Output Guide

> Complete reference for result codes and response fields both for API and Batch Scrub

This guide provides a complete reference for understanding the Scrub API response fields and result codes. These fields
are also the same as in our batch scrub processing that can be either done thru the DNCScrub web portal or SFTP.

Whether a call is permissible depends on the call's content. We recommend each caller review the [Consent
Chart](https://www.dncscrub.com/compliance-guide/consent-chart) in our compliance guide with their legal counsel. Our responses are oriented around the call's content being a marketing message.

## Result Codes

The `ResultCode` field indicates the overall scrub result for a phone number:

### Clean

| Code | Name               | Description                                                                      |
| ---- | ------------------ | -------------------------------------------------------------------------------- |
| `C`  | Clean              | Phone number is not on any DNC list, is not Wireless or VoP, and is safe to call |
| `X`  | Industry Exemption | Industry exemption applied to an otherwise DNC number                            |

### Wireless \ VoIP Indicators

| Code | Name                               | Description                                                                                                                                                                                                        |
| ---- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `W`  | Wireless                           | Wireless number not in any DNC database. Not in a state that restricts solicitations to wireless numbers.                                                                                                          |
| `L`  | Wireless Prohibited                | Wireless number in a US state that does not allow telephone solicitation to wireless numbers, even if manually dialed (States: WY, NJ, TX, LA, and AZ)                                                             |
| `F`  | EBR + Wireless Restricted          | Valid EBR and Wireless number in a US state that does not allow telephone solicitation to wireless numbers, even if manually dialed (States: WY, NJ, TX, LA, and AZ)                                               |
| `G`  | EBR + Wireless/VoIP                | Valid EBR and US Wireless or VoIP number, not on any DNC database (version 2+). Still cannot be called from a predictive dialer as EBRs do not constitute an exemption to those rules                              |
| `H`  | EBR Override + Wireless/VoIP       | Wireless or VoIP number that is also a valid EBR, overriding an otherwise DNC number                                                                                                                               |
| `V`  | EBR Override + Wireless Restricted | Valid EBR overriding an otherwise DNC number that is also a Wireless number in a US state that does not allow telephone solicitation to wireless numbers, even if manually dialed (States: WY, NJ, TX, LA, and AZ) |

### EBR (Existing Business Relationship)

| Code | Name         | Description                                                                                                                                      |
| ---- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `E`  | EBR Valid    | Currently valid EBR, not on a Do Not Call list. Number can be called                                                                             |
| `O`  | EBR Override | EBR Override was applied to an otherwise Do Not Call number (including an explicit EBR overriding a number in Project DNC). Number can be called |

### VoIP

VoIP should be treated the same way as wireless. Federal and state laws that apply to Wireless
apply to VoIP as well.

| Code | Name | Description                                                                                                                        |
| ---- | ---- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `Y`  | VoIP | VoIP number not in any DNC databases (or it has been overridden by an industry exemption). Requires VoIP scrubbing to be purchased |

### Industry Exemptions

| Code | Name               | Description                                           |
| ---- | ------------------ | ----------------------------------------------------- |
| `X`  | Industry Exemption | Industry exemption applied to an otherwise DNC number |

### Do Not Call

| Code | Name         | Description                                                                                                                               |
| ---- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `D`  | Do Not Call  | Phone number is on a DNC database. The `Reason` field provides additional details. Litigator numbers have "Litigator" in the Reason field |
| `P`  | Internal DNC | Internal DNC (also called Project DNC) database match. No further checks are performed once a number is found as Internal DNC             |

### Invalid or Blocked

| Code | Name      | Description                                                                                                                                                                             |
| ---- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `B`  | Blocked   | Number is in an area code not covered by the National Subscription on this project, is in a configured no-call area code, or no exemption was available in a pre-recorded call campaign |
| `I`  | Invalid   | Area code is not active, reserved, or is a special use phone number pattern (e.g., 555-5555)                                                                                            |
| `M`  | Malformed | Number is not 10 numerical digits                                                                                                                                                       |

## Response Fields

### Phone Information

| Field        | Type   | Description                                         |
| ------------ | ------ | --------------------------------------------------- |
| `Phone`      | String | The phone number that was scrubbed                  |
| `ResultCode` | String | The scrub result code (see above)                   |
| `Reserved`   | String | Your unique identifier if provided, otherwise empty |
| `Reason`     | String | Detailed reason for the result code                 |

### Location Information

| Field          | Type   | Description                                    |
| -------------- | ------ | ---------------------------------------------- |
| `RegionAbbrev` | String | State/province abbreviation (e.g., "CA", "NY") |
| `Country`      | String | Country code (e.g., "US", "CA")                |
| `Locale`       | String | City or locality name                          |

### Carrier Information

| Field              | Type   | Description                                          |
| ------------------ | ------ | ---------------------------------------------------- |
| `CarrierInfo`      | String | Carrier information in format: `ID;TYPE;"Name:Name"` |
| `LineType`         | String | `Wireless`, `VoIP`, or `AllOther`                    |
| `IsWirelessOrVoIP` | String | `1` if wireless or VoIP, `0` if landline             |

### Timezone Information

| Field                     | Type   | Description                                      |
| ------------------------- | ------ | ------------------------------------------------ |
| `TZCode`                  | String | Timezone code                                    |
| `UTCOffset`               | String | UTC offset in minutes (e.g., "-420" for Pacific) |
| `CallingWindow`           | String | Allowed calling times in format `HH:MM-HH:MM`    |
| `CallingTimeRestrictions` | String | Calling time restriction code                    |
| `DoNotCallToday`          | String | `1` if should not be called today, `0` otherwise |

### EBR Information

| Field     | Type   | Description               |
| --------- | ------ | ------------------------- |
| `EBRType` | String | Type of EBR if applicable |

### Other Fields

| Field                   | Type   | Description                            |
| ----------------------- | ------ | -------------------------------------- |
| `NewReassignedAreaCode` | String | New area code if number was reassigned |

## Reason Field Format

The `Reason` field provides detailed information about why a number was flagged. The format varies based on the result:

### National DNC

```
National (USA) 2003-06-01;;;
```

Format: `National (Country) YYYY-MM-DD;;;`

### State DNC

```
State (CA) 2020-01-15;;;
```

### Litigator

```
Litigator
```

### Multiple Reasons

When a number appears on multiple lists, reasons are concatenated:

```
National (USA) 2003-06-01;State (CA) 2020-01-15;;
```

## Carrier Information Format

The `CarrierInfo` field contains three parts separated by semicolons:

```
9740;RBOC;"AT&T California:AT&T California"
```

| Part                                | Description                               |
| ----------------------------------- | ----------------------------------------- |
| `9740`                              | Carrier ID                                |
| `RBOC`                              | Carrier Type (RBOC, WIRELESS, CLEC, etc.) |
| `"AT&T California:AT&T California"` | Carrier name(s)                           |

### Carrier Types

| Type       | Description                                               |
| ---------- | --------------------------------------------------------- |
| `RBOC`     | Regional Bell Operating Company (major landline carriers) |
| `WIRELESS` | Wireless/cellular carrier                                 |
| `CLEC`     | Competitive Local Exchange Carrier                        |
| `VOIP`     | Voice over IP provider                                    |
| `CABLE`    | Cable company providing phone service                     |

## Line Types

| Value      | Description                    |
| ---------- | ------------------------------ |
| `Wireless` | Mobile/cellular phone          |
| `VoIP`     | Voice over IP line             |
| `AllOther` | Landline or other non-wireless |

## Timezone Codes

| Code | Timezone         |
| ---- | ---------------- |
| `1`  | Atlantic         |
| `2`  | Eastern          |
| `3`  | Central          |
| `4`  | Mountain/Pacific |
| `5`  | Alaska           |
| `6`  | Hawaii           |

## Example Response Analysis

```json theme={null}
{
  "Phone": "7075276405",
  "ResultCode": "D",
  "Reserved": "",
  "Reason": "National (USA) 2003-06-01;;;",
  "RegionAbbrev": "CA",
  "Country": "US",
  "Locale": "Santa Rosa",
  "CarrierInfo": "9740;RBOC;\"AT&T California:AT&T California\"",
  "NewReassignedAreaCode": "",
  "TZCode": "4",
  "CallingWindow": "",
  "UTCOffset": "-420",
  "DoNotCallToday": "",
  "CallingTimeRestrictions": "4",
  "EBRType": "",
  "IsWirelessOrVoIP": "0",
  "LineType": "AllOther"
}
```

**Analysis:**

* **Result**: `D` = Do Not Call
* **Reason**: On National DNC since June 1, 2003
* **Location**: Santa Rosa, CA, USA
* **Carrier**: AT\&T California (landline)
* **Line Type**: Landline (`AllOther`, `IsWirelessOrVoIP` = `0`)
* **Timezone**: Pacific (code `4`, UTC-420 minutes)