Skip to main content

Overview

To authenticate with AddressZen, you need:
  1. API Key — an API key from your AddressZen account.
This guide will show you how to find it.

Prerequisites

  • An AddressZen account. If you don’t have one, sign up. Your first API key receives a free trial balance.

Step 1: Copy your API key

  1. Sign in to your AddressZen account and click Keys in the sidebar. Your API keys are listed here. Click the key you want to use to open its overview page.
AddressZen Keys page with an API key listed
  1. In the API Key card, click Copy. The key begins with ak_.
AddressZen key overview page with the Copy button in the API Key card highlighted You can create up to 10 API keys with New key on the Keys page. If you sub-license AddressZen, a licensee key (begins sl_) works in place of an API key and bills that licensee.

Step 2: Enter your API key in the Connect UI

  1. Open the form where you need to authenticate with AddressZen.
  2. Enter your API key in the API Key field.
  3. Submit the form, and you should be successfully authenticated.
AddressZen Connect UI form with the API Key field You are now connected to AddressZen.