Create an Address Status Field¶
Overview¶
The address status field records the outcome of verification for a single address. It is the only additional field that is mandatory: without it AddressTools has no way to tell a verified address from one it has never checked, so verification cannot run against the block.
It is also how batch verification chooses its records: a batch run only verifies addresses whose status is Not checked, so the field prevents it from reprocessing addresses it has already handled. A record-triggered flow verifies whatever record it is given, so there the same protection comes from the flow's entry conditions.
Note: The address blocks supplied out of the box for Accounts, Contacts, Contracts and Leads already include an address status field. Follow this guide when you are configuring an address block of your own.
Step 1: Create the Field¶
- Navigate to Setup > Object Manager.
- Select the object, then select Fields & Relationships.
- Click New.
- Choose Picklist as the data type and click Next.
- Enter a Field Label naming the address it belongs to, for example
Billing Address Status. -
Select Enter values, with each value separated by a new line, and enter these values in order:
-
Select Use first value as default value, and make sure Not checked is first in the list.
- Clear the Restrict picklist to the values defined in the value set checkbox.
- Click Next.
- Provide visibility to all the users who will be verifying addresses, then click Next.
- Add the field to the page layouts where you want the status visible, then click Save.
Note: Leaving the picklist unrestricted matters. AddressTools writes the status returned by the verification service, and a restricted picklist will reject any value not in your list.
Step 2: Map it on the Address Block¶
- Click the App Launcher to search for and select AddressTools Administration.
- Select Address Blocks from the left menu.
- Open the block for this address by using the dropdown to select Edit.
- In the Additional Address Fields section, set Status Field to the field you just created.
- Click Save.
What the Values Mean¶
| Value | Meaning |
|---|---|
| Not checked | The address has not been through verification. This is the starting state. |
| Not matched | The address could not be matched to a record in the postal data. |
| Parsed but not found | The address values partially matched a verified address. |
| Ambiguous | The address values matched more than one verified address. |
| Verified | The address was verified against the postal data. |
Using Verification¶
The address status field is required for verification to work, so creating it for custom addresses and objects is your first step. To fully enable verification in your org, follow the rest of the setup steps in Verification.