/
Postcode lookup in the United Kingdom

Postcode lookup in the United Kingdom

BRP integrates with Ideal Postcodes to provide autocomplete for UK Postal Addresses in

  • BRP Cloud (for example on the person card, point of sale and all other places where you can enter an address)

  • BRP Go Active! web

  • BRP Go Active! app (GA2)

Settings:

Setting name

Type

Default

Purpose

idealPostcodesApiKey

Encrypted string

none

API key for Ideal postcodes

idealPostcodesUrl

String

https://api.ideal-postcodes.co.uk/v1/

Base URL for Ideal postcodes

useUkPostcodeLookup

boolean

false

To enable the feature

Your Ideal Postcodes account must be loaded with prepaid credits.

Search conditions:

  1. Min 3 characters: Search starts after the user enters 3 characters.

  2. 300ms debounce time: As long as the user keeps typing a search call is not made. Once the user stops for a period of 300ms, a search call is done.

  3. Searches are cached.

 

‘Care of’ needs to be filled in manually by the user (if applicable).

 

Examples

On the person card

image-20260505-133326.png

When there is an issue with the service (due to API credits depleted, service down, etc)

image-20260505-133540.png

Advanced person wizard

image-20260505-133625.png

 

Ideal Postcodes API conditions

  1. A maximum of 30 search requests can be made in 1 minute.

  2. ‘Care of’ needs to be filled in manually by the user (if applicable).