Input Fields

The following table lists commonly used fields available for specifying an address.

For more information, refer to the RequestAddress class in the Addressing SDK Javadocs.


Parameter	Type	Description
`addressLines[n]`	String	The address lines, as needed, to support the standard address format of a given country (where `n` is an integer starting at 0). To specify a single line address, set addressLines[0].
`placeName`	String	The building name, place name, point of interest (POI), company or firm name associated with the input address.
`building`	String	The building name.
`addressNumber`	String	The address number information.
`street`	String	The street name.
`floor`	String	The floor number.
`room`	String	The room number.
`unit`	String	The unit number, such as "3B".
`unitType`	String	The unit type, such as APT, STE, FLAT, etc.
`neighborhood`	String	The city subdivision or locality.
`suburb`	String	The sublocality.
`borough`	String	The borough.
`city`	String	The city or town name.
`admin2`	String	The secondary geographic area, typically a county or district.
`admin1`	String	The largest geographic area, typically a state or province.
`postalCode`	String	The postal code in the appropriate format for the country.
`postalCodeExt`	String	The postal code extension in the appropriate format for the country.
`country`	String	The ISO 3166-1 country code (Alpha-2, Alpha-3, or numerical), or a common name of the country, such as United States of America. Required when data for more than one country is configured.
`x`	Double	The X coordinate (longitude) of the address. Required for Reverse Geocoding.
`y`	Double	The Y coordinate (latitude) of the address. Required for Reverse Geocoding.
`key`	String	The unique identifier for the address. Required for lookup.
`type`	String	The type of key for a lookup. The default value is PB_KEY.