Endpoints

Each API operation is one function. Operations are grouped by resource. Examples use the ak_test key and placeholder identifiers; replace them with your own before running.

Address Search

Function	Endpoint	Auth	Summary
findAddress	GET /autocomplete/addresses	API key	Find Address
resolveAddress	GET /autocomplete/addresses/{address}/gbr	API key	Resolve Address

UK

Function	Endpoint	Auth	Summary
postcodes	GET /postcodes/{postcode}	API key	Lookup Postcode
addressCleanse	POST /cleanse/addresses	API key	Cleanse Address
addresses	GET /addresses	API key	Extract Addresses

Keys

Function	Endpoint	Auth	Summary
keyAvailability	GET /keys/{key}	Key in path	Availability
keyDetails	GET /keys/{key}/details	Management Key	Details
updateKeyDetails	PUT /keys/{key}/details	Management Key	Update Details
keyUsage	GET /keys/{key}/usage	Management Key	Usage Stats
keyLogs	GET /keys/{key}/lookups	Management Key	Logs (CSV)

Licensees

Function	Endpoint	Auth	Summary
listLicensees	GET /keys/{key}/licensees	Management Key	List
createLicensee	POST /keys/{key}/licensees	Management Key	Create
deleteLicensee	DELETE /keys/{key}/licensees/{licensee}	Management Key	Cancel
retrieveLicensee	GET /keys/{key}/licensees/{licensee}	Management Key	Retrieve
updateLicensee	POST /keys/{key}/licensees/{licensee}	Management Key	Update
regenerateLicenseeKey	POST /keys/{key}/licensees/{licensee}/regenerate-key	Management Key	Regenerate Key

Configs

Function	Endpoint	Auth	Summary
listConfigs	GET /keys/{key}/configs	Management Key	List
createConfig	POST /keys/{key}/configs	Management Key	Create
deleteConfig	DELETE /keys/{key}/configs/{config}	Management Key	Delete
retrieveConfig	GET /keys/{key}/configs/{config}	Key in path	Retrieve
updateConfig	POST /keys/{key}/configs/{config}	Management Key	Update

Emails

Function	Endpoint	Auth	Summary
emailValidation	GET /emails	API key	Email Validation

Phone Numbers

Function	Endpoint	Auth	Summary
phoneNumberValidation	GET /phone_numbers	API key	Phone Number Validation

Place Search

Function	Endpoint	Auth	Summary
findPlace	GET /places	API key	Find Place
resolvePlace	GET /places/{place}	API key	Resolve Place