Address

The Address object uses a comprehensive format that can handle addresses from around the world. The address fields used depend on the country conventions. For example, in Great Britain, city is post_town. In the United States, the top-level administrative unit used in addresses is state, whereas in Chile it’s region.

The address structure is based on libaddressinput(Opens in a new tab) used by Android and Chromium.

Whether an address is valid depends on whether the locally required fields are present. For example:

• Germany: requires street_address, post_code, and city
• United States: uses state for the top-level administrative unit
• Great Britain: uses post_town instead of city
• Chile: uses region for the top-level administrative unit
• Ireland: uses eircode instead of post_code

Core Address Fields

• country: The two letter country code formatted according to ISO3166-1 alpha-2(Opens in a new tab). Example: ["DE", "GB"]
• street_address: The address lines, with each element representing one line. Example: ["Paul-Linke-Ufer 39-40", "2. Hinterhof"]

Post Code

A postal code included in a postal address for the purpose of sorting mail.

The following fields are used for post code, depending on the country:

• post_code (default): used by most countries. Example: "10999"
• zip_code: used in the United States
• eircode: used in Ireland

Administrative Areas

The address supports up to 3 levels of administrative areas, administrative_area_level_1 through administrative_area_level_3.

The following fields are used for administrative divisions, depending on the country:

• province (default): used in some countries for administrative divisions
• state: used in countries like the United States for the top-level administrative unit
• region: used in countries like Chile for administrative divisions
• county: used in countries like Ireland and Romania
• autonomous_community: used in Spain for the first sub-national level

Locality Levels

The address supports up to 3 levels of locality levels, locality_level_1 through locality_level_3.

For more specific location information:

• city (default): a city
• post_town: used in Great Britain instead of city
• district: a district within a city or region
• neighborhood: a neighborhood or local area
• suburb: a suburb or outlying area of a city
• village: a village or small settlement
• municipality: a municipality or local government area

Country-Specific Requirements

Use the table below to search by country, field name, alias, and requirement.

Search

	Country	Fields
	Argentina (AR)	street_address, post_code, city, province (Optional)
	Australia (AU)	street_address, city, state, post_code
	Austria (AT)	street_address, post_code, city
	Belgium (BE)	street_address, post_code, city
	Brazil (BR)	street_address, post_code, city, neighborhood, state
	Bulgaria (BG)	street_address, post_code, city
	Canada (CA)	street_address, city, province, post_code
	Chile (CL)	street_address, post_code, city, region, province (Optional), commune
	Colombia (CO)	street_address, district (Optional), city, department, municipality, post_code (Optional)
	Croatia (HR)	street_address, post_code, city
	Cyprus (CY)	street_address, post_code, city
	Czech Republic (CZ)	street_address, post_code, city
	Denmark (DK)	street_address, post_code, city
	Estonia (EE)	street_address, post_code, city, province (Optional)
	Finland (FI)	street_address, post_code, city
	France (FR)	street_address, post_code, city
	Germany (DE)	street_address, post_code, city
	Greece (GR)	street_address, post_code, city
	Hungary (HU)	city, street_address, post_code
	Ireland (IE)	street_address, townland (Optional), city, county, eircode
	Italy (IT)	street_address, post_code, city, province
	Latvia (LV)	street_address, province (Optional), city, post_code
	Lithuania (LT)	street_address, post_code, city, province (Optional)
	Luxembourg (LU)	street_address, post_code, city
	Malta (MT)	street_address, city, post_code
	Mexico (MX)	street_address, post_code, city, neighborhood (Optional), state
	Netherlands (NL)	street_address, post_code, city
	Norway (NO)	street_address, post_code, post_town
	Peru (PE)	street_address, city (Optional), post_code, department, province (Optional), district
	Poland (PL)	street_address, post_code, city, province (Optional)
	Portugal (PT)	street_address, post_code, city, district (Optional)
	Romania (RO)	street_address, post_code, county (Optional), city
	Slovakia (SK)	street_address, post_code, city
	Slovenia (SI)	street_address, post_code, city
	Spain (ES)	street_address, post_code, city, province
	Sweden (SE)	street_address, post_code, post_town
	Switzerland (CH)	street_address, post_code, city
	United Kingdom (GB)	street_address, post_town, post_code
	United States (US)	street_address, city, state, zip_code