v4

latestOpenAPI 3.1.02026-08-08278476614.0 KB

project

Resolve Address

Resolve free text to ranked, label-hydrated candidates for address entry.

Pre-project: bounded to request.county_fips when the caller picked a county first, otherwise across every county the caller's workspace has loaded (the sandbox partition is the access control either way). A read failure surfaces as 503 rather than the raw error, which can carry a sandbox connection URI.

post/api/v1/project/address/resolve

Request body

querystring required

county_fipsstring nullable

Response

Successful Response

outcome'matched' | 'not_in_dataset' | 'not_loaded_county' required

Result classification. not_loaded_county (a real reference in a county this workspace hasn't loaded) is reserved for the forward-geocoder path, the only place able to confirm a reference is real and name its county.