Parameters for Addresses Outside the U.S.

Parameter	Description
CloseMatchesOnly	Specifies whether to return only those geocoded results that are close match candidates. For example, if there are 10 candidates and two of them are close candidates, and you enable this option, only the two close matching candidates would be returned instead of all 10. To specify what is considered a close match, use the MustMatch options. Address candidates are ranked according to how closely the input address matches these preferences. Y Yes, return only close matches. N No, do not return only close matches. Default.
ExpandCandidates	This option applies to U.K. addresses only. Specifies whether to return multiple close matches (one for each delivery point on the street). By default, if a street has multiple addresses/delivery points, the geocoder returns a single close match, with each individual delivery point available as a range.
GeocodeLevel	Specifies how precisely you want to geocode addresses. One of the following: StreetAddress The geocoder attempts to geocode addresses to a street address, but some matches may end up at a less precise location such as a postal code centroid, intersection, or shape path. PostalCentroid This option is not available for this country. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding. If postal code data is available, the geocoder attempts to geocode addresses to the most precise postal code it finds. The advantage of postal code centroid matching is the speed of the operation. The disadvantage of postal code matching is that the geocoder only examines the PostalCode field. If you use street address precision, the geocoder looks at both the street name and the PostalCode field and attempts to return street-level coordinates and optionally fall back to postal code coordinates. GeographicCentroid The geocoder attempts to geocode addresses to the geographic centroid of a city or state. This option is not available for the United Kingdom (GBR).
FallbackToGeographic	Specifies whether to attempt to determine a geographic region centroid when an address-level geocode cannot be determined. This option is not available for the United Kingdom (GBR). Y Yes, determine a geographic centroid when an address-level centroid cannot be determined. Default. N No, do not determine a geographic centroid when an address-level centroid cannot be determined.
FallbackToPostal FallbackToPostal	Specifies whether to attempt to determine a postal code centroid when an address-level geocode cannot be determined. For Argentina, you must use HERE data for postal geocoding. This option is not available for Bahamas, Hong Kong, Macau, Philippines, Uruguay, and Venezuela. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding. Y Yes, determine a postal code centroid when an address-level centroid cannot be determined. Default. N No, do not determine a postal code centroid when an address-level centroid cannot be determined.
Interpolation	Specifies whether to perform address point interpolation. This option only works if you have a point database installed. This option is available for selected countries only. Address point interpolation uses point data to refine geocode results. By default, the geocoding process estimates the location of an address based on the street numbers at either end of street segment. For example, if a street segment runs from 100 Main St. to 200 Main St., then a request for 150 Main St. will return a location in the middle of the segment. With interpolation, the geocoder finds the position of 180 Main St. in the point data, and it is about two-thirds of the way down the street. Using this information, the geocoder can estimate the position of 150 Main St. based on 100 and 180 Main St. In this case, the geocoder estimates the location of the address slightly away from the center of the segment. Y Yes, perform address point interpolation. N No, do not perform address point interpolation.
KeepMultimatch	Specifies whether to return results when the address matches to multiple candidates in the database. If this option is not selected, an address that results in multiple candidates will fail to geocode. If you select this option, specify the maximum number of candidates to return using the MaxCandidates option (see below). Y Yes, return candidates when multiple candidates are found. Default. N No, do not return candidates. Addresses that result in multiple candidates will fail to geocode.
Option.MatchModeInt	Specifies how to determine whether a candidate is a close match. One of the following: CustomMode This option allows you to specify which parts of a candidate address must match the input address to be considered a close match. Use the MustMatch<Element> options to specify the address elements you want. This is the default value for most countries. ExactMode All of a candidate address's elements must match in order for the candidate to be considered a close match. Note that for IND, Exact match mode returns the sublocality and place name information CloseMode Only the candidate address's house numberstreet name and town must match in order for the candidate to be considered a close match. For Chile, China, Great Britain, Estonia, India, Indonesia, Latvia, Lithuania, Slovakia, Slovenia, Taiwan, and South Africa, only the street name and town must match. RelaxedMode All candidate addresses are considered a close match. This is the default value for Japan.
MustMatchInput	Specifies whether candidates must match all non-blank input fields to be considered a close match. For example, if an input address contains a city and postal code, then candidates for this address must match the city and postal code to be considered a close match. Y Yes, a candidate must match all input to be considered a close match. N No, a candidate does not have to match all input to be considered a close match. Default.
MustMatchHouseNumber	Specifies whether candidates must match the house number to be considered a close match. House number data is not available for every country. The Africa and Middle East countries do not generally have house numbers in the data source. Some countries covered in the Latin America database have house number data. See Address Guidelines for Latin America for details of Latin America house number and postal coverage. If you select this option you should also require an exact match on street name. This option does not significantly affect performance. It does, however, affect the type of match if the candidate address corresponds to a segment that does not contain any ranges. The type of match can also be affected when the house number range for a candidate does not contain the input house number. If you relax the house number, you should set the maximum ranges to be returned to a value higher than 0. Y Yes, a candidate must match the house number to be considered a close match. N No, a candidate does not have to match the house number to be considered a close match.
MustMatchStreet	Specifies whether candidates must match the street name to be considered a close match. This option is not used for this country. If a close match is found, the geocoder attempts expanded street name manipulation, which looks for candidates with names that sound like the input address or that are spelled improperly. This slows down performance but increases the match rate . If the geocoding database is indexed, the performance impact is reduced. Y Yes, a candidate must match the street name to be considered a close match. N No, a candidate does not have to match the street name to be considered a close match.
MustMatchLocality	Specifies whether candidates must match the locality (or equivalent) to be considered a close match. The meaning of Locality varies for different countries. If you do not require exact matches on locality, the geocoder searches on the street address matched to the particular postal code, and considers other localities that do not match the name, but do match the postal code. The majority of African and Middle East countries do not use locality or equivalent as part of an address. If a locality is matched it can contribute to a higher candidate ranking, but there is no penalty if locality is omitted or unmatched. 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 CRI (Costa Rica)—Not used CUB (Cuba)—Not used CZE (Czech Republic)—Locality DEU (Germany)—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 GTM (Guatemala)—Not used GUY (Guyana)—Not used HKG (Hong Kong) —Locality HND (Honduras)—Not used HRV (Croatia)—Settlement HUN (Hungary)—Locality IDN (Indonesia)—Village IND (India)—Locality ISL (Iceland)—Not used IRL (Ireland)—Not used ITA (Italy)—Locality JAM (Jamaica)—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 PHL (Philippines)—Locality POL (Poland)—Not used PRT (Portugal)—Locality PRY (Paraguay)—Not used QAT (Qatar)—Not used ROU (Romania)—Not used 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 YEM (Yemen)—Not used ZMB (Zambia)—Not used ZWE (Zimbabwe)—Not used ZAF (South Africa)—Locality Y Yes, a candidate must match the locality to be considered a close match. N No, a candidate does not have to match the locality to be considered a close match.
MustMatchCity	Specifies whether candidates must match the city to be considered a close match. For Japan, this field specifies whether the candidate must match the municipality subdivision (oaza). If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code. Specifies whether candidates must match the municipality subdivision (oaza) to be considered a close match. If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code. Y Yes, a candidate must match the city to be considered a close match. N No, a candidate does not have to match the city to be considered a close match.
MustMatchCounty	Specifies whether candidates must match the county (or equivalent) to be considered a close match. The meaning of county varies for different countries. 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 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 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 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 IRL (Ireland)—Province ISL (Iceland)—Not used ITA (Italy)—Province JAM (Jamaica)—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 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)—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)—Not used 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 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 TTO (Trinidad and Tobago)—Not used TWN (Taiwan)—Not used TZA (Tanzania)—Not used UGA (Uganda)—Not used UKR (Ukraine)—District URY (Uruguay)—Not used VEN (Venezuela)—Region ZAF (South Africa)—District ZMB (Zambia)—Not used ZWE (Zimbabwe)—Not used One of the following: Y Yes, a candidate must match the county to be considered a close match. N No, a candidate does not have to match the county to be considered a close match.
MustMatchStateProvince	Specifies whether candidates must match the state or province (or equivalent) to be considered a close match. This option is not used for this country. The majority of African and Middle East countries do not use a state/province or equivalent as part of an address. If a state/province is matched it can contribute to a higher candidate ranking, but there is no penalty if state/province is omitted or unmatched. AGO (Angola)—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 ITA (Italy)—Region 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) TTO (Trinidad and Tobago)—Not used 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 ZMB (Zambia)—Not used ZWE (Zimbabwe)—Not used ZAF (South Africa)—State One of the following: Y Yes, a candidate must match the state or province to be considered a close match. N No, a candidate does not have to match the state or province to be considered a close match.
MustMatchPostalCode	Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates. Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates. This field is not used in this country. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding. Some countries covered in the Latin America database have postal code data. See Address Guidelines for Latin America for details of Latin America house number and postal coverage. For India, the Postal code must match preference can be used for geographic geocoding. This can produce better geographic matched candidates. For other countries, Postal code match preference can be used with street or postal geocoding only. Y Yes, a candidate must match the postal code to be considered a close match. N No, a candidate does not have to match the postal code to be considered a close match.
MustMatchPostDistrict	Specifies whether the postal district portion of the postcode must match in order for the match to be considered a close match. UK postcodes are divided into two sections: the outward code, which is to the left of the space, and the inward code, which is to the right. The outward code represents the postal district. For example, in the postcode CB3 OHH, the postal district is CB3, which is Cambridge.

