Enrichment
Submits an enrichment request to the service and returns enriched data for the given search keys and specified attributes.
post/enrichment/v2
Headers
Add-Metadataboolean
Specify whether the response should return all fields and values, in addition to the main core information.
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.
Request body
Example request
{
"keys": {
"global_address_key": "aWQ9fDEgQXVkcmV5IFphcHAgRHJpdmV8SHVkc29ufEplcnNleSBDaXR5LCBOSiAwNzMwNX5mb3JtYXRJZD0xMjM0NX5RTD05fmdlbz0w"
}
}Response
OK
Example response
{
"transaction_id": "ab123ab1-abc1-1234-abcd-ab1a123a1a12",
"error": {
"title": "Bad Request",
"detail": "The request body was malformed."
},
"result": {
"geocodes": {
"latitude": 52.9413,
"longitude": 1.16312,
"match_level": "Premises"
},
"usa_regional_geocodes": {
"latitude": 33.693283,
"longitude": -117.87428,
"match_level": "Street",
"census_tract": "050210",
"census_block": "2025",
"core_based_statistical_area": "12060",
"congressional_district_code": "1307116",
"county_code": "135"
},
"aus_regional_geocodes": {
"latitude": -31.067406,
"longitude": 152.83315,
"match_level": "building",
"sa1": "1115514",
"meshblock": "10402970000",
"lga_code": "14350",
"lga_name": "Kempsey (A)",
"street_pid": "NSW2838126",
"locality_pid": "NSW4281",
"geocode_level_code": "7",
"geocode_level_description": "Locality, street and parcel level geocodes",
"geocode_type_code": "PC",
"geocode_type_description": "Property centroid",
"highest_level_longitude": 152.83315,
"highest_level_latitude": -31.067406,
"highest_level_geocode_reliability_code": "2",
"highest_level_geocode_reliability_description": "Geocode accuracy sufficient to place centroid within address site boundary",
"confidence_level_code": "2",
"confidence_level_description": "All three contributors have supplied an identical address",
"2021_meshblock_id": "MB2110402970000",
"2021_meshblock_code": "10402970000",
"2021_meshblock_match_code": "1",
"2021_meshblock_match_description": "Parcel level match",
"2016_meshblock_id": "MB1610402970000",
"2016_meshblock_code": "10402970000",
"2016_meshblock_match_code": "1",
"2016_meshblock_match_description": "Parcel level match",
"collector_district_id": "NSW1081403",
"collector_district_code": "1081403",
"commonwealth_electoral_boundary_id": "NSW32",
"commonwealth_electoral_boundary_name": "COWPER",
"statistical_local_area_id": "NSW125104350",
"statistical_local_area_code": "125104350",
"statistical_local_area_name": "KEMPSEY (A)",
"state_electoral_boundary_id": "NSW231",
"state_electoral_boundary_name": "OXLEY",
"state_electoral_effective_start": "24/03/2007 00:00:00",
"state_electoral_effective_end": "28/03/2015 00:00:00",
"state_electoral_new_pid": "NSW242",
"state_electoral_new_name": "OXLEY",
"state_electoral_new_effective_start": "28/03/2015 00:00:00",
"address_level_longitude": 152.83315,
"address_level_latitude": -31.067406,
"address_level_geocode_reliability_code": "2",
"address_level_geocode_reliability_description": "Geocode accuracy sufficient to place centroid within address site boundary",
"street_level_longitude": 152.8311,
"street_level_latitude": -31.062723,
"street_level_boundary_extent": "651",
"street_level_geocode_reliability_code": "4",
"street_level_geocode_reliability_description": "Geocode accuracy sufficient to associate address site with a unique road feature",
"locality_level_longitude": 152.82999,
"locality_level_latitude": -31.059824,
"locality_level_geocode_reliability_code": "5",
"locality_level_geocode_reliability_description": "Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood",
"gnaf_legal_parcel_identifier": "B/366584",
"locality_class_code": "G"
},
"nzl_regional_geocodes": {
"front_of_property_nztm_x_coordinate": 1757352.8,
"front_of_property_nztm_y_coordinate": 5920390.5,
"centroid_of_property_nztm_x_coordinate": 1757328.4,
"centroid_of_property_nztm_y_coordinate": 5920400,
"linz_parcel_id": "5047052",
"property_purpose_type": "Business",
"addressable": "N",
"mesh_block_code": "434000",
"territorial_authority_code": "76",
"territorial_authority_name": "Auckland",
"regional_council_code": "2",
"regional_council_name": "Auckland Region",
"general_electorate_code": "001",
"general_electorate_name": "Auckland Central",
"maori_electorate_code": "3",
"maori_electorate_name": "Tamaki Makaurau",
"front_of_property_latitude": -36.849308,
"front_of_property_longitude": 174.76492,
"centroid_of_property_latitude": -36.849228,
"centroid_of_property_longitude": 174.76465,
"match_level": "Building"
},
"uk_location_complete": {
"latitude": 51.50112,
"longitude": -0.1041234,
"match_level": "Building",
"udprn": "55244256",
"uprn": "010091977422",
"x_coordinate": 531677.94,
"y_coordinate": 179757.6
},
"uk_location_essential": {
"latitude": 51.50112,
"longitude": -0.1041234,
"match_level": "Building",
"udprn": "55244256",
"uprn": "010091977422",
"x_coordinate": 531677.94,
"y_coordinate": 179757.6
},
"gbr_government": {
"eer_code": "E15000007",
"eer_code_pre_2011": "07",
"eer_name": "London",
"gor_code": "E12000007",
"gor_code_pre_2011": "H",
"gor_name": "London",
"lea_code": "210",
"lea_name": "Southwark",
"la_code": "E09000028",
"la_code_pre_2011": "00BE",
"la_name": "Southwark",
"ward_code": "E05011095",
"ward_code_pre_2011": "00AXGN",
"ward_name": "Borough & Bankside",
"cens_out_area": "E00019790"
},
"gbr_health": {
"authority_code": "Q36",
"authority_code_2011": "E18000007",
"authority_name": "London",
"pclh_code": "5LE",
"pclh_code_2011": "E16000059",
"pclh_name": "Southwark",
"ward_code": "E05011095",
"ward_code_2011": "E05011095",
"ward_name": "Borough & Bankside",
"ccg_code": "E38000244",
"ccg_name": "NHS South East London CCG",
"doh_code": "72Q"
},
"premium_location_insight": {
"geocodes": {
"latitude": 52.9413,
"longitude": 1.16312,
"match_level": "Building"
},
"geocodes_building_xy": {
"x_coordinate": 152718.84,
"y_coordinate": 529726.56
},
"geocodes_access": [
{
"latitude": 52.9413,
"longitude": 1.16312
}
],
"time": [
{
"time_zone_id": "Africa/Cairo",
"generic": "Eastern European Time",
"standard": "Eastern European Standard Time",
"daylight": "Eastern European Summer Time",
"reference_time": {
"tag": "EET",
"standard_offset": "02:00:00",
"daylight_savings": "00:00:00",
"sunrise": "2023-04-07T03:38:08.767292+00:00",
"sunset": "2023-04-07T16:16:40.8507771+00:00"
},
"time_transition": [
{
"tag": "EET",
"standard_offset": "02:00:00",
"daylight_savings": "00:00:00",
"utc_start": "2014-09-25T21:00:00Z",
"utc_end": "2023-04-27T22:00:00Z"
}
]
}
]
},
"what3words": {
"latitude": 51.75117,
"longitude": -1.24623,
"name": "pretty.needed.chill",
"description": "near Oxford, Oxfordshire"
}
},
"metadata": {
"code": "S200",
"message": "Success",
"detail": "All requested attribute(s) retrieved.",
"datasets": {
"geocodes": {
"latitude": {
"code": "S200",
"message": "Match"
},
"longitude": {
"code": "S200",
"message": "Match"
},
"match_level": {
"code": "S200",
"message": "Match"
}
},
"usa_regional_geocodes": {
"latitude": {
"code": "S200",
"message": "Match"
},
"longitude": {
"code": "S200",
"message": "Match"
},
"match_level": {
"code": "S200",
"message": "Match"
},
"census_tract": {
"code": "S200",
"message": "Match"
},
"census_block": {
"code": "S200",
"message": "Match"
},
"core_based_statistical_area": {
"code": "S200",
"message": "Match"
},
"congressional_district_code": {
"code": "S200",
"message": "Match"
},
"county_code": {
"code": "S200",
"message": "Match"
}
},
"aus_regional_geocodes": {
"latitude": {
"code": "S200",
"message": "Match"
},
"longitude": {
"code": "S200",
"message": "Match"
},
"match_level": {
"code": "S200",
"message": "Match"
},
"sa1": {
"code": "S200",
"message": "Match"
},
"meshblock": {
"code": "S200",
"message": "Match"
},
"lga_code": {
"code": "S200",
"message": "Match"
},
"lga_name": {
"code": "S200",
"message": "Match"
},
"street_pid": {
"code": "S200",
"message": "Match"
},
"locality_pid": {
"code": "S200",
"message": "Match"
},
"geocode_level_code": {
"code": "S200",
"message": "Match"
},
"geocode_level_description": {
"code": "S200",
"message": "Match"
},
"geocode_type_code": {
"code": "S200",
"message": "Match"
},
"geocode_type_description": {
"code": "S200",
"message": "Match"
},
"highest_level_longitude": {
"code": "S200",
"message": "Match"
},
"highest_level_latitude": {
"code": "S200",
"message": "Match"
},
"highest_level_elevation": {
"code": "S200",
"message": "Match"
},
"highest_level_planimetric_accuracy": {
"code": "S200",
"message": "Match"
},
"highest_level_boundary_extent": {
"code": "S200",
"message": "Match"
},
"highest_level_geocode_reliability_code": {
"code": "S200",
"message": "Match"
},
"highest_level_geocode_reliability_description": {
"code": "S200",
"message": "Match"
},
"confidence_level_code": {
"code": "S200",
"message": "Match"
},
"confidence_level_description": {
"code": "S200",
"message": "Match"
},
"2021_meshblock_id": {
"code": "S200",
"message": "Match"
},
"2021_meshblock_code": {
"code": "S200",
"message": "Match"
},
"2021_meshblock_match_code": {
"code": "S200",
"message": "Match"
},
"2021_meshblock_match_description": {
"code": "S200",
"message": "Match"
},
"2016_meshblock_id": {
"code": "S200",
"message": "Match"
},
"2016_meshblock_code": {
"code": "S200",
"message": "Match"
},
"2016_meshblock_match_code": {
"code": "S200",
"message": "Match"
},
"2016_meshblock_match_description": {
"code": "S200",
"message": "Match"
},
"address_type_code": {
"code": "S200",
"message": "Match"
},
"primary_address_pid": {
"code": "S200",
"message": "Match"
},
"address_join_type": {
"code": "S200",
"message": "Match"
},
"collector_district_id": {
"code": "S200",
"message": "Match"
},
"collector_district_code": {
"code": "S200",
"message": "Match"
},
"commonwealth_electoral_boundary_id": {
"code": "S200",
"message": "Match"
},
"commonwealth_electoral_boundary_name": {
"code": "S200",
"message": "Match"
},
"statistical_local_area_id": {
"code": "S200",
"message": "Match"
},
"statistical_local_area_code": {
"code": "S200",
"message": "Match"
},
"statistical_local_area_name": {
"code": "S200",
"message": "Match"
},
"state_electoral_boundary_id": {
"code": "S200",
"message": "Match"
},
"state_electoral_boundary_name": {
"code": "S200",
"message": "Match"
},
"state_electoral_effective_start": {
"code": "S200",
"message": "Match"
},
"state_electoral_effective_end": {
"code": "S200",
"message": "Match"
},
"state_electoral_new_pid": {
"code": "S200",
"message": "Match"
},
"state_electoral_new_name": {
"code": "S200",
"message": "Match"
},
"state_electoral_new_effective_start": {
"code": "S200",
"message": "Match"
},
"state_electoral_new_effective_end": {
"code": "S200",
"message": "Match"
},
"address_level_longitude": {
"code": "S200",
"message": "Match"
},
"address_level_latitude": {
"code": "S200",
"message": "Match"
},
"address_level_elevation": {
"code": "S200",
"message": "Match"
},
"address_level_planimetric_accuracy": {
"code": "S200",
"message": "Match"
},
"address_level_boundary_extent": {
"code": "S200",
"message": "Match"
},
"address_level_geocode_reliability_code": {
"code": "S200",
"message": "Match"
},
"address_level_geocode_reliability_description": {
"code": "S200",
"message": "Match"
},
"street_level_longitude": {
"code": "S200",
"message": "Match"
},
"street_level_latitude": {
"code": "S200",
"message": "Match"
},
"street_level_planimetric_accuracy": {
"code": "S200",
"message": "Match"
},
"street_level_boundary_extent": {
"code": "S200",
"message": "Match"
},
"street_level_geocode_reliability_code": {
"code": "S200",
"message": "Match"
},
"street_level_geocode_reliability_description": {
"code": "S200",
"message": "Match"
},
"locality_level_longitude": {
"code": "S200",
"message": "Match"
},
"locality_level_latitude": {
"code": "S200",
"message": "Match"
},
"locality_level_planimetric_accuracy": {
"code": "S200",
"message": "Match"
},
"locality_level_geocode_reliability_code": {
"code": "S200",
"message": "Match"
},
"locality_level_geocode_reliability_description": {
"code": "S200",
"message": "Match"
},
"gnaf_legal_parcel_identifier": {
"code": "S200",
"message": "Match"
},
"locality_class_code": {
"code": "S200",
"message": "Match"
}
},
"nzl_regional_geocodes": {
"front_of_property_nztm_x_coordinate": {
"code": "S200",
"message": "Match"
},
"front_of_property_nztm_y_coordinate": {
"code": "S200",
"message": "Match"
},
"centroid_of_property_nztm_x_coordinate": {
"code": "S200",
"message": "Match"
},
"centroid_of_property_nztm_y_coordinate": {
"code": "S200",
"message": "Match"
},
"linz_parcel_id": {
"code": "S200",
"message": "Match"
},
"property_purpose_type": {
"code": "S200",
"message": "Match"
},
"addressable": {
"code": "S200",
"message": "Match"
},
"mesh_block_code": {
"code": "S200",
"message": "Match"
},
"territorial_authority_code": {
"code": "S200",
"message": "Match"
},
"territorial_authority_name": {
"code": "S200",
"message": "Match"
},
"regional_council_code": {
"code": "S200",
"message": "Match"
},
"regional_council_name": {
"code": "S200",
"message": "Match"
},
"general_electorate_code": {
"code": "S200",
"message": "Match"
},
"general_electorate_name": {
"code": "S200",
"message": "Match"
},
"maori_electorate_code": {
"code": "S200",
"message": "Match"
},
"maori_electorate_name": {
"code": "S200",
"message": "Match"
},
"front_of_property_latitude": {
"code": "S200",
"message": "Match"
},
"front_of_property_longitude": {
"code": "S200",
"message": "Match"
},
"centroid_of_property_latitude": {
"code": "S200",
"message": "Match"
},
"centroid_of_property_longitude": {
"code": "S200",
"message": "Match"
},
"match_level": {
"code": "S200",
"message": "Match"
}
},
"uk_location_complete": {
"latitude": {
"code": "S200",
"message": "Match"
},
"longitude": {
"code": "S200",
"message": "Match"
},
"match_level": {
"code": "S200",
"message": "Match"
},
"udprn": {
"code": "S200",
"message": "Match"
},
"uprn": {
"code": "S200",
"message": "Match"
},
"x_coordinate": {
"code": "S200",
"message": "Match"
},
"y_coordinate": {
"code": "S200",
"message": "Match"
}
},
"uk_location_essential": {
"latitude": {
"code": "S200",
"message": "Match"
},
"longitude": {
"code": "S200",
"message": "Match"
},
"match_level": {
"code": "S200",
"message": "Match"
},
"udprn": {
"code": "S200",
"message": "Match"
},
"uprn": {
"code": "S200",
"message": "Match"
},
"x_coordinate": {
"code": "S200",
"message": "Match"
},
"y_coordinate": {
"code": "S200",
"message": "Match"
}
},
"gbr_government": {
"eer_code": {
"code": "S200",
"message": "Match"
},
"eer_code_pre_2011": {
"code": "S200",
"message": "Match"
},
"eer_name": {
"code": "S200",
"message": "Match"
},
"gor_code": {
"code": "S200",
"message": "Match"
},
"gor_code_pre_2011": {
"code": "S200",
"message": "Match"
},
"gor_name": {
"code": "S200",
"message": "Match"
},
"lea_code": {
"code": "S200",
"message": "Match"
},
"lea_name": {
"code": "S200",
"message": "Match"
},
"la_code": {
"code": "S200",
"message": "Match"
},
"la_code_pre_2011": {
"code": "S200",
"message": "Match"
},
"la_name": {
"code": "S200",
"message": "Match"
},
"ward_code": {
"code": "S200",
"message": "Match"
},
"ward_code_pre_2011": {
"code": "S200",
"message": "Match"
},
"ward_name": {
"code": "S200",
"message": "Match"
},
"cens_out_area": {
"code": "S200",
"message": "Match"
}
},
"gbr_health": {
"authority_code": {
"code": "S200",
"message": "Match"
},
"authority_code_2011": {
"code": "S200",
"message": "Match"
},
"authority_name": {
"code": "S200",
"message": "Match"
},
"pclh_code": {
"code": "S200",
"message": "Match"
},
"pclh_code_2011": {
"code": "S200",
"message": "Match"
},
"pclh_name": {
"code": "S200",
"message": "Match"
},
"ward_code": {
"code": "S200",
"message": "Match"
},
"ward_code_2011": {
"code": "S200",
"message": "Match"
},
"ward_name": {
"code": "S200",
"message": "Match"
},
"ccg_code": {
"code": "S200",
"message": "Match"
},
"ccg_name": {
"code": "S200",
"message": "Match"
},
"doh_code": {
"code": "S200",
"message": "Match"
}
},
"premium_location_insight": {
"geocodes": {
"code": "S200",
"message": "Match"
},
"geocodes_building_xy": {
"code": "S200",
"message": "Match"
},
"geocodes_access": {
"code": "S200",
"message": "Match"
},
"time": {
"code": "S200",
"message": "Match"
}
},
"what3words": {
"latitude": {
"code": "S200",
"message": "Match"
},
"longitude": {
"code": "S200",
"message": "Match"
},
"name": {
"code": "S200",
"message": "Match"
},
"description": {
"code": "S200",
"message": "Match"
}
}
}
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.