Enable the Address autocomplete feature

To enable this feature, you must update the configuration in your tenant's physical configuration. Contact your Customer Support executive for licensing and enabling this feature on your tenant.

Configure the feature for an entity type

When integrating Address AutoComplete into the Hub UI, the configuration is managed in the cleanseConfig section of the entity type (e.g., Location). This configuration extends standard Loqate cleansing by enabling search-as-you-type and autocomplete suggestions directly in the UI.

In the L3 configuration, include the following configuration for the entity type for which you want to enable address autocomplete:

{
  "uri": "configuration/entityTypes/Location",
  "label": "Location",
  "description": "Address information with GeoLocation",
  "cleanseConfig": {
    "mappings": [...],
    "infos": [...],
    "addressAutoCompleteConfig": {
      "uri": "configuration/entityTypes/Location/cleanse/addressAutoCompleteConfig",
      "minSearchTextLen": 3,
      "providerOpts": {
        "Countries": "US;IND",
        "Limit": 20
      },
      "inputMapping": [
        {
          "attribute": "configuration/entityTypes/Location/attributes/AddressInput",
          "mandatory": true,
          "allValues": false,
          "cleanseAttribute": "Text"
        },
        {
          "attribute": "configuration/entityTypes/Location/attributes/ISO3166-2",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "Countries"
         },
         {
          "attribute": "configuration/entityTypes/Location/attributes/ISO3166-3",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "Countries"
         }
      ],
      "outputMapping": [
        {
          "attribute": "configuration/entityTypes/Location/attributes/AdministrativeArea",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "AdminAreaName"
        },
        {
          "attribute": "configuration/entityTypes/Location/attributes/StateProvince",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "AdminAreaName"
        },
        {
          "attribute": "configuration/entityTypes/Location/attributes/Building",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "BuildingNumber"
        }
      ]
    }
  }
}

In the above example, note the following parameters:

• minSearchTextLen - the minumum number of characters you must type before triggering autocomplete list. This field defaults to 3, if not defined in the L3 configuration.

• providerOpts.Countries - list of ISO country codes to restrict suggestions, separated by a semicolon. This field defaults to US, if not defined in L3 configuration.

• providerOpts.Limit - the maximum number of address suggestions that must be returned. This field defaults to 20, if not defined in the L3 configuration.

  • inputMapping - Defines which attributes in the entity type serve as the input fields for the Search API request parameters. Here's the list of input mapping fields:

    Field	Description
    Text	The text to search for
    Countries	The list of countries (as a comma separated list of ISO 2 or 3 characters) to limit the search

• outputMapping - Maps returned address fields from the Fetch API to entity attributes. This allows address components such as AdminAreaName or BuildingNumber to populate attributes like StateProvince or Building. Here's the list of output fileds:

  Table 1. Address Fields Reference

  Field	Description
  Id	string — The unique Id of the returned address as generated by Capture, for use in a subsequent RETRIEVE call (note that this Id can change over time).
  DomesticId	string — The unique reference number of the address in its dataset (e.g., UDPRN in Royal Mail PAF). Example: If Id is "GB|RM|B|55605138|ENG", DomesticId is "55605138".
  Language	string — A three-letter code denoting the language of the address (e.g., "ENG" for English).
  LanguageAlternatives	string — Comma-separated list of alternative language versions (e.g., "GER, ENG").
  Department	string — Business department name at the address, if applicable (e.g., "Accommodation Office").
  Company	string — Name of the company associated with the address.
  SubBuilding	string — Sub-building name (e.g., "Flat 4", "Unit 2").
  BuildingNumber	string — House or building number.
  BuildingName	string — Associated building name.
  SecondaryStreet	string — Secondary thoroughfare name.
  Street	string — Main thoroughfare name.
  Block	string — Block details.
  Neighbourhood	string — Neighbourhood of the address.
  District	string — District name.
  City	string — Town or city name.
  Line1	string — First line of the formatted address (e.g., "Old Change House").
  Line2	string — Second line of the formatted address.
  Line3	string — Third line of the formatted address.
  Line4	string — Fourth line of the formatted address.
  Line5	string — Fifth line of the formatted address.
  AdminAreaName	string — Name of the administrative area (e.g., county or council name).
  AdminAreaCode	string — Code of the administrative area (e.g., "061").
  Province	string — Based on address format: ProvinceName or ProvinceCode.
  ProvinceName	string — Name of the country's largest administrative division.
  ProvinceCode	string — Code of the administrative division.
  PostalCode	string — Full postal code (ZIP, Postcode, etc.).
  CountryName	string — Full country name (ISO 3166-1).
  CountryIso2	string — Two-character ISO country code (e.g., "GB").
  CountryIso3	string — Three-character ISO country code (e.g., "GBR").
  CountryIsoNumber	string — ISO numeric country code (e.g., "826").
  SortingNumber1	string — Bulk mailing discount number 1.
  SortingNumber2	string — Bulk mailing discount number 2.
  Barcode	string — Barcode for bulk mailing (e.g., "(EC4V4BJ2ZE)").
  POBoxNumber	string — PO Box number.
  Label	string — Full formatted address label using '\n' for line breaks.
  Type	string — Address type: Residential | Commercial | Unknown.
  DataLevel	string — Data granularity level: Unknown | Premise | RangedPremise | Street | City.

Address input fields in the specified entity type now support real-time suggestions and automatic field population when users select an address. Fields are mapped and updated according to the output mapping.

If you wish to use the Address Autocomplete feature outside of Reltio or in some other application or webpage, then Business configuration is not required. The feature should still be enabled on your tenants.