What's the best way to setup and manage the AddressFinder service?

Account setup and maintenance

When setting up your account, only invite appropriate people to be users of the AddressFinder account. Invite them using their work email address so if they leave the company, and lose access to their work email address, they will lose access to the AddressFinder portal. On an annual basis, log into the portal and review and update the list of users. Invite new users and revoke access to old users as appropriate.

Documentation

Keep track of where the AddressFinder service has been integrated and any notes which may be useful to developers in the future. This is especially important if you make use of direct APIs as this can be tricky to track down. Also, if you are a larger organisation which uses the AddressFinder service on multiple sites/forms/CRMs, documentation is very important.

Testing the AddressFinder service

We recommend that whenever you add the AddressFinder service to any new page, or make changes to a page on which the service is running, you run a few test addresses through the page. These addresses should include a unit type address, a level containing address, a PO Box address, a standard address and your address. With each address, check that the different address parts populate the appropriate fields of your page/form.

Making direct API queries

Referrer information is not included in direct API queries by default. Adding a parameter named domain to the query string is advised (eg, &domain=staffdetails.crm). This will allow greater insights into the activity of your account. You can learn more about using this parameter in our FAQ.