Address details for United Kingdom

This page describes only country specific information for the address details response. See get address details documentation for an overview of the address details request and response in general.

United Kingdom address "details" property example

{
  "language": "en-GB",
  "address": {
		"country": "United Kingdom",
		"locality": "LONDON",
		"street": "Downing Street",
		"postcode": "SW1A 2AA",
		"building": "10",
		"buildingNumber": 10,
		"buildingNumberAddition": null
  },
  "mailLines": [
		"10 Downing Street",
		"SW1A 2AA LONDON"
  ],
  "location": null,
  "isPoBox": false,
  "country": {
		"name": "United Kingdom",
		"iso3Code": "GBR"
  },
  "details": {
		"gbrBuilding": {
			 "number": 10,
			 "addition": null,
			 "validated": true
		},
		"gbrStreet": {
			 "name": "Downing Street"
		},
		"gbrLocality": {
			 "name": "LONDON"
		}
  }
}

Response property "details" for country code "GBR"

gbrBuilding: struct

UK building details.

Hide child parameters
number: int or null

The number for the building.

addition: string or null

The number addition for the building if available, null otherwise.

validated: boolean

Indication whether the building could be validated. When true it means that the combination of building number and building number addition exists.

gbrStreet: struct

UK street details.

Hide child parameters
name: string or null

Name of the street

gbrLocality: struct

UK locality details.

Hide child parameters
name: string

Name of the locality.