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. Reverse phone lookup, address lookup, and
name search are all the same GET /v2/person/ call with different parameters.
There is no separate "phone lookup" endpoint — pass phone= to person search.
People
| You want to… | Endpoint | Key parameters |
|---|---|---|
| Reverse phone lookup (who owns a number) | GET /v2/person/ | phone= |
| 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, 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.
Property
| You want to… | Endpoint | Key parameters |
|---|---|---|
| Find who owns a property | GET /v2/property/ | street, city, state_code, zipcode → read ownership_info |
| Find current residents of a property | GET /v2/property/ | same address params → read residents |
| Get property detail by id | GET /v2/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.
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.