Matching Options

Matching options let you set match restrictions, fallback, and multiple match settings so that the matching can be as strict or relaxed as you need. The strictest matching conditions require an exact match on house number, street name, postal code and no fallback to postal code centroids. The geocoder looks for an exact street address match within the postal code in the input address. Relaxing the conditions broadens the area in which it searches for a match. For example, by relaxing the postal code, the geocoder searches for candidates outside the postal code but within the city of your input address.

For guidelines on how to balance match rate and precision, see Balancing Match Rate and Precision.

Table 1. Matching Options for Australia
optionName	Description
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.
MaxCandidates	If you specify KeepMultimatch=Y, this option specifies the maximum number of results to return. The default is 1.
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.
MatchMode	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. RelaxedMode All candidates are considered close.
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. 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. 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. 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	This option is not used for this country.
MustMatchCity	Specifies whether candidates must match the city 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 Local Government Authority (LGA) to be considered a close match. 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 to be considered a close match. 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. 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.
PreferPostalCodeOverCity	Specifies whether to return a close match when the postal code and street match exactly but the city does not. If you enable this option, the City input field is ignored if the postal code and street address are an exact match. If you do not enable this option, there may be situations where street address and postal code input are an exact match but the city name is not, and close matches are not returned. For example, without this option enabled, the following input address would return no close matches: `5 East St GLENROY VIC 3046` With this option enabled, this same input address would return the following close match: `5 EAST ST HADFIELD VIC 3046` One of the following: Y Yes, return close matches if the postal code and street address are an exact match and ignore the city input. N No, do not return close matches if the postal code and street address are an exact match and the city is not. Default.