Configure address autocomplete for an entity type

Learn how to configure address autocomplete for an entity type in your tenant to enable real-time address suggestions in the Reltio Hub.

Address autocomplete is configured at the entity type level by adding an addressAutoCompleteConfig block to the cleanseConfig section of the entity type definition in the L3 configuration.

Note: The entity type level configuration is required only if you want to use Address autocomplete in the Reltio Hub. If you intend to use the Search API and Fetch API in an external application, this configuration is not required.

Prerequisites

Before you begin, confirm the following:

License for Address autocomplete enabled for your tenant.
Access to edit the L3 configuration for the tenant.

To add the address autocomplete configuration:

Open the L3 configuration for the entity type you want to configure.
Locate the cleanseConfig section for the entity type.

Add the addressAutoCompleteConfig block inside cleanseConfig, as shown in the following example:

{
  "uri": "configuration/entityTypes/Location",
  "label": "Location",
  "cleanseConfig": {
    "addressAutoCompleteConfig": {
      "uri": "configuration/entityTypes/Location/cleanse/addressAutoCompleteConfig",
     
      "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"
        }
      ],
      "outputMapping": [
        {
          "attribute": "configuration/entityTypes/Location/attributes/AdministrativeArea",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "AdminAreaName"
        },
        {
          "attribute": "configuration/entityTypes/Location/attributes/Building",
          "mandatory": false,
          "allValues": false,
          "cleanseAttribute": "BuildingNumber"
        }
      ]
    }
  }
}

Define inputMapping entries to map entity attributes to the >Search request parameters. At minimum, map one attribute to the Text parameter, which carries the user's search input.

Note: The entity attribute mapped to the Text parameter is used as the address autocomplete input field in the Reltio Hub. For the Countries parameter, use only ISO 3166-1 two-character (Alpha-2) or three-character (Alpha-3) country codes. Full country names are not supported.
Define outputMapping entries to map the Fetch response fields to entity attributes. Each entry maps a Fetch API field (for example, AdminAreaName) to the corresponding attribute in the entity type (for example, AdministrativeArea).

Note: The address fields populated in the profile when a user selects an address are determined by the outputMapping configuration.
Save the configuration.

Result

Address fields in the configured entity type now display real-time suggestions as users type. When you select a suggestion, the Fetch API populates the mapped attributes with the full, validated address data.

Verification steps

In the Reltio Hub, open a profile and verify that address suggestions appear, and address fields are populated correctly. For more information, see Find and select an address with Address autocomplete.

Unify and manage your data

Configure address autocomplete for an entity type

Footer