Output

Table 1. Reverse Geocode Address Global Output Fields

columnName

Field Name

Response Element

Description

AddressLine1

First line of the address.

AddressLine2

Second line of the address.

ApartmentLabel

The type of unit, such as apartment, suite, or lot.

ApartmentNumber

Unit number.

City

The municipality name.

For Japan, the municipality subdivision (sub-city)

County

Data.County

The meaning of county varies by country.

The Local Government Authority (LGA) name.

The majority of countries in the Africa database (XA1) do not use a county or equivalent as part of an address.

The majority of countries in the Middle East database (XM1) do not use a county or equivalent as part of an address.

The majority of countries in the Latin American database (XL1) do not use a county or equivalent as part of an address.

  • ABW (Aruba)—Not used
  • AGO (Angola)—Not used
  • ARE (United Arab Emirates)—Not used
  • ALB (Albania)—Not used
  • ARG (Argentina)—Department
  • AUS (Australia)—The Local Government Authority (LGA)
  • AUT (Austria)—Province
  • BDI (Burundi)—Not used
  • BEL (Belgium)—Province
  • BEN (Benin)—Not used
  • BFA (Burkina Faso)—Not used
  • BHR (Bahrain)—Not used
  • BHS (Bahamas)—Not used
  • BLZ (Belize)—Not used
  • BMU (Bermuda)—Not used
  • BOL (Bolivia)—Not used
  • BRA (Brazil)—Not used
  • BRB (Barbados)—Not used
  • BRN (Brunei Darussalam)—Not used
  • BWA (Botswana)—Not used
  • CAN (Canada)—Not used
  • CHE (Switzerland)—Province
  • CHL (Chile)—District
  • CHN (China)—Not used
  • CMR (Cameroon)—Not used
  • COD (Congo, Democratic Republic of)—Not used
  • COG (Congo)—Not used
  • CRI (Costa Rica)—Not used
  • CUB (Cuba)—Not used
  • CYP (Cyprus)—Not used
  • CZE (Czech Republic)—District name or alias
  • DEU (Germany)—Kreis
  • DNK (Denmark)—Province
  • DOM (Dominican Republic)—Not used
  • ECU (Ecuador)—Not used
  • EGY (Egypt)—Not used
  • ESP (Spain)—Province
  • EST (Estonia)—District
  • FIN (Finland)—Not used
  • FRA (France)—Department
  • GAB (Gabon)—Not used
  • GBR (Great Britain)—Not used
  • GHA (Ghana)—Not used
  • GRC (Greece) —District
  • GTM (Guatemala)—Not used
  • GUY (Guyana)—Not used
  • HKG (Hong Kong)—Not used
  • HND (Honduras)—Not used
  • HRV (Croatia)—Province
  • HUN (Hungary)—District
  • IDN (Indonesia)—Regency/City
  • IND (India)—District
  • ISL (Iceland)—Not used
  • IRL (Ireland)—Province
  • IRQ (Iraq)—Not used
  • ITA (Italy)—Province
  • JAM (Jamaica)—Not used
  • JOR (Jordan)—Not used
  • JPN (Japan)—City (shi)
  • KEN (Kenya)—Not used
  • KNA (St Kitts and Nevis)—Not used
  • KWT (Kuwait)—Not used
  • LBN (Lebanon)—Not used
  • LSO (Lesotho)—Not used
  • LTU (Lithuania)—County
  • LVA (Latvia)—District
  • MAC (Macau)—Not used
  • MAR (Morocco)—Not used
  • MEX (Mexico)—Province
  • MKD (Macedonia)—Not used
  • MLI (Mali)—Not used
  • MLT (Malta)—Not used
  • MNE (Montenegro)—Not used
  • MOZ (Mozambique)—Not used
  • MRT (Mauritania)—Not used
  • MUS (Mauritius)—Not used
  • MWI (Malawi)—Not used
  • MYS (Malaysia)—Not used
  • NAM (Namibia)—Not used
  • NER (Niger)—Not used
  • NGA (Nigeria)—Not used
  • NLD (The Netherlands)—Province
  • NOR (Norway)—District (fylke/counties)
  • NZL (New Zealand)—Region
  • OMN (Oman)—Not used
  • PAN (Panama)—Not used
  • PER (Peru)—Not used
  • PHL (Philippines)—District
  • POL (Poland)—District (poviat)
  • PRT (Portugal)—Not used
  • PRY (Paraguay)—Not used
  • QAT (Qatar)—Not used
  • ROU (Romania) —County (Județ)
  • RUS (Russia) —District
  • RWA (Rwanda)—Not used
  • SAU (Saudi Arabia)—Not used
  • SEN (Senegal)—Not used
  • SGP (Singapore)—Not used
  • SLV (El Salvador)—Not used
  • SRB (Serbia)—Not used
  • SUR (Suriname)—Not used
  • SVK (Slovakia)—Town
  • SVN (Slovenia)—Region
  • SWE (Sweden)—Kommun
  • SWZ (Swaziland)—Not used
  • TGO (Togo)—Not used
  • THA (Thailand)—District (amphoe)
  • TTO (Trinidad and Tobago)—Not used
  • TUN (Tunisia)—Not used
  • TUR (Turkey)—District
  • TWN (Taiwan)—Not used
  • TZA (Tanzania)—Not used
  • UGA (Uganda)—Not used
  • UKR (Ukraine)—District
  • USA (United States) —Not used
  • URY (Uruguay)—Not used
  • VEN (Venezuela)—Region
  • VNM (Vietnam)—District
  • XKX (Kosovo)—Not used
  • YEM (Yemen)—Not used
  • ZAF (South Africa)—District
  • ZMB (Zambia)—Not used
  • ZWE (Zimbabwe)—Not used