CloseMatchesOnly

Specifies whether to return only those geocoded results that are close match candidates. For example, if there are 10 candidates and two of them are close candidates, and you enable this option, only the two close matching candidates would be returned instead of all 10. To specify what is considered a close match, use the MustMatch options. Address candidates are ranked according to how closely the input address matches these preferences.

Y: Yes, return only close matches.
N: No, do not return only close matches. Default.

ExpandCandidates

This option applies to U.K. addresses only.

Specifies whether to return multiple close matches (one for each delivery point on the street). By default, if a street has multiple addresses/delivery points, the geocoder returns a single close match, with each individual delivery point available as a range.

GeocodeLevel

Specifies how precisely you want to geocode addresses. One of the following:

StreetAddress: The geocoder attempts to geocode addresses to a street address, but some matches may end up at a less precise location such as a postal code centroid, intersection, or shape path.
PostalCentroid: This option is not available for this country. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding. If postal code data is available, the geocoder attempts to geocode addresses to the most precise postal code it finds. The advantage of postal code centroid matching is the speed of the operation. The disadvantage of postal code matching is that the geocoder only examines the PostalCode field. If you use street address precision, the geocoder looks at both the street name and the PostalCode field and attempts to return street-level coordinates and optionally fall back to postal code coordinates.
GeographicCentroid: The geocoder attempts to geocode addresses to the geographic centroid of a city or state. This option is not available for the United Kingdom (GBR).

