# Whitepages Pro API Documentation

> Documentation for the Whitepages Pro API

- [Documentation](/): Whitepages Pro API Documentation
- [Changelog](/changelog): Notable changes to the Whitepages Pro API, newest first.
- [FAQ](/documentation/faq): Answers to the questions integrators hit most often.
- [Getting Started](/documentation/getting-started): Get started with the Whitepages Pro API
- [Getting a Trial API Key](/documentation/getting-trial-api-key): Step-by-step guide to signing up for a free Whitepages Pro API trial
- [Guides](/documentation/guides): In-depth guides for using the Whitepages Pro API
- [Making Your First Request](/documentation/making-your-first-request): A beginner-friendly guide to making your first Whitepages Pro API request
- [Property Search](/documentation/property-search): Get ownership and resident data for any property
- [Purchasing the API](/documentation/purchasing-api): Step-by-step guide to purchasing a Whitepages Pro API subscription
- [Regions](/documentation/regions): Browse and search US states and counties available in the Whitepages Pro API
- [Authentication](/references/authentication): Learn how to authenticate your requests to the Whitepages Pro API.
- [Billing Policy For Usage Prior to 2026-06-01](/references/billing-prior-to-2026-06-01): Billing rules that applied to usage on or before May 31, 2026.
- [Billing](/references/billing): Understand how API usage is tracked and billed.
- [Routes](/references): Complete overview of all available Whitepages API endpoints organized by category.
- [Rate Limits](/references/rate-limits): Understand the rate limiting policies for the Whitepages Pro API, including monthly query limits and trial exhaustion.
- [Support & Incident Response](/references/support-and-incident-response): Learn about our support channels, incident response times, and how to get help during an outage.
- [Capability Map](/documentation/agentic-guidance/capability-map): Map a user's intent to the exact endpoint and parameters that answer it.
- [Entity Shapes by Context](/documentation/agentic-guidance/entity-shapes): The same entity comes back in different shapes depending on the endpoint. Do not assume one shape.
- [Integration Guide](/documentation/agentic-guidance/integration-guide): The workflow to follow when integrating the Whitepages Pro API, by hand or with an agent.
- [Event Payload](/documentation/events/event-payload): Explore the full structure of an event object
- [Event Types](/documentation/events/event-types): Understand the different types of property deed events
- [Get an Event](/documentation/events/get-event): Retrieve a specific property deed event by its unique identifier
- [Events](/documentation/events): Retrieve and understand property deed events from the Whitepages Pro API
- [Search Deed Events](/documentation/events/search-events): Query historical property deed events by region, date range, and property identifier
- [MCP Server](/documentation/mcp): Connect to Whitepages Pro API via Model Context Protocol for AI assistants
- [Confidence Scores](/documentation/person-search/confidence-scores): How to interpret person, phone, and email confidence scores
- [Filter by Age Range](/documentation/person-search/filter-by-age-range): Narrow person search results using minimum and maximum age filters
- [Fuzzy Matching](/documentation/person-search/fuzzy-matching): Broaden person search results with phonetic, nickname, and misspelling matching
- [Person Search](/documentation/person-search): Look up individuals by name, phone, or address
- [Pagination](/documentation/person-search/pagination): Page through person search results using the page and page_size parameters
- [Search for Person by Partial Name](/documentation/person-search/partial-name-search): Search for people using partial or incomplete name information
- [Reverse Phone Lookup](/documentation/person-search/reverse-phone-lookup): Find the owner of a phone number
- [Search by Address](/documentation/person-search/search-by-address): Find people by current or historical addresses
- [Search by Radius](/documentation/person-search/search-by-radius): Find people within a specified distance of a location
- [Create a Webhook](/documentation/webhooks/create-webhook): Register a new webhook subscription to receive property event notifications
- [Delete a Webhook](/documentation/webhooks/delete-webhook): Permanently remove a webhook subscription
- [Webhooks](/documentation/webhooks): Receive live property deed notifications delivered to your endpoint
- [List Webhooks](/documentation/webhooks/list-webhooks): List and filter your webhook subscriptions
- [Webhook Quickstart](/documentation/webhooks/quickstart): Walk through the full webhook lifecycle — create, test, and retrieve an event — with real API calls
- [Test a Webhook](/documentation/webhooks/test-webhook): Send a mock event payload to verify your webhook endpoint
- [Update a Webhook](/documentation/webhooks/update-webhook): Modify an existing webhook subscription
- [Retrieve usage data for a specific time range](/references/account/get_account_usage_data): Retrieve API usage data for a specified date range.

