GeoCoder API Fields

This table lists the fields included in the request body for Vertex GeoCoder API requests.

Field	Sub-field	Details	Description
`city`		object	City-level search criteria. Includes the following sub-fields: `isCompressed` `isPrefix` `name`
	`isCompressed`	boolean	Search using a compressed city name. Compression logic enables your search to match city names based on phonetic spelling and word concatenations. It helps you to successfully look up tax areas when you do not know the correct spelling of a location.
	`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.
	`name`	string	City name.
`state`		object	State-level search criteria. Includes the following sub-fields: `isPrefix` `name`
	`isPrefix`	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.
	`name`	string	State name.
`county`		object	County-level search criteria. Includes the following sub-fields: `isPrefix` `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.
	`name`	string	County name.
`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.