A general GeoCode search can include city, state, county, postal code, and geocodeId. If geocodeId is included, it overrides all other search criteria.
| Endpoint | Method | Required fields |
|---|
/v2/geocodes | POST | Not applicable. |
| Search criteria | Format | Description |
|---|
city | object | City-level search criteria. |
state | object | State-level search criteria. |
county | object | County-level search criteria. |
postalCode | string | The postal code value. |
geocodeId | string | The GeoCode, for doing reverse lookups by GeoCode. If geocodeId is included, only a GeoCode lookup is performed. No other search criteria is used. |
| Search criteria | Field | Format | Description |
|---|
city | name | string | City name. |
| isPrefix | boolean | If set to true, then the supplied name is a prefix. The search returns any matches with a city name that begins with the supplied text. |
| isCompressed | boolean | Search using a compressed city name. |
state | name | string | State name. |
| iPrefix | boolean | If set to true, then the supplied name is a prefix. The search returns any matches with a state name that begins with the supplied text. |
county | name | string | County name. |
| isPrefix | boolean | If set to true, then the supplied name is a prefix. The search returns any matches with a county name that begins with the supplied text. |
