Multi-matches/Candidates

Parameter Description

Option.KeepMultimatch

Select this option to return the list of possible matches when there is more than one possible match for the input address and a single best match cannot be identified.

Y
Return the addresses that are possible matches for the input address. Default.
N
Do not return the ambiguous matches.

Option.KeepCandidates

Select this option to return candidate addresses whenever the match attempt produces candidates. If you enable this option, the geocoder will return candidates both when the input address matches to a single address and when the input address matches multiple addresses.

This parameter differs from Option.KeepMultimatch in that the Option.KeepMultimatch parameter does not return candidates if the input address matches to a single address.

Y
Return candidates for all match attempts.
N
Do not return candidates for all matches. Default.

Option.CloseMatchesOnly

If you specify Option.KeepCandidates=Y you can choose to return just those candidates that are considered to be a close match. The criteria used to determine whether a candidate is a close match are those you specify in the Option.MatchMode parameter.

Y
Return close match candidates only. Default.
N
Return all candidates.