Overview

Whitepages Pro APIs allow direct access to the most comprehensive and accurate identity data for people and businesses including the best mobile phone data available anywhere. Using a RESTful interface, the Whitepages Pro API allows flexible integration into your business systems via JSON response. This protocol is simple to use and accessible from any common web programming language on any machine with Internet access.

Base URL

Copy

https://proapi.whitepages.com

Authentication

Whitepages controls access to the API and data via an API Key. The API key is the primary data authentication method for your account. Also your usage is recorded and reported via the API Key. You can request the API key here.

Errors

Possible error responses for Whitepages Pro API requests and what they mean:

Error Responses

HTTP CODE

ERROR NAME

Likely Cause

400

InvalidParametersError

Parameter called incorrectly

400

InputFieldError

Incorrect parameter information, such as non-existent area code on a phone number

400

InputError

No parameters given

400

Internal Error

If there is an internal error while performing the checks

401

Bad request

If ';' used as parameter separator in request. non UTF-8 encoded request

402

Payment required

API Key has exceeded its quota

403

AuthError

API Key is not authorized for that request or expired

403

QuotaExceededError

API Key has exceeded its quota

500

ServerUnavailable

Whitepages Pro API temporarily unavailable

Pass Through Parameters

Developers can also pass custom parameters for tracking purposes. Typical scenarios we see customers use this feature for are:

Know which department or specific customer of yours is making the queries

Pass internal parameters, like OrderId, so that usage queries can later be tied to specific Whitepages Pro queries, allowing for easy review of historic decisioning.

We recommend using format like ‘__’ (double under score) or “customerName_parameterName” to future proof against parameters we might add. These parameters can be accessed as part of the JSON response for Identity Check and Lead Verify products. They can also be accessed via the Lookups report available for your account here: https://pro.lookup.whitepages.com/accounts/

FAQs

How do I get an API Key?

We have multiple APIs available. To make sure you get the right key that fits your use case:

You are billed for each API call you make. The cost per API call depends on API query and volume.

What encryption options are available for Pro APIs?

Whitepages recommends all Pro API users interact with the system using HTTPS over TLS 1.2 using a high strength cipher, but supports HTTP and HTTPS over TLS 1.0 and 1.1. Use of HTTP or HTTPS over TLS 1.1 or earlier may compromise the confidentiality of the communications.