Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,9 @@ lint:
bun run lint
rg --files -g '*.nix' -g '!.*' -g '!bun.nix' | xargs -L 1 statix check --

# Check heading case in content/docs/ (house style is sentence case)
check-heading-case:
bun run scripts/check-heading-case.ts

# Run all validation checks. `check-types` pulls in `build` as a dependency.
validate: check-types check-format lint test check-corpus check-bun-nix
validate: check-types check-format lint test check-corpus check-bun-nix check-heading-case
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<img src="https://i.imgur.com/SoSJ7ye.png" alt="Whitepages" width="300" />
</p>

<h3 align="center">API Documentation</h3>
<h3 align="center">Whitepages Pro API Documentation</h3>

<p align="center">
Official documentation for the Whitepages API<br />
Official documentation for the Whitepages Pro API.<br />
<a href="https://api.whitepages.com/docs">View Documentation</a>
</p>

Expand All @@ -15,6 +15,17 @@

---

## About the Whitepages Pro API

The Whitepages Pro API is a U.S. people and property data API. It returns phone
numbers, email addresses, current and historical addresses, property ownership,
and residents. The data comes from public and legal records.

Coverage is United States only, and coverage varies by record. The API is not an
FCRA-regulated product and is not intended for credit, underwriting, employment,
housing, or insurance decisions. See the [Terms of Service](https://www.whitepages.com/terms)
for full details, or contact [api@whitepages.com](mailto:api@whitepages.com) with questions.

## Development

### Prerequisites
Expand Down
3 changes: 3 additions & 0 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions content/docs/changelog/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ The endpoint covers the North American Numbering Plan. A number outside it is
refused with HTTP 400 rather than searched. Each successful lookup bills one
unit, whether or not it found anyone.

See [Reverse Phone Lookup](/documentation/person-search/reverse-phone-lookup)
for when to use this endpoint and when person search is still the better fit.
See [Phone Search](/documentation/phone-search) for when to use this endpoint
and when person search is still the better fit.

---

Expand Down Expand Up @@ -96,7 +96,7 @@ a different address, and `25` when the address you searched for is not
deliverable. Both are `null` when the address could not be checked,
which happens when the request carries no `street`, or a `street` with
neither a `city` nor a `zipcode` to place it. The property is still
returned. See [Property Search](/documentation/property-search#match-confidence).
returned. See [Property Search API](/documentation/property-search#match-confidence).

**New `strict_match` request parameter.** Set `strict_match=true` to
receive only the address you searched for or an address in the same
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
related:
- /documentation/agentic-guidance/integration-guide
- /documentation/agentic-guidance/entity-shapes
- /documentation/phone-search
- /references/person-v2/search_person_by_name_phone_or_address_v2
- /references/property-v2/search_property_v2
title: Capability Map
Expand Down Expand Up @@ -42,6 +43,7 @@ question you are asking; the row below says which.
| ---------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------- |
| Find out what a phone number is | `GET /v2/phone/{phone}` | path `phone` (any common spelling) |
| Rank people against a phone number | `GET /v2/person/` | `phone=`, optionally with `name` or location to narrow |
| Find a person by email | `GET /v2/person/` | `email=`, optionally with `name` or location to narrow |
| Find who lives at an address | `GET /v2/person/` | `street`, `city`, `state_code`, `zipcode` |
| Find a person by name | `GET /v2/person/` | `name`, or `first_name` / `middle_name` / `last_name` (+ location) |
| Narrow a person search | `GET /v2/person/` | `min_age` / `max_age`, `include_fuzzy_matching`, `strict_match`, `include_historical_locations`, `radius` |
Expand Down
16 changes: 8 additions & 8 deletions content/docs/documentation/events/event-payload.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ full event object shown below.

</Callout>

## Top-Level Fields
## Top-level fields

| Field | Type | Description |
| ------------ | ------ | ----------------------------------------------------------------------------- |
Expand Down Expand Up @@ -90,7 +90,7 @@ The `property` object contains details about the property involved in the deed e
| `lot_sqft` | integer | Lot size in square feet |
| `property_purpose` | string | Property type |

### Address Fields
### Address fields

| Field | Type | Description |
| -------- | ------ | --------------------- |
Expand All @@ -100,14 +100,14 @@ The `property` object contains details about the property involved in the deed e
| `zip` | string | ZIP code |
| `county` | string | County name |

### Geolocation Fields
### Geolocation fields

| Field | Type | Description |
| ----- | ------ | ----------- |
| `lat` | number | Latitude |
| `lng` | number | Longitude |

### Legal Description Fields
### Legal description fields

| Field | Type | Description |
| ------ | ------ | ---------------------------------- |
Expand Down Expand Up @@ -154,7 +154,7 @@ The `parties` array lists individuals or entities involved in the deed transacti
| `person_id` | string | No | Whitepages person ID, if resolved |
| `addresses` | array | No | Associated addresses |

### Party Address Fields
### Party address fields

| Field | Type | Required | Description |
| -------------- | ------ | -------- | ---------------------- |
Expand Down Expand Up @@ -193,14 +193,14 @@ The `detail` object contains transaction-specific information from the deed reco
| `consideration` | number | Transaction amount in USD |
| `transaction_reason` | object | Transaction classification |

### Document Type Fields
### Document type fields

| Field | Type | Description |
| ---------- | ------ | -------------------- |
| `category` | string | Normalized category |
| `text` | string | Human-readable label |

### Transaction Reason Fields
### Transaction reason fields

| Field | Type | Description |
| ---------- | ------ | -------------------- |
Expand All @@ -225,7 +225,7 @@ The `detail` object contains transaction-specific information from the deed reco
}
```

## Full Example
## Full example

```json title="Complete event response"
{
Expand Down
10 changes: 5 additions & 5 deletions content/docs/documentation/events/event-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Understand the different types of property deed events

Every event has an `event_type` field that describes the kind of property deed activity it represents. Event types follow a `category.action` format.

## Available Event Types
## Available event types

| Event Type | Description |
| ---------- | ------------------------------------------------------------------- |
Expand All @@ -21,9 +21,9 @@ Every event has an `event_type` field that describes the kind of property deed a
subscriptions to automatically receive all current and future event types.
</Callout>

## Using Event Types
## Using event types

### In Webhook Subscriptions
### In webhook subscriptions

When [creating a webhook](/documentation/webhooks/create-webhook), the `event_type` parameter controls which events are delivered to your endpoint:

Expand All @@ -38,7 +38,7 @@ curl -X POST 'https://api.whitepages.com/v1/webhooks/' \
}'
```

### In Event Payloads
### In event payloads

The `event_type` field appears in every event object, whether retrieved directly or delivered via webhook:

Expand All @@ -51,6 +51,6 @@ The `event_type` field appears in every event object, whether retrieved directly
}
```

## Distinguishing Test Events
## Distinguishing test events

Events generated by the [test webhook endpoint](/documentation/webhooks/test-webhook) include a `"test": true` field. Real events do not include this field. Use it to filter test events in your processing pipeline.
4 changes: 2 additions & 2 deletions content/docs/documentation/events/get-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Use the `GET /v1/events/{event_id}` endpoint to retrieve a single event by its I
Response](/references/support-and-incident-response) page.
</Callout>

## Basic Usage
## Basic usage

Retrieve an event by its ID:

Expand All @@ -25,7 +25,7 @@ curl 'https://api.whitepages.com/v1/events/evt_abc123' \
--header 'X-Api-Key: YOUR_API_KEY'
```

## Path Parameters
## Path parameters

| Parameter | Type | Required | Description |
| ---------- | ------ | -------- | ------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/documentation/events/search-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Use `GET /v1/events/deed` to search historical property deed events. Filter by r
valid region values, see the [Regions API](/references/regions/list_states).
</Callout>

## Basic Usage
## Basic usage

### All deed events in a county

Expand All @@ -40,7 +40,7 @@ curl 'https://api.whitepages.com/v1/events/deed?region=county:tx.travis&property
--header 'X-Api-Key: YOUR_API_KEY'
```

## Query Parameters
## Query parameters

| Parameter | Type | Required | Description |
| ----------------- | ------- | -------- | ----------------------------------------------------------------------------------------------- |
Expand Down
25 changes: 16 additions & 9 deletions content/docs/documentation/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,16 @@ description: Get started with the Whitepages Pro API
icon: Rocket
---

The Whitepages Pro API provides access to comprehensive person and property data. Whether you're verifying identities, enriching customer records, or researching properties, our API delivers the data you need.
The Whitepages Pro API is a U.S. people and property data API. It returns phone
numbers, email addresses, current and historical addresses, property ownership,
and residents. The data comes from public and legal records.

## Get Your API Key
Coverage is United States only, and coverage varies by record. The API is not an
FCRA-regulated product and is not intended for credit, underwriting, employment,
housing, or insurance decisions. See the [Terms of Service](https://www.whitepages.com/terms)
for full details, or contact [api@whitepages.com](mailto:api@whitepages.com) with questions.

## Get your API key

To access the API, you'll need an API key. Sign up for a **free trial** at [whitepages.com/pro-api](https://www.whitepages.com/pro-api).

Expand All @@ -32,23 +39,23 @@ To access the API, you'll need an API key. Sign up for a **free trial** at [whit

<Cards>
<Card
title="Person Search"
title="Person Search API"
href="/documentation/person-search"
description="Look up individuals by name, phone, or address"
/>
<Card
title="Phone Lookup"
href="/documentation/person-search/reverse-phone-lookup"
title="Phone Search"
href="/documentation/phone-search"
description="Find out what a phone number is and who it belongs to"
/>
<Card
title="Property Search"
title="Property Search API"
href="/documentation/property-search"
description="Get ownership and resident data for any address"
/>
</Cards>

## Making Requests
## Making requests

All API requests require your API key in the `X-Api-Key` header:

Expand All @@ -59,6 +66,6 @@ curl 'https://api.whitepages.com/v2/person?name=John%20Smith' \

Responses are returned in JSON format. Each successful request consumes one billable query — see [Billing](/references/billing) for the full policy on which responses are billed.

## Next Steps
## Next steps

Ready to make your first API call? Start with the [Person Search](/documentation/person-search) tutorial, or [Phone Lookup](/documentation/person-search/reverse-phone-lookup) if you are starting from a phone number.
Ready to make your first API call? Start with the [Person Search API](/documentation/person-search) tutorial, or [Phone Search](/documentation/phone-search) if you are starting from a phone number.
18 changes: 9 additions & 9 deletions content/docs/documentation/getting-trial-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ icon: Key

This guide walks you through the process of signing up for a free trial API key. The trial gives you access to all API endpoints so you can evaluate the service before committing to a paid plan.

## Step 1: Visit the API Page
## Step 1: visit the API page

Go to [whitepages.com/pro-api](https://www.whitepages.com/pro-api) to access the API signup page.

You'll see the "Get API Access" form on the right side of the page.

## Step 2: Enter Your Contact Information
## Step 2: enter your contact information

The first form requires three pieces of information:

Expand All @@ -31,7 +31,7 @@ Fill in your details and click the **Start for Free** button.
personal email increases your chances of trial approval and faster processing.
</Callout>

## Step 3: Provide API Usage Details
## Step 3: provide API usage details

After submitting your contact information, you'll be asked to provide more details about your API needs.

Expand All @@ -49,13 +49,13 @@ Click **Access API Trial** to submit your request.
completely free during the trial period.
</Callout>

## Step 4: Check Your Email
## Step 4: check your email

After submitting the form, you'll see a confirmation message.

Check your email for instructions on how to activate your trial key.

## Step 5: Start Using Your API Key
## Step 5: start using your API key

Once you receive your API key, you can start making requests immediately. Include your key in the `X-Api-Key` header:

Expand All @@ -70,7 +70,7 @@ curl 'https://api.whitepages.com/v2/person?name=John%20Smith' \
immediately.
</Callout>

## Trial Limitations
## Trial limitations

The trial API key includes:

Expand All @@ -80,16 +80,16 @@ The trial API key includes:

For production use or higher query volumes, visit the [API Pricing](https://www.whitepages.com/pro-api/pricing/plans) page.

## Next Steps
## Next steps

<Cards>
<Card
title="Person Search"
title="Person Search API"
href="/documentation/person-search"
description="Learn how to search for individuals"
/>
<Card
title="Property Search"
title="Property Search API"
href="/documentation/property-search"
description="Look up property ownership data"
/>
Expand Down
Loading
Loading