Routes
Complete overview of all available Whitepages API endpoints organized by category.
The Whitepages API provides comprehensive access to person and property data with enterprise-grade authentication and usage tracking.
Before using the API, review the Authentication, Rate Limits, and Billing documentation.
Account API
Account management endpoints for retrieving usage statistics.
Events API
Search all deed events
Search historical deed events by region and optional filters.
Retrieve a single event by ID
Return a single event by its unique identifier.
Internal Ledger API
Internal control-plane endpoints over the access-events ledger. Mounted outside any AG-forwarded path (the outer ring of the two-ring auth model) and additionally gated by a shared bearer token (the inner ring). Issued only to known callers: staff tooling, the in-house ledger->Zuora cron, and the api-management service.
Raw access events for a single API key in a time window
Return one page of access-event rows for ``api_key_id`` in ``[start, end)``.
Raw access events across all keys, paged
Return one page of access-event rows in ``[start, end)`` across all keys.
Person V2 API
Search for a person by name, phone number, and address
Retrieve person information with match scores and enriched emails.
Gets person details by id
Retrieve detailed person information by Whitepages person ID.
Property V2 API
Get property details by ID
Retrieve detailed property information by Whitepages property ID.
Search for property by address
Search for property by address parameters.
Regions API
List all US states and territories
Retrieve a list of all US states and territories.
List counties for a state
Retrieve a list of counties for a given state.
Webhooks API
Manage webhook subscriptions for near-live property event notifications. Register an HTTPS endpoint, choose an event type and geographic region, and receive POST notifications when matching events occur. Currently supports deed.* events in Texas counties.
Create a webhook subscription
Register a new webhook subscription for property events. The endpoint URL is validated on creation — it must be reachable and return a 2xx response. Currently supports `deed.*` events scoped to Texas counties.
List webhook subscriptions
List all webhook subscriptions for the authenticated account. Optionally filter by status or event type.
Get a webhook subscription
Retrieve a single webhook subscription by its ID.
Update a webhook subscription
Partially update a webhook subscription. Only provided fields are modified; omitted fields remain unchanged.
Delete a webhook subscription
Permanently delete a webhook subscription. This action cannot be undone.
Test a webhook delivery
Send a synthetic notification to the webhook endpoint. Uses the same payload format as real deliveries with a fixed event ID.