Multiple Residence

info

For more information on the Multiple Residence dataset, please refer to our comprehensive guide on this topic: Read More.

The Multiple Residence address format is identical to the Postcode Address File format. Two fields set it apart.

dataset string

Dataset

Indicates the provenance of an address.

Example mr

Enum

• "mr"

umprn string | number

UMPRN

A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant.

Note: this will be an empty string "" when not used.

Example 50906058

Native Record

native object

Native Record

The raw dataset record backing an address, exactly as the dataset supplies it. One schema per dataset; dataset on the record says which.

Raw Royal Mail Multiple Residence record backing an mr address.

Multiple Residence holds sub-premises (flats, rooms) that share a parent PAF delivery point. umprn keys the residence, udprn the parent delivery point. The record has no po_box.

Fields shared by every Royal Mail PAF family native record (paf, mr, nyb, pafa, pafw).

The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, premise, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. dataset is the one field not taken from Royal Mail.

Two values differ from the raw PAF file: post_town is title cased (Royal Mail supplies it upper cased), and a building_number of 0, PAF's sentinel for "none", is returned as an empty string.

Example Record

Field	Example	Type
dataset	mr	string
postcode	SW1A 2AA	string
post_town	London	string
dependant_locality	Empty in this example	string
double_dependant_locality	Empty in this example	string
thoroughfare	Downing Street	string
dependant_thoroughfare	Empty in this example	string
building_number	10	string
building_name	Empty in this example	string
sub_building_name	Flat 1	string
department_name	Empty in this example	string
organisation_name	Empty in this example	string
udprn	23747771	number
postcode_type	S	string
su_organisation_indicator	Empty in this example	string
delivery_point_suffix	1A	string
umprn	50906058	number

Every field is documented below.

dataset string

Example mr

Enum

• "mr"

postcode string

Postcode, space separated

Example SW1A 2AA

post_town string

Royal Mail post town, title cased

Example London

dependant_locality string

Dependant locality. Empty string when not present

Example Empty in this example

double_dependant_locality string

Double dependant locality. Empty string when not present

Example Empty in this example

thoroughfare string

Street name

Example Downing Street

dependant_thoroughfare string

Dependant street name. Empty string when not present

Example Empty in this example

building_number string

Building number. Empty string when not present, or when PAF merges it into the building name

Example 10

building_name string

Building name. Empty string when not present

Example Empty in this example

sub_building_name string

Sub building name. Empty string when not present

Example Flat 1

department_name string

Department name within an organisation. Empty string when not present

Example Empty in this example

organisation_name string

Organisation name. Empty string when not present

Example Empty in this example

udprn integer

Unique Delivery Point Reference Number

Example 23747771

postcode_type string

Postcode type.

• S Small user
• L Large user
• "" where Royal Mail supplies none

Example S

Enum

• "S"
• "L"
• ""

su_organisation_indicator string

Small user organisation indicator. Y where the small user postcode is held by an organisation

Example Empty in this example

delivery_point_suffix string

Royal Mail delivery point suffix

Example 1A

umprn integer

Unique Multiple Residence Reference Number

Example 50906058