Returns daily usage statistics including request counts for each day
within the specified time period. The response includes both individual
daily usage data and total usage for the entire period.

- The request count is total number of requests made including 2xx, 4xx
and 5xx responses. It is not the same as billable requests which is not
available right now as part of API.
- Maximum date range allowed: 90 days
- Dates are in UTC format
- Current day data when requested will be updated during the day
- Usage data is updated approximately every 30 minutes
- Usage data is returned only from the first date of actual usage in
the specified duration
- [Retrieve a single event by ID](/references/events/get_event): Return a single event by its unique identifier.
- [Search deed events](/references/events/search_deed_events): Search historical deed events by region, date range, and property identifier.
- [Search all deed events](/references/events/search_events): Search historical deed events by region and optional filters.

Raises
------
EventInvalidParameterError
    When event_date_from is after event_date_to.
- [Migration Guides](/references/migration): Move from V1 endpoints to V2 with field-level mappings and call translations.
- [Person V1 → V2](/references/migration/person-v1-to-v2): Field mapping and behavior changes when moving from /v1/person to /v2/person.
- [Property V1 → V2](/references/migration/property-v1-to-v2): Field mapping and behavior changes when moving from /v1/property to /v2/property.
- [Gets person details by id](/references/person-v2/get_person_by_id_v2): Retrieve detailed person information by Whitepages person ID.
- [Search for a person by name, phone number, and address](/references/person-v2/search_person_by_name_phone_or_address_v2): Retrieve person information with match scores and enriched emails.
- [Get property details by ID](/references/property-v2/get_property_by_id_v2): Retrieve detailed property information by Whitepages property ID.

Accepts either a Whitepages property ID (prefix ``R``) or an address ID
(prefix ``A``). Address IDs are resolved to the associated property
before lookup.

This endpoint returns comprehensive property data including physical
characteristics, tax assessment information, ownership details, mortgage
history, predictive insights, and current residents.

To obtain a property_id, first use the "Search for property by address"
endpoint (/v2/property/), which returns basic property information
including the property_id needed for this request.
- [Search for property by address](/references/property-v2/search_property_v2): Search for property by address parameters.

Returns basic property information including property_id, address, owner,
and resident details. For comprehensive property details including physical
characteristics, tax assessments, and mortgage history, use the returned
property_id with the "Get property details by ID" endpoint
(/v2/property/{property_id}).
- [List counties for a state](/references/regions/list_counties): Retrieve a list of counties for a given state.
- [List all US states and territories](/references/regions/list_states): Retrieve a list of all US states and territories.
- [Breaking Changes Policy](/references/versioning/breaking-changes-policy): How we define, announce, and version breaking changes across the REST API and the MCP server.
- [Change Notifications](/references/versioning/change-notifications): How we notify you about breaking changes, deprecations, new features, and maintenance.
- [Create a webhook subscription](/references/webhooks/create_webhook): 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.
- [Delete a webhook subscription](/references/webhooks/delete_webhook): Permanently delete a webhook subscription. This action cannot be undone.
- [Get a webhook subscription](/references/webhooks/get_webhook): Retrieve a single webhook subscription by its ID.
- [List webhook subscriptions](/references/webhooks/list_webhooks): List all webhook subscriptions for the authenticated account. Optionally filter by status or event type.
- [Test a webhook delivery](/references/webhooks/test_webhook): Send a synthetic notification to the webhook endpoint. Uses the same payload format as real deliveries with a fixed event ID.
- [Update a webhook subscription](/references/webhooks/update_webhook): Partially update a webhook subscription. Only provided fields are modified; omitted fields remain unchanged.

## Full Documentation

- [/llms-full.txt](/llms-full.txt): Complete documentation content