Skip to main content

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.

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

CodeNameDescription
CCleanPhone number is not on any DNC list, is not Wireless or VoP, and is safe to call
XIndustry ExemptionIndustry exemption applied to an otherwise DNC number

​
Wireless \ VoIP Indicators

CodeNameDescription
WWirelessWireless number not in any DNC database. Not in a state that restricts solicitations to wireless numbers.
LWireless ProhibitedWireless 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)
FEBR + Wireless RestrictedValid 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)
GEBR + Wireless/VoIPValid 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
HEBR Override + Wireless/VoIPWireless or VoIP number that is also a valid EBR, overriding an otherwise DNC number
VEBR Override + Wireless RestrictedValid 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)

CodeNameDescription
EEBR ValidCurrently valid EBR, not on a Do Not Call list. Number can be called
OEBR OverrideEBR 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.
CodeNameDescription
YVoIPVoIP number not in any DNC databases (or it has been overridden by an industry exemption). Requires VoIP scrubbing to be purchased

​
Industry Exemptions

CodeNameDescription
XIndustry ExemptionIndustry exemption applied to an otherwise DNC number

​
Do Not Call

CodeNameDescription
DDo Not CallPhone number is on a DNC database. The Reason field provides additional details. Litigator numbers have “Litigator” in the Reason field
PInternal DNCInternal DNC (also called Project DNC) database match. No further checks are performed once a number is found as Internal DNC

​
Invalid or Blocked

CodeNameDescription
BBlockedNumber 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
IInvalidArea code is not active, reserved, or is a special use phone number pattern (e.g., 555-5555)
MMalformedNumber is not 10 numerical digits

​
Response Fields

​
Phone Information

FieldTypeDescription
PhoneStringThe phone number that was scrubbed
ResultCodeStringThe scrub result code (see above)
ReservedStringYour unique identifier if provided, otherwise empty
ReasonStringDetailed reason for the result code

​
Location Information

FieldTypeDescription
RegionAbbrevStringState/province abbreviation (e.g., “CA”, “NY”)
CountryStringCountry code (e.g., “US”, “CA”)
LocaleStringCity or locality name

​
Carrier Information

FieldTypeDescription
CarrierInfoStringCarrier information in format: ID;TYPE;"Name:Name"
LineTypeStringWireless, VoIP, or AllOther
IsWirelessOrVoIPString1 if wireless or VoIP, 0 if landline

​
Timezone Information

FieldTypeDescription
TZCodeStringTimezone code
UTCOffsetStringUTC offset in minutes (e.g., “-420” for Pacific)
CallingWindowStringAllowed calling times in format HH:MM-HH:MM
CallingTimeRestrictionsStringCalling time restriction code
DoNotCallTodayString1 if should not be called today, 0 otherwise

​
EBR Information

FieldTypeDescription
EBRTypeStringType of EBR if applicable

​
Other Fields

FieldTypeDescription
NewReassignedAreaCodeStringNew 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"
PartDescription
9740Carrier ID
RBOCCarrier Type (RBOC, WIRELESS, CLEC, etc.)
"AT&T California:AT&T California"Carrier name(s)

​
Carrier Types

TypeDescription
RBOCRegional Bell Operating Company (major landline carriers)
WIRELESSWireless/cellular carrier
CLECCompetitive Local Exchange Carrier
VOIPVoice over IP provider
CABLECable company providing phone service

​
Line Types

ValueDescription
WirelessMobile/cellular phone
VoIPVoice over IP line
AllOtherLandline or other non-wireless

​
Timezone Codes

CodeTimezone
1Atlantic
2Eastern
3Central
4Mountain/Pacific
5Alaska
6Hawaii

​
Example Response Analysis

{
  "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)