Address Validation
Search and format a list of suggestions.
post/address/suggestions/format/v1
Headers
Reference-Idstring
Optional identifier that will be returned in the response to help you track the request.
Timeout-Secondsinteger
Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.
Add-Componentsboolean
Specifies if the response should contain the address broken down into its components.
Add-Metadataboolean
Specify whether the response should return all fields and values, in addition to the main core information.
Request body
Example request
{
"country_iso": "AUS",
"datasets": [
"au-address"
],
"max_suggestions": 10,
"components": {
"unspecified": [
"1 Main Street"
],
"names": [
"1 Main Street"
]
},
"layouts": [
"default"
]
}Response
OK
Example response
{
"error": {
"title": "Bad Request",
"detail": "The request body was malformed."
},
"result": {
"confidence": "Multiple matches",
"suggestions": [
{
"address": {
"address_line_1": "1 Main Street",
"locality": "MELBOURNE",
"region": "VIC",
"postal_code": "3004",
"country": "AUSTRALIA"
},
"addresses_formatted": [
{
"layout_name": "QADefault",
"address": {
"AmexStreet": "1 Main St",
"AmexTown": "Surbiton",
"AmexCountry": "United Kingdom",
"gas_meters": [
{
"mprn": "52902306"
},
{
"mprn": "52902307"
}
]
}
}
],
"components": {
"language": "en-GB",
"country_name": "United Kingdom",
"country_iso_3": "GBR",
"country_iso_2": "GB",
"country_iso_numeric": "780",
"postal_code": {
"full_name": "92626-7037",
"primary": "92626",
"secondary": "7037"
},
"sub_building": {
"entrance": {
"full_name": "L 6",
"type": "L",
"value": "6"
},
"floor": {
"full_name": "L 6",
"type": "L",
"value": "6"
},
"door": {
"full_name": "L 6",
"type": "L",
"value": "6"
}
},
"building": {
"building_name": "Sir John Peace Building",
"building_number": "549"
},
"street": {
"full_name": "Summer St",
"name": "Summer",
"type": "St"
},
"secondary_street": {
"full_name": "Summer St",
"name": "Summer",
"type": "St"
},
"locality": {
"region": {
"name": "NOTTINGHAM"
},
"sub_region": {
"name": "NOTTINGHAM"
},
"town": {
"name": "NOTTINGHAM"
},
"district": {
"name": "NOTTINGHAM"
},
"sub_district": {
"name": "NOTTINGHAM"
}
},
"physical_locality": {
"region": {
"name": "NOTTINGHAM"
},
"sub_region": {
"name": "NOTTINGHAM"
},
"town": {
"name": "NOTTINGHAM"
},
"district": {
"name": "NOTTINGHAM"
},
"sub_district": {
"name": "NOTTINGHAM"
}
},
"additional_elements": {
"locality": {
"sub_region": {
"administrative_county": "North Yorkshire",
"former_postal_county": "North Yorkshire",
"traditional_county": "Yorkshire"
}
}
}
},
"metadata": {
"address_info": {
"number_of_households": "1",
"just_built_date": "20210605",
"identifier": {
"umrrn": "50101642",
"udprn": "12353232",
"uprn": "12353232",
"dpid": "62147712",
"gnafPid": "GAVIC424477161",
"paf_address_key": "2304084100000000S",
"hin": "203060068"
}
},
"barcode": {
"delivery_point_barcode": "02139430177",
"check_digit": "3",
"sort_plan_number": "022"
},
"route_classification": {
"carrier_route": "C077",
"id": "38396",
"elot": "0000A"
},
"address_classification": {
"address_type": {
"code": "S",
"description": "Street"
},
"delivery_type": "Business",
"is_deliverable": "Y"
},
"dpv": {
"cmra_indicator": "Y",
"seed_indicator": "Y",
"dpv_indicator": "Y",
"footnotes": [
"AA",
"BB"
],
"vacancy_indicator": "Y",
"no_stats_indicator": "Y",
"pbsa_indicator": "Y",
"lacs_indicator": "Y",
"lacs_code": "14"
}
}
}
]
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.