CORE MODULE

Configure Address Lookup

What you'll learn in this guide

How to connect the address autocomplete service at the system level, and how to build an address lookup into a form using individual Single Input fields mapped to the address data components.

Overview

CX Platform supports address autocomplete on forms. When a user starts typing into the first address line field, matching address suggestions appear. Selecting one automatically populates the remaining address fields — suburb, state, postcode, and country — without the user needing to type them in.

The address population uses PSMA (National Address Verification), which is used for Australian addresses only.

Setup happens in two stages. First, an administrator connects the address service at the system level via Edit settings. Then, form builders add a set of Single Input fields to their form templates and map each one to the corresponding address component.

‍

Before you start

The address autocomplete service comes pre-configured as part of your CX Platform setup — no additional connection steps are needed before you start adding address fields to your forms.

If autocomplete isn't working as expected, raise a ticket so we can can check the connection under the Address section in Edit settings.

‍

Build the address fields in your form

Address lookup doesn't use a single dedicated component — instead, you add individual Single Input fields for each part of the address and map each one to its corresponding address data component via the Data tab.

The key is that Address Line 1 must be the first field in the address block. This is the field that triggers the autocomplete as the user types. When a suggestion is selected, CX Platform uses the mapping on the remaining fields to populate them automatically.

Add and map each address field

  1. Open the form template, go to the Template tab, and select Form Designer.
  2. From the Toolbox, drag a Single Input component onto the canvas for Address Line 1. This must be the first field in the address block.
  3. Click Edit on the field, go to the Data tab, and set Address pre-population field to Address Line 1.
  4. Add a Single Input field for each remaining address component in order — Address Line 2, Suburb, State, Postcode, and Country.
  5. For each field, click Edit, open the Data tab, and set the Address pre-population field dropdown to the matching component from the list below.
  6. Click OK after configuring each field, then click Save in the Form Designer when all fields are set up.
  7. Use Test Form to confirm the autocomplete fires on Address Line 1 and populates the remaining fields correctly.

The available address components to map to are:

Address component Map to this field label
Address Line 1 Street number and street name. This field drives the autocomplete — it must come first.
Address Line 2 Unit, apartment, or suite number where applicable.
Suburb Populated automatically when a suggestion is selected.
State Populated automatically when a suggestion is selected.
Postcode Populated automatically when a suggestion is selected.
Country Populated automatically when a suggestion is selected.

‍

‍Multiple address blocks on the same form: If your form needs more than one address — for example, a Mailing address and a Residential address — repeat the process for each set of fields. For each field in the second address block, fill in the Address pre-population group field in the Data tab with a consistent group name (e.g. Mailing or Residential) so CX Platform knows which fields belong to which block.

‍

‍Pre-populating address fields: If you want to pre-populate the address fields with data from an external source as well as support autocomplete, tick Prefill field from supplied data? in each field's Data tab. This requires the form to be set to Private. See the Pre-fill Forms with User Data guide for full details.

‍

Once published, users typing into the Address Line 1 field will see matching address suggestions appear. Selecting one fills in all the remaining address fields automatically — no further typing needed.

‍