New: property V3 returns the whole record, owners on their own endpoint, and no charge for a miss. See what's changed →
Whitepages Pro API
Agentic Guidance

Capability Map

Map a user's intent to the exact endpoint and parameters that answer it.

Start here. This table maps what you are trying to do to the endpoint and parameters that do it. Match the intent, copy the parameters, then read the type document for that endpoint before writing your types.

Person search is one endpoint. Address lookup and name search are the same GET /v2/person/ call with different parameters. It also accepts phone=, which ranks people against a number.

A phone number has its own endpoint as well. GET /v2/phone/{phone} answers what a number is — line type, carrier, and the people and businesses associated with it — rather than which people rank against it. Pick by the question you are asking; the row below says which.

People

You want to…EndpointKey parameters
Find out what a phone number isGET /v2/phone/{phone}path phone (any common spelling)
Rank people against a phone numberGET /v2/person/phone=, optionally with name or location to narrow
Find a person by emailGET /v2/person/email=, optionally with name or location to narrow
Find who lives at an addressGET /v2/person/street, city, state_code, zipcode
Find a person by nameGET /v2/person/name, or first_name / middle_name / last_name (+ location)
Narrow a person searchGET /v2/person/min_age / max_age, include_fuzzy_matching, strict_match, include_historical_locations, radius
Page through person resultsGET /v2/person/page, page_size
Get full detail for a known personGET /v2/person/{id}path id (the id from any person object)

A person search returns results scored by match_score (1–99). See Entity Shapes for how a person's shape differs by context.

Choosing between the two phone rows: GET /v2/phone/{phone} returns the number's own facts even when no party is associated with it, and is the only one that returns businesses. GET /v2/person/ with phone= is the one to use when you want person records ranked, or when you are combining the number with a name or a location to verify a match.

Property

You want to…EndpointKey parameters
Find who owns a propertyGET /v3/property/ownersstreet, city, state_code, zipcode → read person_owners
Know whether that owner is the only candidateGET /v3/property/ownersread result_metadata.parcel_resolution → ambiguous
Find current residents of a propertyGET /v3/property/same address params → read residents
Find every parcel at one addressGET /v3/property/address params plus strict_match=true
Find properties near a pointGET /v3/property/lat, lng, radius → read distance_miles
Look a property up by parcel numberGET /v3/property/{apn}path parcel number, or apn with fips on search
Get property detail by idGET /v3/property/{id}path id (R-prefixed property id or A-prefixed address id)

Owners and residents come back as summary person objects that carry an id. To get full detail (date of birth, relatives, historic addresses), call GET /v2/person/{id} with that id — see Entity Shapes.

Property misses are free

Every /v3/property endpoint bills on 200 alone. A 404 and a 409 cost nothing, so a speculative lookup is safe to attempt. GET /v2/property/ bills its 404s — prefer V3. See Billing.

One address can carry several parcels, so an owners answer names the parcel it came from. Treat parcel_resolution.ambiguous as true or null meaning "check the other parcels before acting"; only false promises the parcel was unique. match_type and confidence_score do not answer this — they compare addresses, not parcels.

Events and account

You want to…EndpointKey parameters
Find deed events / property transactionsGET /v1/events/deedsee Events reference
Check usage / remaining quotaGET /v1/account/usage/date range

What's next

  • Integration Guide — the workflow to follow before writing integration code.
  • Entity Shapes — the shapes you get back and how to hydrate summaries.
  • FAQ — trial limits, rate limits, and breaking changes.

Related

On this page