This field is not used with countries included with the Africa bundle (Product Code XA1). These African countries generally have less comprehensive address coverage.

This field is not used with countries included with the Middle East bundle (Product Code XM1). These Middle Eastern countries generally have less comprehensive address coverage.

This field is not used with countries included with the Latin American database (Product Code XL1). These Latin America countries generally have less comprehensive address coverage.

Note: If you enter addresses with the Andorran country code (AND), only Andorran addresses are returned, including the AND country code. If you enter an Andorran with a country code of Spain (ESP), you will still get Andorran candidates, but with the ESP country code.

The department name.

The region name.

The region name or alias. For example, Osrednjeslovenska/Ljubljana.

The district name.

The district (amphoe) name.

The district (povia) name.

The district (okres) name or alias.

The regency/city name.

The kommun name.

The district name.

The city (shi) name.

Distance

The distance from input location in meters. If the input coordinates are an exact match for the address, the value is 0.

FirmName

Name of the company or a place name.

Geocoder.MatchCode

Indicates how closely the input coordinates match the candidate address. For more information, see Reverse Geocoding Codes (R Codes).

HouseNumber

The buildinglot number for the matched location.

For Japan, this field contains the lot number.

HouseNumberHigh

The highest house number of the range in which the address resides.

HouseNumberLow

The lowest house number of the range in which the address resides.

HouseNumberParity

Indicates if the house number range contains even or odd numbers or both.

E
Even
O
Odd
B
Both
U
Unknown

Language

For reverse geocoded candidates, the two-character language code is returned.

For GRC, RUS, and JPN, the user's locale determines the language of the returned candidates for reverse geocoding. This can be Greek, Russian, or Japanese for GRC, RUS, and JPN respectively. English is the default locale.

LastLine

Complete last address line (city, state/province, and postal code).

LeadingDirectional

Street directional that precedes the street name. For example, the N in 138 N Main Street.

Locality

Data.Locality

The meaning of locality varies by country. Generally a locality is a village in rural areas or it may be a suburb in urban areas. When used, a locality typically appears on the last line of the address with the postcode.

