Matching Options

Table 1. Matching Options

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.

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