FallbackToGeographic

Specifies whether to attempt to determine a geographic region centroid when an address-level geocode cannot be determined. This option is not available for the United Kingdom (GBR).

Y: Yes, determine a geographic centroid when an address-level centroid cannot be determined. Default.
N: No, do not determine a geographic centroid when an address-level centroid cannot be determined.

FallbackToPostal

Specifies whether to attempt to determine a postal code centroid when an address-level geocode cannot be determined. For Argentina, you must use HERE data for postal geocoding.

This option is not available for Bahamas, Hong Kong, Macau, Philippines, Uruguay, and Venezuela. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding.

Y: Yes, determine a postal code centroid when an address-level centroid cannot be determined. Default.
N: No, do not determine a postal code centroid when an address-level centroid cannot be determined.

Interpolation

Specifies whether to perform address point interpolation. This option only works if you have a point database installed. This option is available for selected countries only.

Address point interpolation uses point data to refine geocode results. By default, the geocoding process estimates the location of an address based on the street numbers at either end of street segment. For example, if a street segment runs from 100 Main St. to 200 Main St., then a request for 150 Main St. will return a location in the middle of the segment. With interpolation, the geocoder finds the position of 180 Main St. in the point data, and it is about two-thirds of the way down the street. Using this information, the geocoder can estimate the position of 150 Main St. based on 100 and 180 Main St. In this case, the geocoder estimates the location of the address slightly away from the center of the segment.

