Skip to main content

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.

FunctionEndpointAuthSummary
addressVerifyPOST /verify/addressesAPI keyVerify Address
findAddressGET /autocomplete/addressesAPI keyFind Address
retrieveAddressGET /autocomplete/addresses/{address}/usaAPI keyRetrieve Address

Keys​

FunctionEndpointAuthSummary
keyAvailabilityGET /keys/{key}Key in pathAvailability
keyDetailsGET /keys/{key}/detailsManagement KeyDetails
updateKeyDetailsPUT /keys/{key}/detailsManagement KeyUpdate Details
keyUsageGET /keys/{key}/usageManagement KeyUsage Stats
keyLogsGET /keys/{key}/lookupsManagement KeyLogs (CSV)

Licensees​

FunctionEndpointAuthSummary
listLicenseesGET /keys/{key}/licenseesManagement KeyList
createLicenseePOST /keys/{key}/licenseesManagement KeyCreate
deleteLicenseeDELETE /keys/{key}/licensees/{licensee}Management KeyCancel
retrieveLicenseeGET /keys/{key}/licensees/{licensee}Management KeyRetrieve
updateLicenseePOST /keys/{key}/licensees/{licensee}Management KeyUpdate
regenerateLicenseeKeyPOST /keys/{key}/licensees/{licensee}/regenerate-keyManagement KeyRegenerate Key

Configs​

FunctionEndpointAuthSummary
listConfigsGET /keys/{key}/configsManagement KeyList
createConfigPOST /keys/{key}/configsManagement KeyCreate
deleteConfigDELETE /keys/{key}/configs/{config}Management KeyDelete
retrieveConfigGET /keys/{key}/configs/{config}Key in pathRetrieve
updateConfigPOST /keys/{key}/configs/{config}Management KeyUpdate

Emails​

FunctionEndpointAuthSummary
emailValidationGET /emailsAPI keyEmail Validation

Phone Numbers​

FunctionEndpointAuthSummary
phoneNumberValidationGET /phone_numbersAPI keyPhone Number Validation
FunctionEndpointAuthSummary
findPlaceGET /placesAPI keyFind Place
resolvePlaceGET /places/{place}API keyResolve Place