Scrub API Documentation
The Scrub API uses GET/POST methods and supports only HTTPS with TLS v1.2+. Determines connectivity in a flash, and you get the industry’s best in connect/disconnect information back in under 2 seconds.
Required Input Parameters:
| Parameter | Description |
|---|---|
| Output | (OPTIONAL) set to “json” or “xml”. Omitting this defaults to XML |
| Phone | 10 numeric digits ONLY |
| Token | Unique PW given by RealValidation |
Response Fields:
| Response Field | Description |
|---|---|
| Status | (See Appendix A below) |
| Error_Text | (See Appendix A below) |
| *Iscell | “Y” means Cell phone, “N” means Landline (“V” is for VoIP if enabled on account) |
| * Carrier | Service provider. Such as Verizon, AT&T, etc. |
* These fields are optional, and each can be added for an additional charge. If you would like to receive all fields, see RPV Turbo.
For more info, contact support@realvalidation or call 800.777.2770
Example: Connected Phone Line
https://api.realvalidation.com/rpvWebService/RealPhoneValidationScrub.php?phone=7275555555&token=1
234ABCD-1234-ABCD-1234-123456ABCDEFResult in XML
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>connected</status>
<error_text></error_text>
<iscell>Y</iscell>
<carrier>Verizon Wireless:6006 - SVR/2</carrier>
</response>Result in JSON
{
"status":"connected",
"error_text":{},
"iscell":"Y",
"carrier":"Verizon Wireless:6006 - SVR\/2"
}Appendix A:
| Status | Error Text | Description |
|---|---|---|
| connected | Typically connected | |
| connected-75 | Connected 75% of the time | |
| pending | Not completed yet | |
| disconnected | Typically disconnected | |
| disconnected-70 | Disconnected 70% of the time | |
| busy | Busy | |
| unreachable | Not reachable | |
| invalid phone | Phone not valid | |
| restricted | Can’t be dialed | |
| ERROR | bad phone number | |
| ERROR | missing token | |
| unauthorized | token is not valid | |
| invalid-format | phone or zip are not in a valid format | |
| invalid-phone | phone number is not valid | |
| bad-zip-code | zip code is not valid | |
| server-unavailable | various messages | Contact support |
Not super techie… integrate Scrub into your favorite CRM, forms, and apps using Zapier or Integrately.
