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
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Confidence Scores
description: How to interpret person, phone, and email confidence scores
lifecycle: current
topic: person
keywords:
- "confidence score"
- "match score"
- "how accurate is a result"
- "score interpretation"
---

Person search responses include confidence scores on three levels: the person record itself, each phone number, and each email address. All scores range from **0 to 100** and represent relative confidence — a higher score means stronger evidence of association.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: Filter by Age Range
description: Narrow person search results using minimum and maximum age filters
lifecycle: current
topic: person
keywords:
- "filter by age"
- "age range"
- "min age max age"
---

Use the `min_age` and `max_age` parameters to filter person search results by age range. This is useful when you need to find individuals within a specific age bracket.
Expand Down
7 changes: 7 additions & 0 deletions content/docs/documentation/person-search/fuzzy-matching.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Fuzzy Matching
description: Broaden person search results with phonetic, nickname, and misspelling matching
lifecycle: current
topic: person
keywords:
- "fuzzy matching"
- "nickname matching"
- "misspelled name"
- "phonetic match"
---

Use the `include_fuzzy_matching` parameter to enable fuzzy name matching. When enabled, the search runs additional phonetic, nickname, and common misspelling matching logic at the cost of additional latency.
Expand Down
7 changes: 7 additions & 0 deletions content/docs/documentation/person-search/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Person Search
description: Look up individuals by name, phone, or address
lifecycle: current
topic: person
keywords:
- "person search"
- "people search"
- "find a person"
- "look up a person"
---

The Person Search API finds matching records in the Whitepages dataset based on name, location, phone number, or address. Use it to verify identities, find contact information, or enrich customer data.
Expand Down
7 changes: 7 additions & 0 deletions content/docs/documentation/person-search/pagination.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Pagination
description: Page through person search results using the page and page_size parameters
lifecycle: current
topic: person
keywords:
- "pagination"
- "page through results"
- "page size"
- "next page of results"
---

Person search returns up to 15 results per request by default. Use the `page` and `page_size` parameters to retrieve additional results when a query matches more records than a single page can return.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: Search for Person by Partial Name
description: Search for people using partial or incomplete name information
lifecycle: current
topic: person
keywords:
- "partial name search"
- "incomplete name"
- "first name last name search"
---

When you only have partial name information, use the individual name parameters (`first_name`, `middle_name`, `last_name`) to search more precisely than using the combined `name` parameter.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Reverse Phone Lookup
description: Find the owner of a phone number
lifecycle: current
topic: person
keywords:
- "reverse phone lookup"
- "phone search"
- "who owns this number"
- "find owner of a phone number"
---

Use the `phone` parameter to perform a reverse phone lookup and identify who owns a phone number. This returns person records associated with the phone number, including their name, address, and other contact information.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Search by Address
description: Find people by current or historical addresses
lifecycle: current
topic: person
keywords:
- "search by address"
- "who lives at this address"
- "residents at an address"
- "historical addresses"
---

Use address parameters to find people associated with a specific location. By default, searches match only current addresses. Enable `include_historical_locations` to also search historical addresses.
Expand Down
7 changes: 7 additions & 0 deletions content/docs/documentation/person-search/search-by-radius.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
title: Search by Radius
description: Find people within a specified distance of a location
lifecycle: current
topic: person
keywords:
- "search by radius"
- "people near a location"
- "proximity search"
- "distance search"
---

Use the `radius` parameter to find people within a specific distance of a location. This enables proximity-based searches, such as finding all people within 10 miles of a given address or city.
Expand Down
8 changes: 8 additions & 0 deletions content/docs/documentation/property-search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
title: Property Search
description: Get ownership and resident data for any property
icon: House
lifecycle: current
topic: property
keywords:
- "property search"
- "who owns this property"
- "property owner"
- "ownership data"
- "residents at a property"
---

The Property Search API returns ownership and resident information for a given property. Use it to identify property owners, find current residents, or verify property details.
Expand Down
8 changes: 8 additions & 0 deletions content/docs/references/account/get_account_usage_data.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
---
lifecycle: current
topic: account-billing
keywords:
- "account usage"
- "usage data"
- "remaining quota"
- "how many queries left"
- "query count"
title: Retrieve usage data for a specific time range
description: |-
Retrieve API usage data for a specified date range.
Expand Down
7 changes: 7 additions & 0 deletions content/docs/references/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: Authentication
description: Learn how to authenticate your requests to the Whitepages API.
icon: KeyRound
lifecycle: current
topic: account-billing
keywords:
- "authentication"
- "api key"
- "x-api-key header"
- "how to authenticate"
---

import { Callout } from "fumadocs-ui/components/callout";
Expand Down
6 changes: 6 additions & 0 deletions content/docs/references/billing-prior-to-2026-06-01.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
title: Billing Policy For Usage Prior to 2026-06-01
description: Billing rules that applied to usage on or before May 31, 2026.
lifecycle: deprecated
topic: account-billing
keywords:
- "legacy billing"
- "old billing policy"
- "billing before 2026-06-01"
---