African and Middle East countries do not use a locality or equivalent as part of an address. However there is no penalty if state/province is used in input address.

  • ABW (Aruba)—Not used
  • AGO (Angola)—Not used
  • ARE (United Arab Emirates)—Not used
  • ARG (Argentina)—Neighborhood or barrio
  • AUS (Australia)—Not used
  • AUT (Austria)—Not used
  • BEL (Belgium)—Not used
  • BEN (Benin)—Not used
  • BFA (Burkina Faso)—Not used
  • BHR (Bahrain)—Not used
  • BHS (Bahamas)—Not used
  • BLZ (Belize)—Not used
  • BMU (Bermuda)—Not used
  • BOL (Bolivia)—Not used
  • BWA (Botswana)—Not used
  • BRA (Brazil)—Locality
  • BRB (Barbados)—Not used
  • CAN (Canada)—Dissemination Area and Enumeration Area (DA and EA)
  • CHE (Switzerland)—Not used
  • CHL (Chile)—Locality or Alias
  • CHN (China)—Locality
  • CMR (Cameroon)—Not used
  • COD (Congo, Democratic Republic of)—Not used
  • COG (Congo)—Not used
  • BRB (Barbados)—Not used
  • CZE (Czech Republic)—Locality
  • DEU (Germany)—Not used
  • DOM (Dominican Republic)—Not used
  • DNK (Denmark)—Not used
  • DOM (Dominican Republic)—Not used
  • ECU (Ecuador)—Not used
  • ESP (Spain)—Locality
  • EGY (Egypt)—Not used
  • EST (Estonia)—Locality
  • FIN (Finland)—Not used
  • FRA (France)—Not used
  • GAB (Gabon)—Not used
  • GBR (Great Britain)—Locality
  • GHA (Ghana)—Not used
  • GRC (Greece) —Locality
  • ECU (Ecuador)—Not used
  • HKG (Hong Kong) —Locality
  • HND (Honduras)—Not used
  • HRV (Croatia)—Settlement
  • HUN (Hungary)—Locality
  • IDN (Indonesia)—Village
  • IND (India)—Locality
  • IRL (Ireland)—Not used
  • IRQ (Iraq)—Not used
  • ISL (Iceland)—Not used
  • ITA (Italy)—Locality
  • JAM (Jamaica)—Not used
  • JOR (Jordan)—Not used
  • JPN (Japan)—City district (chome)
  • KEN (Kenya)—Not used
  • KNA (St Kitts and Nevis)—Not used
  • KWT (Kuwait)—Not used
  • LBN (Lebanon)—Not used
  • LSO (Lesotho)—Not used
  • LTU (Lithuania)—Locality
  • LVA (Latvia)—Locality
  • MAC (Macau) —Locality
  • MAR (Morocco)—Not used
  • MEX (Mexico)—Locality
  • MLI (Mali)—Not used
  • MOZ (Mozambique)—Not used
  • MRT (Mauritania)—Not used
  • MUS (Mauritius)—Not used
  • MWI (Malawi)—Not used
  • MYS (Malaysia)—Not used
  • NAM (Namibia)—Not used
  • NER (Niger)—Not used
  • NGA (Nigeria)—Not used
  • NIC (Nicaragua)—Not used
  • NLD (The Netherlands)—Not used
  • NOR (Norway)—Not used
  • NZL (New Zealand)—Suburb
  • OMN (Oman)—Not used
  • PAN (Panama)—Not used
  • PER (Peru)—Not used
  • NIC (Nicaragua)—Not used
  • PHL (Philippines)—Locality
  • POL (Poland)—Not used
  • PRT (Portugal)—Locality
  • PRY (Paraguay)—Not used
  • QAT (Qatar)—Not used
  • ROU (Romania)—Sector used in city of Bucharest
  • RUS (Russia)—Locality
  • RWA (Rwanda)—Not used
  • SAU (Saudi Arabia)—Not used
  • SEN (Senegal)—Not used
  • SGP (Singapore)—Not used
  • SLV (El Salvador)—Not used
  • SUR (Suriname)—Not used
  • SVK (Slovakia)—Locality or Alias
  • SVN (Slovenia)—Locality or Alias
  • SWE (Sweden)—Not used
  • SWZ (Swaziland)—Not used
  • TGO (Togo)—Not used
  • THA (Thailand)—Not used
  • TTO (Trinidad and Tobago)—Not used
  • TUN (Tunisia)—Not used
  • TUR (Turkey)—Locality
  • TWN (Taiwan)—Locality
  • TZA (Tanzania)—Not used
  • UGA (Uganda)—Not used
  • UKR (Ukraine)—Locality
  • URY (Uruguay)—Locality
  • VEN (Venezuela)—Not used
  • VNM (Vietnam)—Not used.
  • XKX (Kosovo)—Not used
  • YEM (Yemen)—Not used
  • ZMB (Zambia)—Not used
  • ZWE (Zimbabwe)—Not used
  • ZAF (South Africa)—Locality

This field is not used in this country.

NumberOfCandidateRanges

Indicates the number of ranges of which the candidate is a member. A candidate may be a part of multiple ranges if the candidate is a street instead of a building. To specify the number of ranges to return for each candidate, use the MaxRanges option.To specify the number of ranges to return for each candidate, use the Maximum ranges per candidate option.

NumberOfRangeUnits

Indicates the number of units included in the range. A unit is an address within a building, such as an apartment or office suite. To specify the number of units to return for each range, use the MaxRangeUnits option.To specify the number of units to return for each range, use the Maximum units per range option.

PBKey

A unique ID for the address for use as a lookup key.

PostalCode

The postal code for the address. The format of the postcode varies by country. Postcode data is not available for every country.

PostalCode.Addon

The second part of a postcode. For Canadian addresses this will be the LDU. This field is not used by most countries.

PreAddress

Miscellaneous information that appears before the street name.

PrivateMailbox

This field is not currently used.

SegmentCode

A unique ID that identifies a street segmentan individual address. In Japan, this is the Jusho code. A Jusho Code is a point ID that represents a unique address.

SegmentParity

Indicates which side of the street has odd numbers.

L
Left side of the street
R
Right side of the street
B
Both sides of the street
U
Undetermined

StateProvince

Data.StateProvince

The meaning of State/Province varies by country.

