Postcode API


Retrieve basic account information for the currently authenticated account. You may use this to determine the capabilities of a configured account.

URL template

The REST API requires GET requests. Parameters are added to the REST resource URL, and each parameter must be URL-encoded:


name: string

The name of the account. Maximum length 150 characters.

hasAccess: boolean

Indicates if the account currently has access to API's.

countries: string[]

The countries to which the account has access, in ISO 3166-1 alpha-3 format.