import { Callout } from "fumadocs-ui/components/callout";
Expand Down
7 changes: 7 additions & 0 deletions content/docs/references/billing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: Billing
description: Understand how API usage is tracked and billed.
icon: CreditCard
lifecycle: current
topic: account-billing
keywords:
- "billing"
- "how am I billed"
- "usage tracking"
- "what counts as billable"
---

import { Callout } from "fumadocs-ui/components/callout";
Expand Down
5 changes: 5 additions & 0 deletions content/docs/references/events/get_event.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
lifecycle: current
topic: deed-events
keywords:
- "event by id"
- "event details"
title: Retrieve a single event by ID
description: Return a single event by its unique identifier.
full: true
Expand Down
5 changes: 5 additions & 0 deletions content/docs/references/events/search_events.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
lifecycle: current
topic: deed-events
keywords:
- "search events"
- "event query"
title: Search all deed events
description: |-
Search historical deed events by region and optional filters.
Expand Down
1 change: 1 addition & 0 deletions content/docs/references/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"rate-limits",
"billing",
"support-and-incident-response",
"versioning",
"person-v2",
"webhooks",
"events",
Expand Down
6 changes: 6 additions & 0 deletions content/docs/references/person-v2/get_person_by_id_v2.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
---
lifecycle: current
topic: person
keywords:
- "person by id"
- "person details"
- "hydrate person"
title: Gets person details by id
description: Retrieve detailed person information by Whitepages person ID.
full: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
---
lifecycle: current
topic: person
keywords:
- "reverse phone lookup"
- "phone search"
- "who lives at this address"
- "people search"
- "name lookup"
- "address lookup"
- "find a person"
title: Search for a person by name, phone number, and address
description: Retrieve person information with match scores and enriched emails.
full: true
Expand Down
5 changes: 5 additions & 0 deletions content/docs/references/property-v2/get_property_by_id_v2.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
lifecycle: current
topic: property
keywords:
- "property by id"
- "property details"
title: Get property details by ID
description: |-
Retrieve detailed property information by Whitepages property ID.
Expand Down
8 changes: 8 additions & 0 deletions content/docs/references/property-v2/search_property_v2.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
---
lifecycle: current
topic: property
keywords:
- "who owns this property"
- "property owner"
- "property search"
- "ownership info"
- "residents at an address"
title: Search for property by address
description: |-
Search for property by address parameters.
Expand Down
24 changes: 18 additions & 6 deletions content/docs/references/rate-limits.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
---
title: Rate Limits
description: Understand the rate limiting policies for the Whitepages API.
description: Understand the rate limiting policies for the Whitepages API, including monthly query limits and trial exhaustion.
icon: Gauge
lifecycle: current
topic: account-billing
keywords:
- "rate limit"
- "429 too many requests"
- "monthly query limit"
- "limit exceeded"
- "trial exhausted"
- "trial ran out"
- "out of queries"
- "quota exceeded"
---

import { Callout } from "fumadocs-ui/components/callout";
Expand All @@ -23,20 +34,21 @@ When you exceed the rate limit, the API returns a `429 Too Many Requests` status
exponential backoff in your application for best results.
</Callout>

## Monthly Query Limits
## Monthly Query Limits & Trial Exhaustion

Your API plan includes a monthly query limit. When exceeded, you will receive:
Your API plan includes a monthly query limit, and trial keys include a fixed trial allowance. When you exhaust either, the API returns:

```json
{
"message": "Limit Exceeded"
}
```

This indicates you have hit your monthly query limit. You can either:
This `Limit Exceeded` response means you have used up your monthly query limit or your trial allowance. It is distinct from the `429 Too Many Requests` response above: `429` is short-term throttling that clears on its own, while `Limit Exceeded` persists until your quota resets or you upgrade. You can either:

- Wait until the next month when your limit resets
- Contact support for additional queries or a plan upgrade
- Wait until the next month, when a plan's monthly limit resets
- [Purchase a plan or additional queries](/documentation/purchasing-api), or contact support at api@whitepages.com
- If you are on a trial, [purchase a plan](/documentation/purchasing-api) to keep going once your trial allowance is exhausted

## Best Practices

Expand Down
4 changes: 4 additions & 0 deletions content/docs/references/regions/list_counties.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
lifecycle: current
keywords:
- "list counties"
- "counties by state"
title: List counties for a state
description: Retrieve a list of counties for a given state.
full: true
Expand Down
4 changes: 4 additions & 0 deletions content/docs/references/regions/list_states.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
lifecycle: current
keywords:
- "list states"
- "supported states"
title: List all US states and territories
description: Retrieve a list of all US states and territories.
full: true
Expand Down
Loading
Loading