Y: Yes, perform address point interpolation.
N: No, do not perform address point interpolation.

KeepMultimatch

Specifies whether to return results when the address matches to multiple candidates in the database. If this option is not selected, an address that results in multiple candidates will fail to geocode.

If you select this option, specify the maximum number of candidates to return using the MaxCandidates option (see below).

Y: Yes, return candidates when multiple candidates are found. Default.
N: No, do not return candidates. Addresses that result in multiple candidates will fail to geocode.

Option.MatchModeInt

Specifies how to determine whether a candidate is a close match. One of the following:

CustomMode: This option allows you to specify which parts of a candidate address must match the input address to be considered a close match. Use the MustMatch<Element> options to specify the address elements you want. This is the default value for most countries.
ExactMode: All of a candidate address's elements must match in order for the candidate to be considered a close match.; Note that for IND, Exact match mode returns the sublocality and place name information
CloseMode: Only the candidate address's house numberstreet name and town must match in order for the candidate to be considered a close match. For Chile, China, Great Britain, Estonia, India, Indonesia, Latvia, Lithuania, Slovakia, Slovenia, Taiwan, and South Africa, only the street name and town must match.
RelaxedMode: All candidate addresses are considered a close match. This is the default value for Japan.

MustMatchInput

Specifies whether candidates must match all non-blank input fields to be considered a close match. For example, if an input address contains a city and postal code, then candidates for this address must match the city and postal code to be considered a close match.

Y: Yes, a candidate must match all input to be considered a close match.
N: No, a candidate does not have to match all input to be considered a close match. Default.

MustMatchHouseNumber

Specifies whether candidates must match the house number to be considered a close match.

House number data is not available for every country.

The Africa and Middle East countries do not generally have house numbers in the data source.

Some countries covered in the Latin America database have house number data. See Address Guidelines for Latin America for details of Latin America house number and postal coverage.

If you select this option you should also require an exact match on street name. This option does not significantly affect performance. It does, however, affect the type of match if the candidate address corresponds to a segment that does not contain any ranges. The type of match can also be affected when the house number range for a candidate does not contain the input house number. If you relax the house number, you should set the maximum ranges to be returned to a value higher than 0.

Y: Yes, a candidate must match the house number to be considered a close match.
N: No, a candidate does not have to match the house number to be considered a close match.

MustMatchStreet

Specifies whether candidates must match the street name to be considered a close match.

This option is not used for this country.

If a close match is found, the geocoder attempts expanded street name manipulation, which looks for candidates with names that sound like the input address or that are spelled improperly. This slows down performance but increases the match rate . If the geocoding database is indexed, the performance impact is reduced.

Y: Yes, a candidate must match the street name to be considered a close match.
N: No, a candidate does not have to match the street name to be considered a close match.

MustMatchLocality

Specifies whether candidates must match the locality (or equivalent) to be considered a close match. The meaning of Locality varies for different countries.

If you do not require exact matches on locality, the geocoder searches on the street address matched to the particular postal code, and considers other localities that do not match the name, but do match the postal code.

