Configure
Address Lookup exports a setup method to apply address verification to a form. setup requires the following configuration at minimum.
apiKey and outputFields below are all you need to get Address Lookup working. For the complete set of controller options, see Additional Configuration.
API Key
API Key from your AddressZen account. Typically begins ak_
Address Targets
Specify where to send address data given a selected address. outputFields is an object which maps an address attribute to an input field. The input field can be identified by CSS or reference to the DOM element itself.
{
line_1: "#line_1",
line_2: "#line_2",
city: document.getElementById("city"),
state: document.getElementById("state"),
zip_plus_4_code: document.getElementById("zip_code")
}
The fields above (line_1, line_2, city, state and zip_plus_4_code) are the minimum set needed to capture a complete, deliverable US address. Collect all of them so the address you store reliably routes to the premise.
Assigning up to 2 address lines, city, state and zip code fields, is all addressing information required to identify a US premise. You may extract more data for an address by passing more properties into the outputFields configuration object.
The configuration attributes for outputFields match the Address response object.
More complex, dynamic assignment can be performed using the onAddressRetrieved callback.
Output fields assigned with a query selector are evaluated lazily (i.e. when an address attribute needs to be piped to a field).