Matching Options

Matching options are used to determine how address searches are performed. They let you set match preferences, criteria and restrictions, and multiple match settings so that the matching can be as strict or relaxed as you need.

Parameter Description

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

Specifies whether candidates must match the city. 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, candidates must match the city.
N
No, candidates do not have to match the city. Default.

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.

  • AUS (Australia) - The Local Government Authority (LGA)

Legal values: Y = Yes, N = No

Default value: N = No

Option.MustMatchHouseNumber

Specifies whether candidates must match the house number to be considered a close match. 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.

One of these:

Y
Yes, candidates must match the house number.
N
No, candidates do not have to match the house number.

Legal values: Y = Yes, N = No

Default value: N = No

Option.MustMatchPostalCode

Specifies whether candidates must match the postal code. 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.

Y
Yes, candidates must match the postal code.
N
No, candidates do not have to match the postal code. Default.

Option.MustMatchStateProvince

Specifies whether candidates must match the state. Only candidates matching the state or province are considered close.

Y
Yes, candidates must match the state.
N
No, candidates do not have to match the state.

Legal values: Y = Yes, N = No

Default value: N = No

Option.MustMatchStreet

Specifies whether candidates must match the street name to be considered a close match. 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, candidates must match the street name.
N
No, candidates do not have to match the street name.

Legal values: Y = Yes, N = No

Default value: N = No

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.

This option is not used for this country (AUS – Australia)

Legal values: Y = Yes, N = No

Default value: N = No