Properties
Resolve a batch of addresses to property ids
Resolve up to 2,000 postal addresses to property ids in one call — e.g. a mailing list before a bulk delivery. Free. Returns one result per input, in order, keyed by your ref. matched carries the parcel id and mmPropertyId — pass them to bulk delivery propertyIds or the list flatFilters.id, then join the rows back on ref. Each address is first matched on the normalized number + street + unit + zip key (suffix, directional, punctuation and case insensitive); misses fall back to a ranked search that only accepts a hit with the same house number, the same zip or city, and a near-identical street name. ambiguous lists candidates: unit_required (a building whose units are separate parcels — resend with the unit), duplicate_parcels (one address on several parcel records; usually safe to take them all), multiple_parcels. not_found gives a reason: no_parcel_at_number (no parcel at that house number in that zip/city), low_confidence, or an input problem (no_house_number, no_street, no_location).
Authorization
Body application/json
addressesobject[]requiredShow child attributesHide child attributes
addressstringStreet line, e.g. "123 N Main St Apt 4".
citystringlinestringThe whole address as one line ("123 Main St, Springfield, IL 62701"). Used for any part the fields leave empty.
refstringYour row key, echoed back. Defaults to the row's 0-based position.
statestringzipstringResponses
200objectOne result per input address, in orderShow attributesHide attributes
resultsobject[]requiredShow child attributesHide child attributes
addressstringThe matched parcel's address as stored.
candidatesobject[]Up to 5 competing parcels on an ambiguous row.
Show child attributesHide child attributes
addressstringrequiredidstringrequiredmmPropertyIdstring | nullrequiredscorenumberrequiredidstringThe parcel document id (pass to propertyIds / flatFilters.id). Absent when a multi-unit parcel matched without a unit — use mmPropertyId, which selects every unit.
matchedByenumexact_keysearchmmPropertyIdstringreasonenumunit_requiredduplicate_parcelsmultiple_parcelsno_parcel_at_numberlow_confidenceno_house_numberno_streetno_locationsearch_failedsearch_budget_exhaustedrefstringrequiredscorenumberMatch confidence 0–1: 1 for an exact key match, street-name similarity for a search match.
statusenumrequiredmatchedambiguousnot_foundsummaryobjectrequiredShow child attributesHide child attributes
ambiguousintegerrequiredmatchedintegerrequirednotFoundintegerrequired400objectValidation error401objectUnauthorized403objectForbidden (authenticated, but missing required context — e.g. no active organization)404objectNot found413objectResponse payload too large — detail endpoint capped to fit Lambda response limits503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.