The majority of African and Middle East countries do not use locality or equivalent as part of an address. If a locality is matched it can contribute to a higher candidate ranking, but there is no penalty if locality is omitted or unmatched.

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
CRI (Costa Rica)—Not used
CUB (Cuba)—Not used
CZE (Czech Republic)—Locality
DEU (Germany)—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
GTM (Guatemala)—Not used
GUY (Guyana)—Not used
HKG (Hong Kong) —Locality
HND (Honduras)—Not used
HRV (Croatia)—Settlement
HUN (Hungary)—Locality
IDN (Indonesia)—Village
IND (India)—Locality
ISL (Iceland)—Not used
IRL (Ireland)—Not used
ITA (Italy)—Locality
JAM (Jamaica)—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
PHL (Philippines)—Locality
POL (Poland)—Not used
PRT (Portugal)—Locality
PRY (Paraguay)—Not used
QAT (Qatar)—Not used
ROU (Romania)—Not used
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
YEM (Yemen)—Not used
ZMB (Zambia)—Not used
ZWE (Zimbabwe)—Not used
ZAF (South Africa)—Locality

Y: Yes, a candidate must match the locality to be considered a close match.
N: No, a candidate does not have to match the locality to be considered a close match.

MustMatchCity

Specifies whether candidates must match the city to be considered a close match. For Japan, this field specifies whether the candidate must match the municipality subdivision (oaza). If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code.

Specifies whether candidates must match the municipality subdivision (oaza) to be considered a close match. If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code.

Y: Yes, a candidate must match the city to be considered a close match.
N: No, a candidate does not have to match the city to be considered a close match.

MustMatchCounty

Specifies whether candidates must match the county (or equivalent) to be considered a close match. The meaning of county varies for different countries.

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
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
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
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
IRL (Ireland)—Province
ISL (Iceland)—Not used
ITA (Italy)—Province
JAM (Jamaica)—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
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)—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)—Not used
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
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
TTO (Trinidad and Tobago)—Not used
TWN (Taiwan)—Not used
TZA (Tanzania)—Not used
UGA (Uganda)—Not used
UKR (Ukraine)—District
URY (Uruguay)—Not used
VEN (Venezuela)—Region
ZAF (South Africa)—District
ZMB (Zambia)—Not used
ZWE (Zimbabwe)—Not used

One of the following:

Y: Yes, a candidate must match the county to be considered a close match.
N: No, a candidate does not have to match the county to be considered a close match.

MustMatchStateProvince

Specifies whether candidates must match the state or province (or equivalent) to be considered a close match.

This option is not used for this country.

The majority of African and Middle East countries do not use a state/province or equivalent as part of an address. If a state/province is matched it can contribute to a higher candidate ranking, but there is no penalty if state/province is omitted or unmatched.

AGO (Angola)—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
ITA (Italy)—Region
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)
TTO (Trinidad and Tobago)—Not used
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
ZMB (Zambia)—Not used
ZWE (Zimbabwe)—Not used
ZAF (South Africa)—State

One of the following:

Y: Yes, a candidate must match the state or province to be considered a close match.
N: No, a candidate does not have to match the state or province to be considered a close match.

MustMatchPostalCode

Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates.

This field is not used in this country. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding. Some countries covered in the Latin America database have postal code data. See Address Guidelines for Latin America for details of Latin America house number and postal coverage.

For India, the Postal code must match preference can be used for geographic geocoding. This can produce better geographic matched candidates. For other countries, Postal code match preference can be used with street or postal geocoding only.

Y: Yes, a candidate must match the postal code to be considered a close match.
N: No, a candidate does not have to match the postal code to be considered a close match.

MustMatchPostDistrict

Specifies whether the postal district portion of the postcode must match in order for the match to be considered a close match.

UK postcodes are divided into two sections: the outward code, which is to the left of the space, and the inward code, which is to the right. The outward code represents the postal district. For example, in the postcode CB3 OHH, the postal district is CB3, which is Cambridge.