Input addresses include the address fields for input. The below table lists Input Address fields:
Parameter | Type | Description |
---|---|---|
addressLines | String | Requested address, based on the country's addressing
standard. Single-line request:
Multi-line request:
|
addressNumber | String | House or building number.
|
admin1 | String | The largest geographic area, typically a state or
province.
|
admin2 | String | The secondary geographic area, typically a county or
district.
|
city | String | Specifies a city or town name.
|
country | String | Values are based on the ISO 3166-1 standard for country codes
(returned in alpha-2, alpha-3, or numeric
format).
|
postalCode | String | Main postal code.
|
postalCodeExt | String | Secondary postal code, if one exists. For example, in the US, a
ZIP+4 is 80125-8012 |
placeName | String | If applicable, indicates the name of the candidate's place or
building.
|
addressId | String | Address Id for the request.
|
Parameter | Type | Description |
---|---|---|
street | String | Street name only (no directional or street suffix). |
suburb | String | Mixed-use or residential area within commuting distance of a city or urban area. |
floor | String | Each level within a building. |
neighborhood | String | A city subdivision or locality.
|
room | String | A single room within a building. |
borough | String | Unit of local government or other administrative
subdivision.
|
building | String | A roofed and walled structure built for permanent use. |
unit | String | The unit number, such as 3B . |
unitType | String | A group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (APT, STE, FLAT, etc.). |