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… | Endpoint | Key parameters |
|---|---|---|
| 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 |
| Page through person results | GET /v2/person/ | page, page_size |
| Get full detail for a known person | GET /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… | Endpoint | Key parameters |
|---|---|---|
| Find who owns a property | GET /v3/property/owners | street, city, state_code, zipcode → read person_owners |
| Know whether that owner is the only candidate | GET /v3/property/owners | read result_metadata.parcel_resolution → ambiguous |
| Find current residents of a property | GET /v3/property/ | same address params → read residents |
| Find every parcel at one address | GET /v3/property/ | address params plus strict_match=true |
| Find properties near a point | GET /v3/property/ | lat, lng, radius → read distance_miles |
| Look a property up by parcel number | GET /v3/property/{apn} | path parcel number, or apn with fips on search |
| Get property detail by id | GET /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… | Endpoint | Key parameters |
|---|---|---|
| Find deed events / property transactions | GET /v1/events/deed | see Events reference |
| Check usage / remaining quota | GET /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
Integration Guide
The workflow to follow when integrating the Whitepages Pro API, by hand or with an agent.
Entity Shapes by Context
The same entity comes back in different shapes depending on the endpoint. Do not assume one shape.
Phone Search
Look up a phone number's own facts and the people or businesses behind it
Search for a person by name, phone number, and address
Retrieve person information with match scores and enriched emails. `strict_match` and `include_fuzzy_matching` are contradictory, so enabling both on one request is rejected. Either alone is fine, and so is sending both with one of them false.
Search properties by address or APN
Search properties by address or by Assessor's Parcel Number. Nothing matching is a `404` carrying an empty `results` array, so a caller parses one shape either way. Each result links to its full record on the details endpoint, which is where `assessed_info` and mortgage history come from.