Countries in the Africa, Middle East, and Latin America databases do not use a state/province or equivalent as part of an address. However there is no penalty if state/province is used in input address.

  • ALB (Albania)—Not used
  • AGO (Angola)—Not used
  • ALB (Albania)—Not used
  • ARE (United Arab Emirates)—Not used
  • ARG (Argentina)—Region or province
  • AUS (Australia)—State
  • AUT (Austria)—Region
  • BEL (Belgium)—Not used
  • BEN (Benin)—Not used
  • BFA (Burkina Faso)—Not used
  • BHR (Bahrain)—Not used
  • BHS (Bahamas)—District
  • BWA (Botswana)—Not used
  • BRA (Brazil)—State
  • CAN (Canada)—Province
  • CHE (Switzerland)—Not used
  • CHL (Chile)—State
  • CHN (China)—Province
  • CMR (Cameroon)—Not used
  • COD (Congo, Democratic Republic of)—Not used
  • COG (Congo)—Not used
  • CZE (Czech Republic)—Region name or alias. For example, the region HLAVNÍ MESTO PRAHA can be aliased as Prag.
  • DEU (Germany)—Bundesland
  • DNK (Denmark)—Not used
  • EGY (Egypt)—Not used
  • ESP (Spain)—Region
  • EST (Estonia)—Not used
  • FIN (Finland)—Region (län)
  • FRA (France)—Region
  • GAB (Gabon)—Not used
  • GBR (Great Britain)—Region
  • GHA (Ghana)—Not used
  • GRC (Greece) —Region
  • HKG (Hong Kong) —Province
  • HRV (Croatia)—Not used
  • HUN (Hungary)—County (megye)
  • IDN (Indonesia)—Province
  • IND (India)—State
  • IRL (Ireland)—Not used
  • IRQ (Iraq)—Not used
  • ISL (Iceland)—Not used
  • ITA (Italy)—Region
  • JOR (Jordan)—Not used
  • JPN (Japan)—Prefecture
  • KEN (Kenya)—Not used
  • KWT (Kuwait)—Not used
  • LBN (Lebanon)—Not used
  • LSO (Lesotho)—Not used
  • LTU (Lithuania)—Not used
  • LVA (Latvia)—State
  • MAC (Macau) — State
  • MAR (Morocco)—Not used
  • MEX (Mexico)—State
  • MLI (Mali)—Not used
  • MOZ (Mozambique)—Not used
  • MRT (Mauritania)—Not used
  • MUS (Mauritius)—Not used
  • MWI (Malawi)—Not used
  • MYS (Malaysia)—State (negeri)
  • NAM (Namibia)—Not used
  • NER (Niger)—Not used
  • NGA (Nigeria)—Not used
  • NLD (The Netherlands)—Not used
  • NOR (Norway)—Not used
  • NZL (New Zealand)—Region
  • OMN (Oman)—Not used
  • PHL (Philippines)—State
  • POL (Poland)—Province (voivodship)
  • PRT (Portugal)—Region
  • QAT (Qatar)—Not used
  • ROU (Romania)—Not used
  • RUS (Russia) —Region
  • RWA (Rwanda)—Not used
  • SAU (Saudi Arabia)—Not used
  • SEN (Senegal)—Not used
  • SGP (Singapore)—Not used
  • SLV (El Salvador)—Not used
  • SVK (Slovakia)—Not used
  • SVN (Slovenia)—Not used
  • SWE (Sweden)—Region (lan)
  • SWZ (Swaziland)—Not used
  • TGO (Togo)—Not used
  • THA (Thailand)—Province (changwat)
  • TUN (Tunisia)—Not used
  • TUR (Turkey)—Province
  • TWN (Taiwan)—County or Special Municipality
  • TZA (Tanzania)—Not used
  • UGA (Uganda)—Not used
  • UKR (Ukraine)—Region (oblast)
  • URY (Uruguay)—Department
  • VEN (Venezuela)—State
  • YEM (Yemen)—Not used
  • XKX (Kosovo)—Not used
  • ZMB (Zambia)—Not used
  • ZWE (Zimbabwe)—Not used
  • ZAF (South Africa)—State

StreetDataType

The default search order rank of the database used to geocode the address. A value of "1" indicates that the database is first in the default search order, "2" indicates that the database is second in the default search order, and so on.

The default database search order is specified in the Management Console.

StreetName

For most countries, this contains the street name.

In Japan, this contains the block. Japanese addresses typically do not have street names.

StreetPrefix

The type of street when the street type appears before the base street name.

StreetSuffix

The type of street when the street type appears after the base street name.

TrailingDirectional

Street directional that follows the street name. For example, the N in 456 3rd St. N.

UnitNumberHigh

The highest unit number of the range in which the unit resides.

UnitNumberLow

The lowest unit number of the range in which the unit resides.