Get the owners of a property
Changed onRetrieve the entities that own a property.
Name the property however you have it: a Whitepages identifier, an address, or a parcel number. The answer is always one property's owners. An address matching several properties resolves to the best match, and the property comes back with match_type and confidence_score so you can confirm it is the one you meant.
Owners arrive in a field named for their entity class, so a person owner and a business owner never share a list. A class a later data release adds appears as a new field; owner_type is what tells a caller an owner exists that this version has no field for.
Person owners carry the same shape the person endpoints return and link to their full person record. Business owners carry a name, which is all the data holds for them today.
There is no paging: one response carries the owner lists in full as far as the data goes. Person owners are capped upstream, so check result_metadata.person_owners.complete before reading the list as the whole ownership record. When it is false, an unreported number of owners is missing and this version offers no way to reach them.
match_type and confidence_score are how you tell a resolved property from a ranked guess; treat anything short of an exact match as a suggestion, and confirm the property through search before acting on the ownership answer.
Several parcels can share one address, as a condominium or a commercial building does. Such an address resolves to a single parcel, and result_metadata.parcel_resolution reports which one answered and whether the choice was forced. The match fields cannot carry that: a parcel chosen from three at one address still matches that address exactly. Where the parcel carries no standardized address, or the candidate list reached its limit, parcel_resolution reports the question as open rather than answering it.
A parcel number is the other case. It names one parcel, so one matching several properties is a 409 carrying the candidates rather than a resolution, the same answer the details route gives.
Request
- Base URLhttps://api.whitepages.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Whitepages property identifier (capital 'R' prefix) or address identifier (capital 'A' prefix). A parcel number goes in apn instead.
Street address line
City name
Valid US State and Territory codes.
This enum contains all valid two-letter codes for US states and territories. Used for parameter validation in API requests.
Two-letter state code
Five-digit ZIP code
Assessor's Parcel Number. Narrow it with fips, or with state_code where one state holds the parcel.
Five-digit county FIPS code. Narrows the lookup to one county, whether it names a parcel number or an address. A parcel number is unique within a county rather than nationally, which state_code cannot resolve where two counties in a state record the same one.
Response
Owners retrieved successfully
Changes
- breaking
response property
result_metadata/parcel_resolution/ambiguouslist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - breaking
response property
result_metadata/parcel_resolution/matchedlist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - info
added the non-success response with the status
- info
added the required property
//to the response with the status
- breaking
- info
endpoint added
- info