Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Ideal Postcodes

Ideal Postcodes is a UK address lookup and postcode validation API.

Base URL: https://api.ideal-postcodes.co.uk/v1
Auth: bearer (pass your key via the apiKey input)

Operations

addresses — GET /addresses — Extract Addresses
addressautocomplete — GET /autocomplete/addresses — Find Address
resolve — GET /autocomplete/addresses/{address}/gbr — Resolve Address (GBR)
resolveusa — GET /autocomplete/addresses/{address}/usa — Resolve Address (USA)
emailvalidation — GET /emails — Email Validation
keyavailability — GET /keys/{key} — Availability

Inputs

apiKey — your ideal-postcodes API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: addresses
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: addresses, addressautocomplete, resolve, resolveusa, emailvalidation, keyavailability
`address`	string	no	—	Path parameter address (required by some operations).
`key`	string	no	—	Path parameter key (required by some operations).
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.