Must Match Fields
"Must Match" fields allow you to set the match criteria for determining match candidates. The following "Must Match" fields are available:
- matchOnAddressNumber
- A match must be made to the input address number.
- matchOnPostCode1
- A match must be made to the input PostCode1 field.
- matchOnAreaName1
- A match must be made to the input AreaName1 field. See your country's section in the appendix for the definition of the AreaName1 field.
- matchOnAreaName2
- A match must be made to the input AreaName2 field. See your country's section in the appendix for the definition of the AreaName2 field.
- matchOnAreaName3
- A match must be made to the input AreaName3 field. See your country's section in the appendix for the definition of the AreaName3 field.
- matchOnAreaName4
- A match must be made to the input AreaName4 field. See your country's section in the appendix for the definition of the AreaName4 field.
- matchOnAllStreetFields
- A match must be made to the input street name, type and directional fields.
- mustMatchInput
- The other must match fields are ignored and any of the possible input fields provides, such as postal code and area names, must match against the candidate for the candidate to be returned.
Note: For USA, the Must Match field settings are not supported in single-line address matching.
The following table provides information on how to set a Must Match field.
| REST API | Feature Implementation |
|---|---|
| Service: | Geocode |
| Request Type: | POST |
| Object : Element | preferences : mustMatchFields |
| Key/Value: | Set the desired mustMatchFields = true. |
| Additional Information: | To enable setting the mustMatchFields option, matchMode must be set to Custom. |
For more information, see Geocode POST Request.