Global Geocode Input Fields

The following table defines the Geocoding input fields.
Field Name Type Description
Note: The meaning, valid values and support of the following address elements vary by country:
  • placeName
  • mainAddress
  • lastLine
  • areaName1
  • areaName2
  • areaName3
  • areaName4
  • postCode1
  • postCode2
  • country

It is important to review the information specific to your country/countries. To locate your country's information, refer to the Country-Specific Information sections in the appendix.

placeName String Building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional. For example:

Pitney Bowes
4750 Walnut St.
Boulder, CO 80301

mainAddress String Single Line input—If no other field is populated, then the mainAddress entry will be treated as a single line input and can be a collection of address field elements. The input order of the address fields should reflect the normal address formatting for your country. Optional. For example:

4750 Walnut St., Boulder CO, 80301

Street Address—If the address fields (placeName, lastLine, postalCode, etc.) are provided separately, then the content of this field will be treated as the street address part and can include company name, house number, building names and street names. Optional.

Street Intersection Input—To enter an intersection, specify the two street names separated by a double ampersand (&&).

lastLine String The last line of the address. Optional.
areaName1 String Specifies the largest geographic area, typically a state or province. Optional.
areaName2 String Specifies the secondary geographic area, typically a county or district. Optional.
areaName3 String Specifies a city or town name. Optional.
areaName4 String Specifies a city subdivision or locality. Optional.
postalCode String The postal code in the appropriate format for the country. Optional.
country String ISO 3166-1 alpha-3 country code. Required. For country codes, see Country Reference Listing and ISO 3166-1 Country Codes.