# Installing Address Verification for Magento

To add address verification to your Magento store, follow these simple steps. You can enable address verification on your billing or shipping address forms. This guide will walk you through signing up for an account, installing the plugin, configuring it, and exploring advanced settings.

## Screenshots[​](#screenshots "Direct link to Screenshots")

![Activate Address Lookup on your address collection forms-screenshot](/assets/images/magento-demo-d0cee2f62dde889e9df1e2cc9307c47d.png)

## Works With[​](#works-with "Direct link to Works With")

Listed below are 3rd party Magento extensions we test against:

* [Mageplaza.com One Step Checkout](https://www.mageplaza.com/magento-2-one-step-checkout-extension/)
* [OneStepCheckout.com Extension](https://www.onestepcheckout.com/)

## Step 1: Sign Up for an Account[​](#step-1-sign-up-for-an-account "Direct link to Step 1: Sign Up for an Account")

To use AddressZen, you’ll first need to create an account and get your API key.

1. [Sign up](https://account.addresszen.com/users/sign_up?_gl=1*1aa97b8*_gcl_au*Njg3NjkxOTMuMTcyOTg0ODA1OQ..*_ga*MTk1OTgwOTIyNy4xNzEzODI3MzI0) to create a free account.
2. Navigate to the KEYS section in your account.
3. Copy your API Key - you’ll need this to complete the setup in Magento. It’s a string of characters that begins with the letters `ak_`.

***

## Step 2: Install the Magento Plugin[​](#step-2-install-the-magento-plugin "Direct link to Step 2: Install the Magento Plugin")

You have three ways to install the AddressZen plugin for Magento: directly through Magento marketplace, composer or manually.

### Method A: Install via Magento Marketplace[​](#method-a-install-via-magento-marketplace "Direct link to Method A: Install via Magento Marketplace")

This is the simplest method to integrate address verification to your Magento store.

You can purchase the extension from [Magento Marketplace](https://commercemarketplace.adobe.com/addresszen-magento.html) for free.

***

### Method B: Install via Composer[​](#method-b-install-via-composer "Direct link to Method B: Install via Composer")

1. Install via composer using this command

```
$ composer require addresszen/magento
```

2. Execute the following commands to complete the installation:

```
magento module:enable Addresszen_Lookup

magento setup:upgrade

magento setup:di:compile

magento setup:static-content:deploy -f
```

***

### Method C: Install Manually[​](#method-c-install-manually "Direct link to Method C: Install Manually")

1. Load the repository into your Magento directory
2. `app/code/Addresszen/Lookup` needs to be present in your Magento codebase
3. Retrieve the extension by the following methods:

* Download and "untar" from [our releases page](https://github.com/addresszen/magento/releases)

* Git clone this project

  ```
  $ git clone --depth=1 https://github.com/addresszen/magento.git
  ```

* Git clone a specific version

  ```
  $ git clone --branch <tag> -depth=1 https://github.com/addresszen/magento.git
  ```

4. Execute the following commands to complete the installation:

```
magento module:enable Addresszen_Lookup

magento setup:upgrade

magento setup:di:compile

magento setup:static-content:deploy -f
```

***

## Step 3: Plugin Setup[​](#step-3-plugin-setup "Direct link to Step 3: Plugin Setup")

1. Once the plugin is installed, it’s time to configure it.
2. Head to the administration page. Click`Stores Menu` -> `Configuration` -> `Services Tab` -> `AddressZen`.
3. Enter your API Key (the one you copied when signing up) in the designated field. You can always find the API Key under KEYS in your AddressZen account.

info

Read our guide on [creating an AddressZen account and enabling automated top-ups](/docs/guides/automated-topups.md).

***

## Configuration Options[​](#configuration-options "Direct link to Configuration Options")

![Configuring settings-screenshot](/assets/images/magento-config-5fe40152af754f2e5c7de9cf8cdce956.png)

### Required[​](#required "Direct link to Required")

#### Enabled[​](#enabled "Direct link to Enabled")

Enable or disable extension altogether.

#### API Key[​](#api-key "Direct link to API Key")

The API Key is required to verify your account for address verificication. This can be found on your account dashboard on [addresszen.com](/index.md).

### Optional[​](#optional "Direct link to Optional")

#### Enable Address Autocomplete[​](#enable-address-autocomplete "Direct link to Enable Address Autocomplete")

This will enable Address Lookup on the first address line on your address forms.

#### Remove Organization[​](#remove-organization "Direct link to Remove Organization")

This will prevent the organization name from being added to the address line one.

### Custom Forms and Configuration[​](#custom-forms-and-configuration "Direct link to Custom Forms and Configuration")

If you wish to add an additional field or using a custom form, include the parameter name [from our documentation](/docs/api/addresses.md).

```
[

  {

    'line_1': 'input[name="billing_street0"]',

    'line_2': 'input[name="billing_street1"]',

    'city': 'input[name="billing_city"]',

    'state': 'input[name="billing_state"]'

    'zip_plus_4_code': 'input[name="billing_zipcode"]'

  }

]
```

info

If you need support, you can either reach out to us via live chat or visit our [support page](https://addresszen.com/support).