Custom Preference: Address Autocomplete Service - 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

Custom preferences supported by the Autocomplete Address Service are for use against any country dataset.

Below are the custom preferences for Address Autocomplete API:

Parameter Type Description
ADDRESS_CASING String Returns street and city name results in the desired casing option ("PROPER", "LOWER" or "UPPER").
AUTOCOMPLETE string Autocomplete supports only two modes:
  • RELAXED (typo-tolerant)
  • CLOSE (strict)

COMPRESSED_AREA_RESULT

 Boolean Limits the search to given administrative area. Default: false
DATA_OPTION String Specifies the type of data option user opts for. Following are the available values for DATA_OPTION:
  • AddressBase
  • Premium (default)
For example:
 "customPreferences": {
         "DATA_OPTION": "addressbase"
     }

EXPANDED_RANGE_UNIT

 Boolean Custom preference to flatten the candidate ranges and units to individual candidates. Default value for EXPANDED_RANGE_UNIT is false, if set to true the candidates get flattened out.
KEY_CUSTOM_DICTIONARY_USAGE String possible values:

PREFER_CUSTOM_DICTIONARIES, PREFER_STANDARD_DICTIONARIES,
                                    USE_CUSTOM_DICTIONARIES_ONLY, USE_STANDARD_DICTIONARIES_ONLY
KEY_MUST_HAVE_LDU String Filters results that only match on Canada postcodes that have a FSA and LDU.
MATCH_ON_ADDRESS_NUMBER String The MATCH_ON_ADDRESS_NUMBER constraint does not exclude candidates if the house number does not match. Instead, it improves matching by giving preference to candidates where the house number aligns. For example, if there are several house numbers on the same street, this constraint helps ensure that the input house number is matched when it is present in the data.
MAX_RESULTS Integer The maximum number of candidates to return.
SEARCH_ADDRESS_NUMBER Boolean Boolean value that enables results to prioritize address number searching if supported for a country. By default this feature is false. When search on address is set to true match on address number is automatically set to true too.
SEARCH_ON_POBOX Boolean Boolean value that enable search on PO Box information if supported for a country. By default this feature is false.


SEARCH_TYPE

 String Custom preference to control search type of interactive requests.

default: ADDRESS_COMPLETION

possible values:
                                    ADDRESS_COMPLETION,
                                    POINT_OF_INTEREST_COMPLETION,  POINT_OF_INTEREST_NAME_COMPLETION,                       POINT_OF_INTEREST_CATEGORY_COMPLETION,
                                    STATE_PROVINCE_COMPLETION,
                                    WORLD_PLACES
                                    ALL
SEARCH_UNIT_INFORMATION Boolean Enables search on the unit information if supported for a country. By default this feature is disable.
Note: With the enablement of this preference, there might be cases where the customer may observe some performance implications as it leads to the wider searches and more processing.