Parsed Address Output Fields
The following table lists the output fields returned for a candidate located in the USA.
To return the Parsed Address fields, send the returnAllCandidateInfo
preference true in POST request.
Note: The placeName, addressNumber, unitType and
unitValue field values are only returned when the Geocode dataset
that supports street address interpolation is installed.
| Field Name | Description |
|---|---|
| mainAddressLine | The street address which may include company name, house number, building names and street names. |
| addressLastLine | The last line of the address. |
| placeName | The building name, place name, Point of Interest (POI), company or firm name associated with the address. |
| areaName1 | The state. |
| areaName2 | The county. |
| areaName3 | The town or city. |
| areaName4 | The urbanization (for Puerto Rico only). |
| postCode1 | 5-digit ZIP Code. |
| postCode2 | 4-digit ZIP Code extension. |
| country | The three-letter ISO 3166-1 Alpha-3 country code. For the United States, the country code is USA. |
| addressNumber | The address number. |
| streetName | The street or road name. |
| unitType | The unit type such as APT, STE, etc. |
| unitValue | The unit value/number, such as "3B". |
| customFields | See the following section for the custom field definitions. |