Options
All
  • Public
  • Public/Protected
  • All
Menu

Standard Address object returned by the API that represents a single premise on Royal Mail's Postcode Address File.

See ideal-postcodes.co.uk/documentation/paf-data for a glossary of PAF premise data attributes.

Take note of:

  • Numbers have type AddressNumber. This means in the event they are not populated, they return empty string (instead of null)
  • String fields which are not populated (i.e. have no value) return empty string ""
  • API Keys with Multiple Residence enabled may also return a umprn attribute

Hierarchy

Index

Properties

administrative_county

administrative_county: string

building_name

building_name: string

building_number

building_number: string

country

country: string

county

county: string

delivery_point_suffix

delivery_point_suffix: string

department_name

department_name: string

dependant_locality

dependant_locality: string

dependant_thoroughfare

dependant_thoroughfare: string

district

district: string

double_dependant_locality

double_dependant_locality: string

eastings

eastings: AddressNumber

latitude

latitude: AddressNumber

line_1

line_1: string

line_2

line_2: string

line_3

line_3: string

longitude

longitude: AddressNumber

northings

northings: AddressNumber

organisation_name

organisation_name: string

po_box

po_box: string

post_town

post_town: string

postal_county

postal_county: string

postcode

postcode: string

postcode_inward

postcode_inward: string

postcode_outward

postcode_outward: string

postcode_type

postcode_type: string

premise

premise: string

su_organisation_indicator

su_organisation_indicator: string

sub_building_name

sub_building_name: string

thoroughfare

thoroughfare: string

traditional_county

traditional_county: string

udprn

udprn: number

UDPRN

Unique ID provided to a premise in Royal Mail's Postcode Address File.

ideal-postcodes.co.uk/documentation/paf-data/#udprn_code

Optional umprn

ward

ward: string