Address Auto-Complete and Validation
  • 20 Mar 2022
  • 5 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Address Auto-Complete and Validation

  • Dark
    Light
  • PDF

Introduction

You can integrate Loqate address verification service with the Lightico platform so that your customer is provided with suggestions as they type their address into a form. This integration streamlines the form process for your customer and ensures that they provide a valid address.

In addition, each component of the address is broken down into separate elements called properties that can be used for different parts of the customer journey. For example, if a part of the journey depends upon what country the customer is from, the information is taken from the Country property that is defined by the autocomplete results.

Note:
If you do not have a Loqate account, you may request an API key from Lightico customer success.

This feature is configured in the following steps:

Connect the Address Verification Service

The first step in configuring this feature is to connect your Loqate account to your Lightico platform.
To connect Loqate address verification service to Lightico:

  1. In the Lightico Administration screen navigation pane, click Integration hubs.
    The Integration hubs page appears.
  2. Under Add New Integration, click the Loqate hub.
    The Loqate hub page opens.

    You can enter a name and description for this hub at the top of the page.
  3. On the Connectivity tab, enter your Loqate API Key and click Save.
    The Loqate address verification hub is connected.


    Note:
    On the Address Property tab you can view the properties that need to be mapped (see below).
Note:
Only one Loqate account hub can be configured. After you configure one, the Loqate hub is grayed out in the Add New Integreation area.

Create Custom Address Attributes

The auto-completed address is broken down into separate elements called properties. You must map a custom attribute to each of the address properties that you are using in order for the address auto-complete and validation feature to work properly.

In this section you will create custom attributes for each of the address properties. Some of the properties are mandatory for the feature to work properly and some are optional. The tables below list all the properties and also suggest names for each of the corresponding attributes.

Note:
Each attribute name used in a session must be unique. So, consider that you might need to collect two or more types of addresses from your customer. Instead of naming an attribute “address_line_2”, we suggest naming it “address_line_2_home” so that you could later include “address_line_2_work” in the same session and there would be no conflict.

Required Property

Suggested Attribute Name

Address line 2

address_line_2_home

Street

street_home

Building/St. Number

building_number_home

City

city_home

Country

country_home

State/Province/Region

state_home

Zip Code

zip_code_home

Optional Property

Suggested Attribute Name

SubBuilding

subbuilding_home

BuildingNumber

buildingnumber_home

BuildingName

buildingname_home

SecondaryStreet

secondarystreet_home

Block

block_home

Neighborhood

neighborhood_home

District

district_home

ProvinceName

provincename_home

ProvinceCode

provincecode_home

CountryISONumber

countryisonumber_home

POBoxNumber

poboxnumber_home

To create custom attributes for the address validation feature:

  1. In the Lightico Administration screen navigation pane, click Attributes mapping.
    The Attributes mapping page opens, displaying the existing attributes.
  2. Click Add Custom Attribute .
    The Add Custom Attribute dialog opens.
  3. Complete the required fields as follows (see the above image as an example):
    • Entity - Select Document
    • Name - See the tables above for suggestions
    • Description - Enter the text that appears in the customer form for this property.
    • Type - Select Text
    • Max Length - Enter the maximum number of characters that can be entered
  4. Complete any optional fields if needed and click Save.
    The first attribute is saved.
  5. Repeat steps 2-5 to create an attribute for all of the mandatory fields listed in the first table above and any of the optional attributes that you wish from the second table.
Note:
For a description of each field, see Create basic attributes.

Map the Attributes to the Address Properties

Now, you can map the custom attributes that you created to the address properties. In addition, you will define a name for the entire group of mapped attributes.

To map the attributes to the address properties: 

  1. On the Attributes mapping page, click Add Custom Attribute.
    The Add Custom Attribute dialog appears.
  2. In the Entity drop-down, select Document.
  3. In the Name field, enter a name that will serve as the group name for all the attributes.
    Note:
    You will need to remember this name for the next section when you create a form.
  4. From the Type drop-down, select Address.
    The Address Validation settings appear at the bottom of the dialog box showing all the Mandatory and Optional properties that are relevant to the address validation hub.
  5. For each of the Mandatory and Optional properties that you are using, select the attribute that you want to map it to.
  6. Click Save.
    All the address attributes are mapped to the address properties.

Create a Form for Obtaining Validated Addresses

The last step in configuring the Address Auto-Complete and Validation feature is to create a form. This form enables your agent to obtain a validated address from your customer during a Lightico session.

For the purposes of this article we will show how to create a simple form with an address field. To create a more detailed form, see Create forms.

To create a form for obtaining validated addresses:

  1. In the Lightico Administration screen navigation pane, click Workflow > Form Designer.
    The Forms page opens.
  2. Click Create in the top right corner.
    The Create New Form dialog appears.
  3. Enter a name for the form and click Create.
    The Form Designer opens.
  4. Add text fields for the customer’s first and last name (or any other fields you need).
  5. Click + to add another field.
    The Add item dialog appears.
  6. Select Address and in the Attributes column, select the name that you gave to the group of address attributes in the previous section of this article.
    Two new fields appear on the form designer page:
    1. Address - Connected to all the attributes that you created. This is an active field that will show suggested addresses when the customer starts typing.
    2. Address Line 2 - Text field for the customer to add any custom descriptions of their address, such as apartment, suite, unit, floor, etc.
  7. In the Address Settings to the right of the page configure the following:

Label

Edit the text that appears in the main address field and the “address line 2” field before the customer fills it in.

Required

  • Select Yes to make the address field required and No to not require it.
  • If you selected required, you will have the option of making the Address Line 2 field required or not.

Validations

You can customize the message that the customer receives if they type an address that cannot be validated. The default message is “Invalid address”.

Configuration

  • Click Yes to limit the auto-fill suggestions to one country. Select the country in the field below.
  • Click No to search worldwide.

Property Labels

Customize the text that appears in the “address line 2” field before the customer fills it in.

  1. Click Save at the top of the page.
  2. Now, all you have to do is create a workflow for this form like the one below (for more detailed instructions, see Create workflows).

Sending the Valid Address Form to a Customer

 To send the form to a customer:

  1. From the Agent screen, click Workflows and select the Address workflow.
  2. The customer receives the form and clicks Open.
  3. The customer starts typing until the correct address appears in the suggestions.
    Note:
    No more than five suggestions appear at a time.
  4. The customer selects the correct address, enters any extra information in the text field, and clicks Next.
    The validated address is obtained.

Was this article helpful?