Match Quality

matchquality=[0|1]

This parameter returns an additional object matchquality for every result in the response, containing the following elements: matchcode, matchtype, matchlevel.

matchqualitydetailsExpected Values
matchcodeSpecifies the quality of the returned addressexact, fallback, approximate. [Read more]
matchtypeSpecifies quality of the returned location matchpoint, centroid, interpolated. [Read more]
matchlevelSpecifies the most granular address element that matches the geocoding queryvenue, building, street, neighbourhood, island, borough, city, county, state, country, marine, postalcode. [Read more]

Match Code

Specifies the quality of the returned address

matchcodedescription
exactThe result matches the input query with a high level of probability
fallbackThe result does not exactly match the input but is closely related to it provided there is direct a hierarchical relation.
approximateThe result matches the input query with a medium to low level of probability.

Match Type

Specifies quality of the returned location match

matchtypedescription
pointThe coordinate returned is a point address, typically with rooftop accuracy
centroidThe coordinate returned is a centroid of a road or administrative boundary
interpolatedThe coordinate returned is a point determined by interpolation

Match Level

Specifies the most granular address element that matches the geocoding query

matchleveldetails
venueThe returned address is of a Point of Interest (PoI) level
buildingThe returned address is of a house level
streetThe returned address is on a street level
neighbourhoodThe returned address is on a neighbourhood level
islandThe returned address is on a island level
boroughThe returned address is on a borough level
cityThe returned address is on a city level
countyThe returned address is on a county level
stateThe returned address is on a state level
countryThe returned address is on a country level
marineThe returned address is on a marine level
postalcodeThe returned address is on a postal code level