The address may be identical to the input address if the input address was accurate, or it may be a standardized version of the input address, or it may be a candidate address when multiple matches are found.
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. |
||||||||||||||||||||||||||||||||
ApartmentLabel.Input |
The type of unit, such as apartment, suite, or lot as it was input. |
||||||||||||||||||||||||||||||||
ApartmentNumber |
Unit number. |
||||||||||||||||||||||||||||||||
ApartmentNumber.Input |
Unit number as it was input |
||||||||||||||||||||||||||||||||
City |
The municipality name. For Japan, the municipality subdivision (sub-city) |
||||||||||||||||||||||||||||||||
City.Input |
The municipality name as it was input. For Japan, the municipality subdivision (sub-city) For Japan, the municipality subdivision (sub-city) |
||||||||||||||||||||||||||||||||
Country |
The three-letter ISO 3166-1 Alpha 3 country code. For Aruba, the country code is ABW. For Angola, the country code is AGO. For the United Arab Emirates, the country code is ARE. For Argentina, the country code is ARG. For Australia, the country code is AUS. For Austria, the country code is AUT. For Bahrain, the country code is BHR. For Belgium, the country code is BEL. For Burundi, the country code is BDI. For Benin, the country code is BEN. For Bulgaria, the country code is BGR. For Burkina Faso, the country code is BFA. For Bahamas, the country code is BHS. For Belize, the country code is BLZ. For Brazil, the country code is BRA. For Bermuda, the country code is BMU. For Bolivia, the country code is BOL. For Botswana, the country code is BWA. For Barbados, the country code is BRB. For Canada, the country code is CAN. For Switzerland, the country code is CHE. For Chile, the country code is CHL. For China, the country code is CHN. For Cameroon, the country code is CMR. For Colombia, the country code is COL. For Democratic Republic of Congo, the country code is COD. For Congo, the country code is COG. For Costa Rica, the country code is CRI. For Cuba, the country code is CUB. For the Czech Republic, the country code is CZE. For Germany, the country code is DEU. For Denmark, the country code is DNK. For Dominican Republic, the country code is DOM. For Ecuador, the country code is ECU. For Spain, the country code is ESP. For Egypt, the country code is EGY. For Estonia, the country code is EST. For Finland, the country code is FIN. For France, the country code is FRA. For Gabon, the country code is GAB. For the United Kingdom, the country code is GBR. For Ghana, the country code is GHA. For Greece, the country code is GRC. For Guatemala, the country code is GTM. For Guyana, the country code is GUY. For Hong Kong, the country code is HKG. For Honduras, the country code is HND. For Croatia, the country code is HRV. For Hungary, the country code is HUN. For Indonesia, the country code is IDN. For India, the country code is IND. For Ireland, the country code is IRL. For Iraq, the country code is IRQ. For Iceland, the country code is ISL. For Italy, the country code is ITA. For Jamaica, the country code is JAM. For Japan, the country code is JPN. For Jordan, the country code is JOR. For Kenya, the country code is KEN. For Saint Kitts and Nevis, the country code is KNA. For Kuwait, the country code is KWT. For Lebanon, the country code is LBN. For Lesotho, the country code is LSO. For Lithuania, the country code is LTU. For Latvia, the country code is LVA. For Macau, the country code is MAC. For Moldova, Republic of, the country code is MDA For Morocco, the country code is MAR. For Mexico, the country code is MEX. For Mali, the country code is MLI. For Mozambique, the country code is MOZ. For Mauritania, the country code is MRT. For Mauritius, the country code is MUS. For Malawi, the country code is MWI. For Malaysia, the country code is MYS. For Namibia, the country code is NAM. For Niger, the country code is NER. For Nigeria, the country code is NGA. For Nicaragua, the country code is NIC. For the Netherlands, the country code is NLD. For Norway, the country code is NOR. For New Zealand, the country code is NZL. For Oman, the country code is OMN. For Panama, the country code is PAN. For Peru, the country code is PER. For Poland, the country code is POL. For Philippines, the country code is PHL. For Portugal, the country code is PRT. For Paraguay, the country code is PRY. For Qatar, the country code is QAT. For Romania, the country code is ROU. For Russia, the country code is RUS. For Rwanda, the country code is RWA. For Saudi Arabia, the country code is SAU. For Senegal, the country code is SEN. For Serbia, the country code is SRB For Singapore, the country code is SGP. For El Salvador, the country code is SLV. For Slovakia, the country code is SVK. For Slovenia, the country code is SVN. For Suriname, the country code is SUR. For Sweden, the country code is SWE. For Swaziland, the country code is SWZ. For Togo, the country code is TGO. For Thailand, the country code is THA. For Trinidad and Tobago, the country code is TTO. For Tunisia, the country code is TUN. For Turkey, the country code is TUR. For Taiwan, the country code is TWN. For Tanzania, the country code is TZA. For Uganda, the country code is UGA. For Ukraine, the country code is UKR. For United States, the country code is USA. For Uruguay, the country code is URY. For Venezuela, the country code is VEN. For Vietnam, the country code is VNM. For Yemen, the country code is YEM. For Zambia the country code is ZMB. For Zimbabwe the country code is ZWE. For South Africa, the country code is ZAF. Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field. AND (Andorra)—Addresses from Andorra are geocoded by Geocode Address ESP (Spain) . ASM — Geocoded by USA. GGY — Geocoded by GBR. GIB (Gibraltar)—Addresses from Gibraltar are geocoded by Geocode Address ESP (Spain) . GIB — Available. GLP (Guadeloupe) — Addresses from Guadeloupe are geocoded by Geocode Address FRA (France). GLP — Available. GUF (French Guiana ) — Addresses from French Guiana are geocoded by Geocode Address FRA (France). GUF — Available. GUM — Geocoded by USA. IMN — Geocoded by GBR. JEY — Geocoded by GBR. MCO (Monaco)—Addresses from Monaco are geocoded by Geocode Address FRA (France). MCO — Available. MNP — Geocoded by USA. MTQ (Martinique) — Addresses from Martinique are geocoded by Geocode Address FRA (France). MTQ — Available. MYT (Mayotte) — Addresses from Mayotte are geocoded by Geocode Address FRA (France). MYT — Available. PRI — Geocoded by USA. REU (Réunion) — Addresses from Réunion are geocoded by Geocode Address FRA (France). SMR (San Marino)—Addresses from San Marino contain ITA (Italy) in the Country field. SMR — Available. VAT (Vatican City)—Addresses from Vatican City contain ITA (Italy) in the Country field. VAT — Available. VIR — Geocoded by USA. |
||||||||||||||||||||||||||||||||
Country.Input |
The three-letter ISO 3166-1 Alpha 3 country code as it was input. For Aruba, the country code is ABW. For Angola, the country code is AGO. For the United Arab Emirates, the country code is ARE. For Argentina, the country code is ARG. For Australia, the country code is AUS. For Austria, the country code is AUT. For Bahrain, the country code is BHR. For Belgium, the country code is BEL. For Burundi, the country code is BDI. For Benin, the country code is BEN. For Bulgaria, the country code is BGR. For Burkina Faso, the country code is BFA. For Bahamas, the country code is BHS. For Belize, the country code is BLZ. For Brazil, the country code is BRA. For Bermuda, the country code is BMU. For Bolivia, the country code is BOL. For Botswana, the country code is BWA. For Barbados, the country code is BRB. For Canada, the country code is CAN. For Switzerland, the country code is CHE. For Chile, the country code is CHL. For China, the country code is CHN. For Cameroon, the country code is CMR. For Colombia, the country code is COL. For Democratic Republic of Congo, the country code is COD. For Congo, the country code is COG. For Costa Rica, the country code is CRI. For Cuba, the country code is CUB. For the Czech Republic, the country code is CZE. For Germany, the country code is DEU. For Denmark, the country code is DNK. For Dominican Republic, the country code is DOM. For Ecuador, the country code is ECU. For Spain, the country code is ESP. For Egypt, the country code is EGY. For Estonia, the country code is EST. For Finland, the country code is FIN. For France, the country code is FRA. For Gabon, the country code is GAB. For the United Kingdom, the country code is GBR. For Ghana, the country code is GHA. For Greece, the country code is GRC. For Guatemala, the country code is GTM. For Guyana, the country code is GUY. For Hong Kong, the country code is HKG. For Honduras, the country code is HND. For Croatia, the country code is HRV. For Hungary, the country code is HUN. For Indonesia, the country code is IDN. For India, the country code is IND. For Ireland, the country code is IRL. For Iceland, the country code is ISL. For Iraq, the country code is IRQ. For Italy, the country code is ITA. For Jamaica, the country code is JAM. For Japan, the country code is JPN. For Jordan, the country code is JOR. For Kenya, the country code is KEN. For Saint Kitts and Nevis, the country code is KNA. For Kuwait, the country code is KWT. For Lebanon, the country code is LBN. For Lesotho, the country code is LSO. For Lithuania, the country code is LTU. For Latvia, the country code is LVA. For Macau, the country code is MAC. For Moldova, Republic of, the country code is MDA For Morocco, the country code is MAR. For Mexico, the country code is MEX. For Mali, the country code is MLI. For Mozambique, the country code is MOZ. For Mauritania, the country code is MRT. For Mauritius, the country code is MUS. For Malawi, the country code is MWI. For Malaysia, the country code is MYS. For Namibia, the country code is NAM. For Niger, the country code is NER. For Nigeria, the country code is NGA. For Nicaragua, the country code is NIC. For the Netherlands, the country code is NLD. For Norway, the country code is NOR. For New Zealand, the country code is NZL. For Oman, the country code is OMN. For Panama, the country code is PAN. For Peru, the country code is PER. For Poland, the country code is POL. For Philippines, the country code is PHL. For Portugal, the country code is PRT. For Paraguay, the country code is PRY For Qatar, the country code is QAT. For Romania, the country code is ROU. For Russia, the country code is RUS. For Rwanda, the country code is RWA. For Saudi Arabia, the country code is SAU. For Senegal, the country code is SEN. For Serbia, the country code is SRB For Singapore, the country code is SGP. For El Salvador, the country code is SLV For Slovakia, the country code is SVK. For Slovenia, the country code is SVN. For Suriname, the country code is SUR. For Sweden, the country code is SWE. For Swaziland, the country code is SWZ. For Togo, the country code is TGO. For Thailand, the country code is THA. For Trinidad and Tobago, the country code is TTO. For Tunisia, the country code is TUN. For Turkey, the country code is TUR. For Taiwan, the country code is TWN. For Tanzania, the country code is TZA. For Uganda, the country code is UGA. For Ukraine, the country code is UKR. For United States, the country code is USA. For Uruguay, the country code is URY. For Venezuela, the country code is VEN. For Vietnam, the country code is VNM. For Yemen, the country code is YEM. For Zambia the country code is ZMB. For Zimbabwe the country code is ZWE. For South Africa, the country code is ZAF. Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field. AND (Andorra)—Addresses from Andorra are geocoded by Geocode Address ESP (Spain) . ASM — Geocoded by USA. GGY — Geocoded by GBR. GIB (Gibraltar)—Addresses from Gibraltar are geocoded by Geocode Address ESP (Spain) . GIB — Available. GLP (Guadeloupe) — Addresses from Guadeloupe are geocoded by Geocode Address FRA (France). GLP — Available. GUF (French Guiana ) — Addresses from French Guiana are geocoded by Geocode Address FRA (France). GUF — Available. GUM — Geocoded by USA. IMN — Geocoded by GBR. JEY — Geocoded by GBR. MCO (Monaco)—Addresses from Monaco are geocoded by Geocode Address FRA (France). MCO — Available. MNP — Geocoded by USA. MTQ (Martinique) — Addresses from Martinique are geocoded by Geocode Address FRA (France). MTQ — Available. MYT (Mayotte) — Addresses from Mayotte are geocoded by Geocode Address FRA (France). MYT — Available. PRI — Geocoded by USA. REU (Réunion) — Addresses from Réunion are geocoded by Geocode Address FRA (France). SMR (San Marino)—Addresses from San Marino contain ITA (Italy) in the Country field. SMR — Available. VAT (Vatican City)—Addresses from Vatican City contain ITA (Italy) in the Country field. VAT — Available. VIR — Geocoded by USA. |
||||||||||||||||||||||||||||||||
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.
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. |
||||||||||||||||||||||||||||||||
DataType |
The returned numeric value represents a data vendor.
|
||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
FirmName |
Name of the company or a place name. |
||||||||||||||||||||||||||||||||
FirmName.Input |
Name of the company or a place name as it was input. |
||||||||||||||||||||||||||||||||
FormattedInputStreet.Input |
The street as it was input. | ||||||||||||||||||||||||||||||||
Geocoder.MatchCode |
|
||||||||||||||||||||||||||||||||
HouseNumber |
The buildinglot number for the matched location. For Japan, this field contains the lot number. |
||||||||||||||||||||||||||||||||
HouseNumber.Input |
The building lot number for the matched location as it was input 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.
|
||||||||||||||||||||||||||||||||
IntersectionIdStreet2.Input |
The second street in an intersection address as it was input. | ||||||||||||||||||||||||||||||||
IsCloseMatch |
Indicates whether candidate is a close match. | ||||||||||||||||||||||||||||||||
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). |
||||||||||||||||||||||||||||||||
Latitude |
Latitude of the candidate. |
||||||||||||||||||||||||||||||||
LeadingDirectional |
Street directional that precedes the street name. For example, the N in 138 N Main Street. |
||||||||||||||||||||||||||||||||
LeadingDirectional.Input |
Street directional that precedes the street name as it was input. |
||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||
Locality.Input |
The locality as it was input.
|
||||||||||||||||||||||||||||||||
Longitude |
Longitude of the candidate. |
||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
PostalCode.Addon.Input |
The second part of a postcode as it was input. For Canadian addresses this will be the LDU. This field is not used by most countries. |
||||||||||||||||||||||||||||||||
PostalCode.Base |
The first part of a postcode.For Canadian addresses this will be the FSA. This field is not used by most countries. |
||||||||||||||||||||||||||||||||
PostalCode.Base.Input |
The first part of a postcode.For Canadian addresses this will be the FSA. This field is not used by most countries. |
||||||||||||||||||||||||||||||||
PreAddress |
Miscellaneous information that appears before the street name. |
||||||||||||||||||||||||||||||||
PrivateMailbox |
This field is not currently used. |
||||||||||||||||||||||||||||||||
Ranges |
This is a list field containing the address ranges that exist on the street segment where the candidate address is located. A range is a series of addresses along a street segment. For example, 5400-5499 Main St. is an address range representing addresses in the 5400 block of Main St. A range may represent just odd or even addresses within a segment, or both odd and even addresses. A range may also represent a single building with multiple units, such as an apartment building. The Ranges field contains the following sub-fields: |
||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
SegmentCode |
A unique ID that identifies a street segment an 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.
|
||||||||||||||||||||||||||||||||
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.
|
||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
Return Parsed Address | The formatted input address can be returned along with a separate returned field for each input address element. Parsed Address Input elements are returned in separately labeled fields names with a .Input extension. See Result Codes | ||||||||||||||||||||||||||||||||