Phone Scrub API

Get Started

Datazapp’s Phone Scrub API flags phone numbers that may be inadvisable to call and identifies phone type, such as cell, landline, VOIP, toll-free, invalid, risky, or unknown.

The Phone Scrub API allows one request per second and supports up to 500 phones per request. For smoother performance, Datazapp recommends grouping up to 100 phone numbers per request.

Please note: this service does not guarantee legal compliance, nor does Datazapp accept liability for telemarketing practices. It is intended as a risk-mitigation tool and does not detect disconnected phone numbers.

API Endpoint

Replace the placeholder below with your assigned Datazapp API endpoint URL.

Endpoint - you'll get this from your account manager

<datazapp api endpoint URL>

Phone Scrub API Request

Submit your API key, append module, and phone number records in the request body.

JSON Request Body

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

Request Parameters

Parameter	Required	Type	Description
`ApiKey`	Yes	String	Your assigned Datazapp API key.
`AppendModule`	Yes	String	Use `PhoneScrub`.
`Data`	Yes	Array	Contains submitted phone records to scrub.
`Phone`	Yes	String	The phone number to be scrubbed.

API Response

A successful response includes formatted phone values, phone type codes, Do Not Call status, order amount, count, and processing time.

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

Response Fields

Field	Type	Description
`header.Status`	Integer	Indicates request status.
`header.Message`	String	Additional information or error message.
`ResponseDetail.App`	Integer	Application reference value returned by the system.
`ResponseDetail.Token`	String	Unique transaction reference token.
`ResponseDetail.Data`	Array	Array of returned phone scrub results.
`FormattedPhone`	String	Formatted or masked input phone number.
`Phone`	String	Returned phone number.
`PhoneType`	String	Returned phone type code.
`DoNotCall`	String	Do Not Call status code.
`OrderAmount`	String	Order amount formatted as currency.
`Count`	Integer	Number of phone numbers processed or charged.
`ProcessedTime`	String	Processing time in milliseconds.
`Status`	Boolean	Overall response status.
`Message`	String	Null when successful, or error detail when applicable.

Phone Type Codes

Code	Meaning
`L`	Fixed landline / wireline number.
`W`	Wireless or cell number.
`V`	VOIP phone such as Google Voice or Skype.
`T`	Toll-free number.
`I`	Invalid number.
`X`	Risky phone number, such as prior TCPA/DNC litigator, frequent complainer, or attorney phone number.
`U`	Unknown phone type; most likely disconnected phone number.

Do Not Call Status

Y — Do Not Call The number is flagged as Do Not Call.

N — Not Do Not Call The number is not flagged as Do Not Call.

Errors

The API may return one of the following error messages if the request cannot be completed.

Module does not exist.The specified module does not exist or the AppendModule name is invalid.

User not found.The API key is invalid 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.The specified append request could not be found or the token is invalid.

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 may be an issue with the API. Contact Datazapp support for assistance.