Skip to content

Create an Authentication Token

Overview

An authentication token is required for AddressTools to communicate with ProvenWorks services. Without it, the features that call out to those services (address verification and the interactive type-ahead search) cannot run.

Creating the token is the first step on the AddressTools Administration tab and takes about a minute. You only need to do it once per org.

Step 1: Open the AddressTools Administration Tab

  1. Click the App Launcher to search for and select AddressTools Administration.
  2. Stay on the Installation tab, which opens by default.

Step 2: Create the Token

  1. Find the Create an Authentication Token step.
  2. Click Create Token.

A confirmation message reads "Authentication Token has been created successfully". If the token cannot be created, the step shows the error message with a trace ID beneath it; check your connection to the ProvenWorks services and try again, and quote the ID if you contact support. See Trace IDs.

Note: If a token already exists in your org, the button reads Update Token instead. Clicking it replaces the existing token, which is useful if the token has stopped working.

What This Does

The token identifies your org to the ProvenWorks services so that verification and search requests can be authorised. It is stored in your org and is not something users need to see or enter.

If the Token Stops Working

If users see the message "Service authentication failed; please refresh your authentication token on the AddressTools Administration page." when searching for or verifying an address, the org's token is no longer valid. Return to the Installation tab and click Update Token to generate a replacement.