Preferences - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product

Data_Integrity

Spatial_Analytics

Data_Enrichment

geo_addressing_1

Services

Spatial Analytics

Data Enrichment

Geo Addressing

ft:title

Data Integrity Suite APIs

ft:locale

en-US

PublicationType

pt_developer

copyrightfirst

2023

copyrightlast

2026

Preferences are configuration options that control the behavior of the Geocode API. They define how requests are processed, how results are returned, and what fallback or matching strategies are applied. These fields are optional but allow fine‑tuning of the API's response.

Option	Type	Description
clientCoordSysName	String	Specifies the coordinate system that you want to convert the geometry to. The format must be the European Petroleum Survey Group (EPSG) code or the SRID code. Default = `EPSG:4326`. Specify the coordinate reference system in the format `codespace:code`. Note: The API always returns the output coordinates in EPSG:4326, regardless of the input coordinate system.
cornerOffset	Distance	Specify the distance to offset the street endpoints in street-level matching. This is used to prevent addresses at street corners from being given the same geocode as the intersection. Defines the offset position of the geocoded point with respect to the corner. The default is 7 meters.
data_option	String	Specifies the type of data option user opts for. Following are the available values for DATA_OPTION: addressbase premium (default) enterprise essentials For example: `"customPreferences": { "DATA_OPTION": "addressbase" }`
distance	Distance	Define the search radius. The default is 5 meters.
fallbackToGeographic	Boolean	Specifies whether to attempt to determine a geographic region centroid when an address-level geocode cannot be determined. Optional. true Return a geographic centroid when an address-level centroid cannot be determined. Default. false Do not return a geographic centroid when an address-level centroid cannot be determined.
fallbackToPostal	Boolean	Specifies whether to attempt to determine a postcode centroid when an address-level geocode cannot be determined. Optional. true Return a postcode centroid when an address-level centroid cannot be determined. Default. false Do not return a postcode centroid when an address-level centroid cannot be determined.
matchMode	String	Match modes determine the leniency used to make a match between the input address and the reference data. Select a match mode based on the quality of your input and your desired output. The following match modes are available: EXACT Requires a very tight match. This restrictive mode generates the fewest match candidates, which decreases the processing time. STANDARD Requires a close match and generates a moderate number of match candidates. Default. RELAXED Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches.
maxResults	Integer	The maximum number of candidates to return. Default = 1.
returnAllInfo	Boolean	Specifies whether to return all available information for each candidate. true Return all available information for each candidate. false Do not return all available information for each candidate. Default.
returnOfAdditionalFields	<String> array	This lets the user control which additional fields they want to have returned if they do not want to return all info. For example, to return the Street segment identifier, use the value `SEGMENT_ID` `{ "preferences" : { "returnOfAdditionalFields " : ["SEGMENT_ID"] } }`
streetOffset	Distance	Specify the offset distance from the street segments to use in street-level geocoding. The offset prevents the geocode from being in the middle of a street. The default is 7 meters.
type	String	Indicates the geocode type to be performed. ADDRESS Geocode to a street address. Default. GEOGRAPHIC Geocode to the geographic centroid of a city or state. POSTAL Geocode to a postal code.