Fields

display : String! required

The human-legible address in a single string, excluding the postcode.
locality1 : String

Dependant locality e.g. 'Durham'.
locality2 : String

Double dependant locality e.g. 'Durham East'.
postcode : String! required

The postcode of the address.
primaryName : String

Primary Addressable Object description, normally the name or number of the property e.g. 'London House'.
secondaryName : String

Secondary Addressable Object description, e.g. 'Flat 2'. This is only relevant for a child property.
street1 : String

The thoroughfare e.g. 'Witton Grove'.
street2 : String

Dependant thoroughfare e.g. 'Witton Grove East'.
town : String

The town or city e.g. 'London'.
uprn : String! required

The Unique Property Reference Number assigned to the addressable location.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "display": "continue-in-road-anyone-between", "locality1": "nation-entire-blood-energy-place", "locality2": "money-bad-authority-sure-poor", "postcode": "community-technology-against-happy-summer", "primaryName": "report-exist-through-our-tend", "secondaryName": "throughout-international-put-name-war", "street1": "sometimes-rise-sport-your-either", "street2": "cut-section-show-method-main", "town": "identify-third-someone-once-always", "uprn": "surface-learn-couple-federal-reality" }