Parameters for Addresses Outside the U.S. - Spectrum_OnDemand - Latest

Spectrum OnDemand Web Services (REST)

Product type
Software
Portfolio
Verify
Product family
Spectrum
Product
Spectrum > Quality > Context Graph
Spectrum > Spatial > Spectrum Spatial Analyst
Spectrum > Spectrum Platform
Spectrum > Quality > Addressing
Spectrum > Quality > Spectrum Quality
Spectrum > Web Services
Spectrum > Dataflow Designer
Spectrum > Discovery
Spectrum OnDemand
Spectrum > Spatial > Spectrum Spatial Insights
Spectrum > Spatial > Spectrum Spatial
Spectrum > Geocoding > Enterprise Tax
Version
Latest
Language
English
Product name
Spectrum OnDemand
Title
Spectrum OnDemand Web Services (REST)
Copyright
2024
First publish date
2006
ft:lastEdition
2024-07-17
ft:lastPublication
2024-07-17T23:23:16.481321

The name of one or more database resources to use in the search process. Use the database name specified in the Management Console. You can specify multiple database resources. If you specify more than one database, list them in order of preference. The order of the databases has an effect when there are close match candidates from different databases. The close matches that are returned come from the database that is first in the search list. Close matches from lower ranked databases are demoted to non-close matches. You can also use the order of the databases to perform fallback processing if you have both an address point database and a street-level database installed for the country. List the address point database first and the street database second. If the address cannot be geocoded to the address point level, the geocoder will attempt to geocode it to the street level.

Parameter

Description

Option.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.

Option.CAN.MustHaveFullPostalCode

Specifies whether a candidate address must have a full postal code (FSA and LDU) to be considered a close match.

Canadian postal codes are divided into two sections: the Forward Sortation Area (FSA) and the Local Delivery Unit (LDU). For example, the postal code M6H 2P8 has an FSA of M6H and an LDU of 2P8. Some candidate addresses may contain only the FSA. This option allows you to prevent such addresses from being classified a close match.

Y
Yes
N
No (Default)

Option.MaxRanges

Maximum ranges per candidate to be returned.

Default value is 0.

Option.OffsetFromStreet

Indicates the offset distance from the street segments to use in street-level geocoding. The distance is specified in the units you specify in the OffsetUnits option. The default value varies by country. For most countries, the default is 7 meters.

The offset distance is used in street-level geocoding to prevent the geocode from being in the middle of a street. It compensates for the fact that street-level geocoding returns a latitude and longitude point in the center of the street where the address is located. Since the building represented by an address is not on the street itself, you do not want the geocode for an address to be a point on the street. Instead, you want the geocode to represent the location of the building which sits next to the street.

For example, an offset of 40 feet means that the geocode will represent a point 40 feet back from the center of the street. The distance is calculated perpendicular to the portion of the street segment for the address. Offset is also used to prevent addresses across the street from each other from being given the same point. The diagram below shows an offset point in relation to the original point.

Option.AUS.IncludeInputs

AUS returns parsed address. Returned the standard street type abbreviation instead of the spelled out type.

Y
Yes, return the parsed address.
N
No, do not return the parsed address.

Default Value is N (No).

Note: This is applicable to AUS-Premium stage only.

Option.OffsetUnits

Specifies the unit of measurement for the street offset and corner offset options.

One of these:
  • Ft
  • Mi
  • M
  • Km

Legal Values: ft = Feet, mi = Miles, m = Meters, km = Kilometers

Default Value is m (Meters).

Option.OffsetFromCorner

Specifies the distance to offset the street end points in street-level matching. The distance is specified in the units you specify in the OffsetUnits option.This value is used to prevent addresses at street corners from being given the same geocode as the intersection.
Note: Offset is not supported for the United Kingdom (GBR) or Japan (JPN).
The default value varies by country:
  • 12 meters—Australia (AUS), Austria (AUT), Germany (DEU)
  • 7 meters—For other supported countries

Default value is 7.

Option.DatabasePreference

Specifies which geocoding databases to use. One of these:

PreferCustom

Use both standard databases and custom databases, but give preference to candidates from custom databases. Use this option if you feel your custom database is superior to the standard database.

PreferStandard

Use both standard databases and custom databases, but give preference to candidates from standard databases.

CustomOnly
Use only custom databases. Ignore standard databases
StandardOnly
Use only standard databases. Ignore custom databases.
Both

Use both standard databases and custom databases. In cases where candidates are returned from both, the standard database is preferred. Default.

Legal Values: StandardOnly = Use Standard Databases Only

Default Value: StandardOnly = Use Standard Databases Only

Option.MaxCandidates

Maximum number of candidates returned for a Request.

Default Value is 1.

Option.IncludeInputs

Return parsed address. Returned the standard street type abbreviation instead of the spelled out type.

Legal Values: Y = Yes, N = No

Default Value is N.

Option.CoordinateSystem

The coordinate system is used to determine the latitude and longitude coordinates. A coordinate system specifies the detsils such as a map projection, coordinate units.

An example is EPSG:4326. EPSG stands for European Petroleum Survey Group.

Option.MaxRangeUnits

Maximum number of range units that is returned for each range.

Default Value is 0.

Option.GeocodeLevel

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

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).

Option.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.

Option.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.

Option.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.

Option.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.MatchMode

CustomMode
Allows you to select the specific criteria to use when matching the input address to an address in the postal database.
ExactMode
Requires a very tight match. This is a restrictive mode that generates the fewest number of match candidates to search, which decreases the time to obtain a match. When using this mode, ensure that your input address list is very clean; free of misspellings and incomplete addresses.
CloseMode
Requires a moderately confident match. Generates a moderate number of match candidates.
RelaxMode
This is the loosest match mode and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if your address list may contain misspellings and incomplete addresses. This mode does not respect the street parity for an address match. Default.

Default Value: RelaxedMode (Relaxed Mode)

Option.OutputCasing

Specifies the casing of the output data.

M
Returns the output in mixed case. Default. For example:

123 Main St
Mytown FL 12345

U
Returns the output in upper case. For example:

123 MAIN ST
MYTOWN FL 12345

Option.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.

Option.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.

Option.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.

Option.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.

Option.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.

Option.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.

Option.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 these:

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.

Option.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.

Option.ReturnRanges

Specifies whether to return address range information. If you enable this option, the output field Ranges will be included in the output.

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.

Y
Yes, return address range information.
N
No, do not return address range information. Default.

Default Value is N.