UK Address Autocomplete
Options
All
  • Public
  • Public/Protected
  • All
Menu

Suggestion

An object which represents a single address suggestion returned by the Ideal Postcodes autocomplete API

Hierarchy

  • Suggestion

Index

Properties

Properties

suggestion

suggestion: string

Address suggestion to be presented to the user

example

"9 Lerwick Court, 9 Village Road, Enfield, EN1"

udprn

udprn: number

ID of the address found on PAF mainfile. Can be queried with /udprn/:id

Optional umprn

umprn: number

ID of the address found on Multile Residence File. Can be queried with /umprn/:id

urls

urls: object

Type declaration

  • udprn: string

    URL to resolve suggestion as Postcode Address File address

  • Optional umprn?: string

    URL to resolve suggestion as multiple residence address