Bulk Address
Gets the validation result of a batch of address.
Changed onget/address/bulk/v1/batches/{batch_id}/results
Request
- Base URLhttps://api.experianaperture.io
- Auth
- HTTP bearer
- or API key in header Auth-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
batch_idstring required
Batch ID.
Headers
Reference-Idstring
Optional identifier that will be returned in the response to help you track the request.
Response
OK
Example response
{
"error": {
"title": "Bad Request",
"detail": "The request body was malformed."
},
"result": {
"statistics": [
{
"name": "verified",
"value": 10
}
],
"addresses": [
{
"address": "555 Ellis St | Mountain View | CA | 94043",
"country_iso": "DEU",
"datasets": [
"de-address-ed"
],
"confidence": "verified match",
"match_type": "full_with_post_code",
"match_confidence": "high",
"addresses_formatted": [
{
"layout_name": "myLayout",
"address": {
"CountryIso": "DEU",
"CountryName": "",
"PostalCode": "75245",
"Locality": "Neulingen",
"Street": "Am Sickenbrünnle",
"Building": ""
}
}
],
"components": {
"language": "en-GB",
"country_name": "United Kingdom",
"country_iso_3": "GBR",
"country_iso_2": "GB",
"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"
}
},
"metadata": {
"address_info": {
"number_of_households": "1",
"just_built_date": "20210605",
"identifier": {
"udprn": "12353232",
"umrrn": "50101642",
"dpid": "62147712",
"gnafpid": "GAVIC424477161",
"hin": "203060068",
"paf_address_key": "2304084100000000S"
}
},
"route_classification": {
"carrier_route": "C077",
"id": "38396"
},
"barcode": {
"delivery_point_barcode": "02139430177",
"check_digit": "3",
"sort_plan_number": "022"
},
"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",
"drop": "Y",
"throwback": "Y",
"non_delivery_days_indicator": "Y",
"no_secure_location": "Y",
"door_not_accessible": "Y",
"enhanced_dpv_code": "Y"
}
}
}
]
}
}Changes
- info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status - info
added the optional property
/////to the response with the status
- info