Get started

    API Endpoint
         "datazapp api endpoint URL>"

Phone Scrub Service flags phone numbers inadvisable to call and identifies the phone type (Cell, Landline, VOIP, etc.)

Please note: the service does not guarantee legal compliance nor does Datazapp accept liability for telemarketing practices. The service is meant to be a risk-mitigation tool and improves call connectivity by flagging risky numbers against a master suppression database of do-not-dial phone numbers.

Sign Up: Register for a free account at https://www.datazapp.com. If you’re already registered, sign into your account.

Request API Access: Send an email to [email protected] with your user ID or email address. Use “Requesting API” as the subject line.

Verification Process: Our support team will verify your details and enable API access for your account. Once approved, you will receive a confirmation email containing instructions on how to connect.

Authentication All requests to the API must include an API key in the request header for authentication.

API Rate Limit: The Phone Scrub API allows one request per second, accommodating up to 500 phones per request using a JSON data array.

Optimal Performance Tip: For smoother operation, kindly group up to 100 phone numbers in a single request per second. This ensures an efficient and effective use of the API.

Important Note: The phone scrub API does not detect disconnected phone numbers.

The DataZapp API utilizes the standard HTTP Post method with JSON data format.

To use this API, you need an API key. Please contact us at [email protected] to get your API key.

Phone Scrub API Request

Query Parameters

Request                 
{
    "ApiKey": "Your API key",
    "AppendModule": "PhoneScrub",
    "Data": [
        {
            "Phone": "3862621448"
        },
        {
            "Phone": "386XXXXXXX"
        },
        {
            "Phone": "386XXXXXXX"
        }
    ]
}

Parameter	Type	Required	Description
ApiKey	string	Yes	Your unique API key for authentication.
AppendModule	string	Yes	Specifies the module to use; set to “PhoneScrub”.
Data	array	Yes	An array of objects representing phone numbers to scrub.
Phone	string	Yes	The phone number to be scrubbed.

Response

Query Parameters

                    

Response

{
    "header": {
        "Status": 0,
        "Message": null
    },
    "ResponseDetail": {
        "App": 0,
        "Token": "xxxxxx",
        "Data": [
            {
                "FormattedPhone": "3862621448",
                "Phone": "3862621448",
                "PhoneType": "U",
                "DoNotCall": "N"
            },
            {
                "FormattedPhone": "386XXXXXXX",
                "Phone": "386XXXXXXX",
                "PhoneType": "U",
                "DoNotCall": "N"
            },
            {
                "FormattedPhone": "386XXXXXXX",
                "Phone": "386XXXXXXX",
                "PhoneType": "U",
                "DoNotCall": "N"
            }
        ],
        "OrderAmount": "$0.00",
        "Count": 1,
        "Message": null,
        "ProcessedTime": "In milliseconds"
    },
    "Status": true,
    "Message": null
}

Field	Type	Description
header	object	Contains metadata about the API response.
Status	integer	Indicates the status of the request (0 for success).
Message	string	Additional information or error messages.
ResponseDetail	object	Detailed information about the phone scrubbing results.
App	integer	Application code.
Token	string	Unique identifier for the transaction.
Data	array	Array of objects containing scrubbed phone information.
FormattedPhone	string	Masked input phone number.
Phone	string	Formatted phone number.
PhoneType	string	Phone type code (“U” for unknown).
DoNotCall	string	Do-not-call status (“N” for not on the do-not-call list).
OrderAmount	string	Order amount (formatted as currency).
Count	integer	Number of phone numbers processed.
Message	string	Additional information or error messages.
ProcessedTime	string	Processing time in milliseconds.
Status	boolean	Overall status of the response (true for success).
Message	string	Additional information or error messages at the top level.

Call Options Definition

Label	Description
L	Fixed Landline/Wireline Number
W	Wireless or Cell Number
V	VOIP Phone such as Google Voice/Skype
T	Toll Free Number
I	Invalid Number
X	Risky Phone Number – Prior TCPA/DNC Litigator or Frequent Complainer or Attorney Phone#
U	Unknown Phone Type; Most likely disconnected phone number

Do Not Call Status Label

Label	Description
Y	Do Not Call
N	Not Do Not Call

Errors

The API uses the following error codes:

Error Code	Meaning
Module does not exist.	The specified module does not exist or Invalid AppendModule Name.
User not found.	Invalid API Key or The user associated with the API key was not found
Getting 401 Error.	The user does not have access to this API
Append Request not found	Invalid Token: The specified append request could not be found
Improper JSON Data. Please check.	The JSON data in the request does not match the expected format.
It seems like API has an issue. Please contact Support.	There is an issue with the API. Contact the [email protected]