{ "openapi": "3.0.4", "info": { "title": "Enrichment", "version": "v2" }, "servers": [ { "url": "https://api.experianaperture.io/" } ], "paths": { "/enrichment/v2": { "post": { "tags": [ "Enrichment" ], "summary": "Submits an enrichment request to the service and returns enriched data for the given search keys and specified attributes.", "parameters": [ { "name": "Add-Metadata", "in": "header", "description": "Specify whether the response should return all fields and values, in addition to the main core information.", "schema": { "type": "boolean" } }, { "name": "Reference-Id", "in": "header", "description": "Optional identifier that will be returned in the response to help you track the request.", "schema": { "maxLength": 256, "minLength": 0, "pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$", "type": "string" } }, { "name": "Timeout-Seconds", "in": "header", "description": "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.", "schema": { "maximum": 15, "minimum": 2, "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichmentV2Request" }, "examples": { "GLO - Global Geocodes": { "value": {"country_iso":"USA","keys":{"global_address_key":"aWQ9NDc1IEFudG9uIEJsdmQsIENvc3RhIE1lc2EgQ0EgOTI2MjYsIFVuaXRlZCBTdGF0ZXMgT2YgQW1lcmljYX5hbHRfa2V5PXw0NzUgQW50b24gQmx2ZHx8Q29zdGEgTWVzYSxDQSw5MjYyNi03MDM3fmRhdGFzZXQ9VVNBX1BBRn5mb3JtYXRpZD02YzJkN2RkNC05YzEzLTQ3YWUtYWZiYi0yZWMyYjEyNGE2NDVfVTQwXzI0XzBfMF8wPTQ3NX5xbD0yM35nZW89MA"},"attributes":{"geocodes":["latitude","longitude","match_level"]}} }, "GLO - Premium Location Insight": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9MTAxIE1haW4gUm9hZCwgQ2xlZXZlLCBCcmlzdG9sLCBCUzQ5IDRQTiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0wMzA3MTAyM35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZWZmZjgxOC1mOTJlLTRmNmQtYWU3ZC0wNGJiNjdlZmFhNDUkJCR-UUw9MjE"},"attributes":{"premium_location_insight":["geocodes","geocodes_building_xy","geocodes_access","time"]}} }, "GLO - Premium Location Insight Lite": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9MTAxIE1haW4gUm9hZCwgQ2xlZXZlLCBCcmlzdG9sLCBCUzQ5IDRQTiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0wMzA3MTAyM35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZWZmZjgxOC1mOTJlLTRmNmQtYWU3ZC0wNGJiNjdlZmFhNDUkJCR-UUw9MjE"},"attributes":{"premium_location_insight":["geocodes","geocodes_building_xy","geocodes_access"]}} }, "AUS - Geocodes": { "value": {"country_iso":"AUS","keys":{"global_address_key":"aWQ9OCBDb2NocmFuZSBTdHJlZXQsIFdFU1QgS0VNUFNFWSAgTlNXIDI0NDAsIEF1c3RyYWxpYX5hbHRfa2V5PUdBTlNXNzA2MjY4NjE5fmRhdGFzZXQ9QVVTX0dOQUZ-Zm9ybWF0X2tleT1BVVMkR05BRiQ3NjJBVUctbk9BVUdIQUxsQndBQUFBQUlBZ0VBQUFBQUZ6UXl3QUFBQUFBQUFEZ0FBUC4uWkFBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFPQ0JEYjJOb2NtRnVaU0JUZEhKbFpYUXNJRmRGVTFRZ1MwVk5VRk5GV1NBZ1RsTlhJREkwTkRBQUFBQUFBQS0tJCQk"},"attributes":{"aus_regional_geocodes":["latitude","longitude","match_level","sa1","meshblock","lga_code","lga_name","street_pid","locality_pid","geocode_level_code","geocode_level_description","geocode_type_code","geocode_type_description","highest_level_longitude","highest_level_latitude","highest_level_elevation","highest_level_planimetric_accuracy","highest_level_boundary_extent","highest_level_geocode_reliability_code","highest_level_geocode_reliability_description","confidence_level_code","confidence_level_description","2021_meshblock_id","2021_meshblock_code","2021_meshblock_match_code","2021_meshblock_match_description","2016_meshblock_id","2016_meshblock_code","2016_meshblock_match_code","2016_meshblock_match_description","address_type_code","primary_address_pid","address_join_type","collector_district_id","collector_district_code","commonwealth_electoral_boundary_id","commonwealth_electoral_boundary_name","statistical_local_area_id","statistical_local_area_code","statistical_local_area_name","state_electoral_boundary_id","state_electoral_boundary_name","state_electoral_effective_start","state_electoral_effective_end","state_electoral_new_pid","state_electoral_new_name","state_electoral_new_effective_start","state_electoral_new_effective_end","address_level_longitude","address_level_latitude","address_level_elevation","address_level_planimetric_accuracy","address_level_boundary_extent","address_level_geocode_reliability_code","address_level_geocode_reliability_description","street_level_longitude","street_level_latitude","street_level_planimetric_accuracy","street_level_boundary_extent","street_level_geocode_reliability_code","street_level_geocode_reliability_description","locality_level_longitude","locality_level_latitude","locality_level_planimetric_accuracy","locality_level_geocode_reliability_code","locality_level_geocode_reliability_description","gnaf_legal_parcel_identifier","locality_class_code"]}} }, "GBR - Government": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xMjM1MzIzMX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0aWQ9YmY0NjM5NzItNmM2Yi00OGRiLTg0MTYtYzg5OGQ3YjA5MjFifnFsPTI0fmdlbz0w"},"attributes":{"gbr_government":["eer_code","eer_code_pre_2011","eer_name","gor_code","gor_code_pre_2011","gor_name","la_code","la_code_pre_2011","la_name","lea_code","lea_name","ward_code","ward_code_pre_2011","ward_name","cens_out_area"]}} }, "GBR - Health": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xMjM1MzIzMX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0aWQ9YmY0NjM5NzItNmM2Yi00OGRiLTg0MTYtYzg5OGQ3YjA5MjFifnFsPTI0fmdlbz0w"},"attributes":{"gbr_health":["authority_code","authority_code_2011","authority_name","pclh_code","pclh_code_2011","pclh_name","ward_code","ward_code_2011","ward_name","ccg_code","ccg_name","doh_code"]}} }, "GBR - Location Essential/Complete": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9RXhwZXJpYW4gRGF0YSBRdWFsaXR5LCBGcmlhcnMgSG91c2UsIDE2MCBCbGFja2ZyaWFycyBSb2FkLCBMb25kb24sIFNFMSAuLi4sIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTUyNDQyNTZ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJCQ5NzE4YzMyYS1iNmQzLTQ0NTgtOWQ1OS1hNWIzOTMyYjQzOTEkJCQ"},"attributes":{"uk_location_complete":["latitude","longitude","match_level","udprn","uprn","x_coordinate","y_coordinate"]}} }, "GBR - what3words": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRmY2U4YTQzMC0wZjMzLTQxZWYtOTRmNy05ZWVjOGJhOWU0NzYkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw"},"attributes":{"what3words":["latitude","longitude","name","description"]}} }, "NZL - Geocodes": { "value": {"country_iso":"NZL","keys":{"global_address_key":"aWQ9TGV2ZWwgOCBETEEgUGhpbGxpcHMgRm94IFRvd2VyIFRvd2VyIDEsIDIwNSBRdWVlbiBTdHJlZXQsIEF1Y2tsYW5kIENlbnRyYWwsIEF1Y2tsYW5kIDEwMTAsIE5ldyBaZWFsYW5kfmFsdF9rZXk9fmRhdGFzZXQ9TlpMX1BBRn5mb3JtYXRfa2V5PU5aTCQkNzYyTlpMLU5PTlpMSHd6a0J3QUFBQUFJQWdFQUFBQndlSTBBQWhBQVlBQUFBQUFCQUV4bGRtVnNJRGdnUkV4QklGQm9hV3hzYVhCeklFWnZlQ0JVYjNkbGNnQUFBUC4uU0FBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFUR1YyWld3Z09DQkVURUVnVUdocGJHeHBjSE1nUm05NElGUnZkMlZ5SUZSdmQyVnlJREVzSURJd05TQlJkV1ZsYmlCVGRISmxaWFFzSUVGMVkydHNZVzVrSUVObGJuUnlZV3dzSUVGMVkydHNZVzVrSURFd01UQUFBQUFBQUEtLSQkJA"},"attributes":{"nzl_regional_geocodes":["addressable","centroid_of_property_latitude","centroid_of_property_longitude","centroid_of_property_nztm_x_coordinate","centroid_of_property_nztm_y_coordinate","front_of_property_latitude","front_of_property_longitude","front_of_property_nztm_x_coordinate","front_of_property_nztm_y_coordinate","general_electorate_code","general_electorate_name","linz_parcel_id","maori_electorate_code","maori_electorate_name","match_level","mesh_block_code","property_purpose_type","regional_council_code","regional_council_name","territorial_authority_code","territorial_authority_name"]}} }, "USA - Geocodes": { "value": {"country_iso":"USA","keys":{"global_address_key":"aWQ9VXJiIExhIFBsYXRhLDEgQ2FsbGUgMSxDb21lcmlvLFBSLDAwNzgyLTI3MTd+YWx0X2tleT1VcmIgTGEgUGxhdGF8MSBDYWxsZSAxfHxDb21lcmlvLFBSLDAwNzgyLTI3MTd+Zm9ybWF0SWQ9YTM5NjU1ODctYmIyNS00NmFkLTlkNmMtY2E4MDQ4YmQ0NGY2flFMPTl+Z2VvPTA="},"attributes":{"usa_regional_geocodes":["latitude","longitude","match_level","census_tract","census_block","core_based_statistical_area","congressional_district_code","county_code"]}} } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EnrichmentV2Request" }, "examples": { "GLO - Global Geocodes": { "value": "\n USA\n \n aWQ9NDc1IEFudG9uIEJsdmQsIENvc3RhIE1lc2EgQ0EgOTI2MjYsIFVuaXRlZCBTdGF0ZXMgT2YgQW1lcmljYX5hbHRfa2V5PXw0NzUgQW50b24gQmx2ZHx8Q29zdGEgTWVzYSxDQSw5MjYyNi03MDM3fmRhdGFzZXQ9VVNBX1BBRn5mb3JtYXRpZD02YzJkN2RkNC05YzEzLTQ3YWUtYWZiYi0yZWMyYjEyNGE2NDVfVTQwXzI0XzBfMF8wPTQ3NX5xbD0yM35nZW89MA\n \n \n \n latitude\n longitude\n match_level\n \n \n" }, "GLO - Premium Location Insight": { "value": "\n GBR\n \n aWQ9MTAxIE1haW4gUm9hZCwgQ2xlZXZlLCBCcmlzdG9sLCBCUzQ5IDRQTiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0wMzA3MTAyM35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZWZmZjgxOC1mOTJlLTRmNmQtYWU3ZC0wNGJiNjdlZmFhNDUkJCR-UUw9MjE\n \n \n \n geocodes\n geocodes_building_xy\n geocodes_access\n time\n \n \n" }, "GLO - Premium Location Insight Lite": { "value": "\n GBR\n \n aWQ9MTAxIE1haW4gUm9hZCwgQ2xlZXZlLCBCcmlzdG9sLCBCUzQ5IDRQTiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0wMzA3MTAyM35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZWZmZjgxOC1mOTJlLTRmNmQtYWU3ZC0wNGJiNjdlZmFhNDUkJCR-UUw9MjE\n \n \n \n geocodes\n geocodes_building_xy\n geocodes_access\n \n \n" }, "AUS - Geocodes": { "value": "\n AUS\n \n aWQ9OCBDb2NocmFuZSBTdHJlZXQsIFdFU1QgS0VNUFNFWSAgTlNXIDI0NDAsIEF1c3RyYWxpYX5hbHRfa2V5PUdBTlNXNzA2MjY4NjE5fmRhdGFzZXQ9QVVTX0dOQUZ-Zm9ybWF0X2tleT1BVVMkR05BRiQ3NjJBVUctbk9BVUdIQUxsQndBQUFBQUlBZ0VBQUFBQUZ6UXl3QUFBQUFBQUFEZ0FBUC4uWkFBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFPQ0JEYjJOb2NtRnVaU0JUZEhKbFpYUXNJRmRGVTFRZ1MwVk5VRk5GV1NBZ1RsTlhJREkwTkRBQUFBQUFBQS0tJCQk\n \n \n \n latitude\n longitude\n match_level\n sa1\n meshblock\n lga_code\n lga_name\n street_pid\n locality_pid\n geocode_level_code\n geocode_level_description\n geocode_type_code\n geocode_type_description\n highest_level_longitude\n highest_level_latitude\n highest_level_elevation\n highest_level_planimetric_accuracy\n highest_level_boundary_extent\n highest_level_geocode_reliability_code\n highest_level_geocode_reliability_description\n confidence_level_code\n confidence_level_description\n 2021_meshblock_id\n 2021_meshblock_code\n 2021_meshblock_match_code\n 2021_meshblock_match_description\n 2016_meshblock_id\n 2016_meshblock_code\n 2016_meshblock_match_code\n 2016_meshblock_match_description\n address_type_code\n primary_address_pid\n address_join_type\n collector_district_id\n collector_district_code\n commonwealth_electoral_boundary_id\n commonwealth_electoral_boundary_name\n statistical_local_area_id\n statistical_local_area_code\n statistical_local_area_name\n state_electoral_boundary_id\n state_electoral_boundary_name\n state_electoral_effective_start\n state_electoral_effective_end\n state_electoral_new_pid\n state_electoral_new_name\n state_electoral_new_effective_start\n state_electoral_new_effective_end\n address_level_longitude\n address_level_latitude\n address_level_elevation\n address_level_planimetric_accuracy\n address_level_boundary_extent\n address_level_geocode_reliability_code\n address_level_geocode_reliability_description\n street_level_longitude\n street_level_latitude\n street_level_planimetric_accuracy\n street_level_boundary_extent\n street_level_geocode_reliability_code\n street_level_geocode_reliability_description\n locality_level_longitude\n locality_level_latitude\n locality_level_planimetric_accuracy\n locality_level_geocode_reliability_code\n locality_level_geocode_reliability_description\n gnaf_legal_parcel_identifier\n locality_class_code\n \n \n" }, "GBR - Government": { "value": "\n GBR\n \n aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xMjM1MzIzMX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0aWQ9YmY0NjM5NzItNmM2Yi00OGRiLTg0MTYtYzg5OGQ3YjA5MjFifnFsPTI0fmdlbz0w\n \n \n \n eer_code\n eer_code_pre_2011\n eer_name\n gor_code\n gor_code_pre_2011\n gor_name\n la_code\n la_code_pre_2011\n la_name\n lea_code\n lea_name\n ward_code\n ward_code_pre_2011\n ward_name\n cens_out_area\n \n \n" }, "GBR - Health": { "value": "\n GBR\n \n aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xMjM1MzIzMX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0aWQ9YmY0NjM5NzItNmM2Yi00OGRiLTg0MTYtYzg5OGQ3YjA5MjFifnFsPTI0fmdlbz0w\n \n \n \n authority_code\n authority_code_2011\n authority_name\n pclh_code\n pclh_code_2011\n pclh_name\n ward_code\n ward_code_2011\n ward_name\n ccg_code\n ccg_name\n doh_code\n \n \n" }, "GBR - Location Essential/Complete": { "value": "\n GBR\n \n aWQ9RXhwZXJpYW4gRGF0YSBRdWFsaXR5LCBGcmlhcnMgSG91c2UsIDE2MCBCbGFja2ZyaWFycyBSb2FkLCBMb25kb24sIFNFMSAuLi4sIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTUyNDQyNTZ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJCQ5NzE4YzMyYS1iNmQzLTQ0NTgtOWQ1OS1hNWIzOTMyYjQzOTEkJCQ\n \n \n \n latitude\n longitude\n match_level\n udprn\n uprn\n x_coordinate\n y_coordinate\n \n \n" }, "GBR - what3words": { "value": "\n GBR\n \n aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRmY2U4YTQzMC0wZjMzLTQxZWYtOTRmNy05ZWVjOGJhOWU0NzYkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw\n \n \n \n latitude\n longitude\n name\n description\n \n \n" }, "NZL - Geocodes": { "value": "\n NZL\n \n aWQ9TGV2ZWwgOCBETEEgUGhpbGxpcHMgRm94IFRvd2VyIFRvd2VyIDEsIDIwNSBRdWVlbiBTdHJlZXQsIEF1Y2tsYW5kIENlbnRyYWwsIEF1Y2tsYW5kIDEwMTAsIE5ldyBaZWFsYW5kfmFsdF9rZXk9fmRhdGFzZXQ9TlpMX1BBRn5mb3JtYXRfa2V5PU5aTCQkNzYyTlpMLU5PTlpMSHd6a0J3QUFBQUFJQWdFQUFBQndlSTBBQWhBQVlBQUFBQUFCQUV4bGRtVnNJRGdnUkV4QklGQm9hV3hzYVhCeklFWnZlQ0JVYjNkbGNnQUFBUC4uU0FBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFUR1YyWld3Z09DQkVURUVnVUdocGJHeHBjSE1nUm05NElGUnZkMlZ5SUZSdmQyVnlJREVzSURJd05TQlJkV1ZsYmlCVGRISmxaWFFzSUVGMVkydHNZVzVrSUVObGJuUnlZV3dzSUVGMVkydHNZVzVrSURFd01UQUFBQUFBQUEtLSQkJA\n \n \n \n addressable\n centroid_of_property_latitude\n centroid_of_property_longitude\n centroid_of_property_nztm_x_coordinate\n centroid_of_property_nztm_y_coordinate\n front_of_property_latitude\n front_of_property_longitude\n front_of_property_nztm_x_coordinate\n front_of_property_nztm_y_coordinate\n general_electorate_code\n general_electorate_name\n linz_parcel_id\n maori_electorate_code\n maori_electorate_name\n match_level\n mesh_block_code\n property_purpose_type\n regional_council_code\n regional_council_name\n territorial_authority_code\n territorial_authority_name\n \n \n" }, "USA - Geocodes": { "value": "\n USA\n \n aWQ9VXJiIExhIFBsYXRhLDEgQ2FsbGUgMSxDb21lcmlvLFBSLDAwNzgyLTI3MTd+YWx0X2tleT1VcmIgTGEgUGxhdGF8MSBDYWxsZSAxfHxDb21lcmlvLFBSLDAwNzgyLTI3MTd+Zm9ybWF0SWQ9YTM5NjU1ODctYmIyNS00NmFkLTlkNmMtY2E4MDQ4YmQ0NGY2flFMPTl+Z2VvPTA=\n \n \n \n latitude\n longitude\n match_level\n census_tract\n census_block\n core_based_statistical_area\n congressional_district_code\n county_code\n \n \n" } } }, "application/x-msgpack": { "schema": { "$ref": "#/components/schemas/EnrichmentV2Request" }, "examples": { "GLO - Global Geocodes": { "value": {"country_iso":"USA","keys":{"global_address_key":"aWQ9NDc1IEFudG9uIEJsdmQsIENvc3RhIE1lc2EgQ0EgOTI2MjYsIFVuaXRlZCBTdGF0ZXMgT2YgQW1lcmljYX5hbHRfa2V5PXw0NzUgQW50b24gQmx2ZHx8Q29zdGEgTWVzYSxDQSw5MjYyNi03MDM3fmRhdGFzZXQ9VVNBX1BBRn5mb3JtYXRpZD02YzJkN2RkNC05YzEzLTQ3YWUtYWZiYi0yZWMyYjEyNGE2NDVfVTQwXzI0XzBfMF8wPTQ3NX5xbD0yM35nZW89MA"},"attributes":{"geocodes":["latitude","longitude","match_level"]}} }, "GLO - Premium Location Insight": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9MTAxIE1haW4gUm9hZCwgQ2xlZXZlLCBCcmlzdG9sLCBCUzQ5IDRQTiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0wMzA3MTAyM35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZWZmZjgxOC1mOTJlLTRmNmQtYWU3ZC0wNGJiNjdlZmFhNDUkJCR-UUw9MjE"},"attributes":{"premium_location_insight":["geocodes","geocodes_building_xy","geocodes_access","time"]}} }, "GLO - Premium Location Insight Lite": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9MTAxIE1haW4gUm9hZCwgQ2xlZXZlLCBCcmlzdG9sLCBCUzQ5IDRQTiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0wMzA3MTAyM35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZWZmZjgxOC1mOTJlLTRmNmQtYWU3ZC0wNGJiNjdlZmFhNDUkJCR-UUw9MjE"},"attributes":{"premium_location_insight":["geocodes","geocodes_building_xy","geocodes_access"]}} }, "AUS - Geocodes": { "value": {"country_iso":"AUS","keys":{"global_address_key":"aWQ9OCBDb2NocmFuZSBTdHJlZXQsIFdFU1QgS0VNUFNFWSAgTlNXIDI0NDAsIEF1c3RyYWxpYX5hbHRfa2V5PUdBTlNXNzA2MjY4NjE5fmRhdGFzZXQ9QVVTX0dOQUZ-Zm9ybWF0X2tleT1BVVMkR05BRiQ3NjJBVUctbk9BVUdIQUxsQndBQUFBQUlBZ0VBQUFBQUZ6UXl3QUFBQUFBQUFEZ0FBUC4uWkFBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFPQ0JEYjJOb2NtRnVaU0JUZEhKbFpYUXNJRmRGVTFRZ1MwVk5VRk5GV1NBZ1RsTlhJREkwTkRBQUFBQUFBQS0tJCQk"},"attributes":{"aus_regional_geocodes":["latitude","longitude","match_level","sa1","meshblock","lga_code","lga_name","street_pid","locality_pid","geocode_level_code","geocode_level_description","geocode_type_code","geocode_type_description","highest_level_longitude","highest_level_latitude","highest_level_elevation","highest_level_planimetric_accuracy","highest_level_boundary_extent","highest_level_geocode_reliability_code","highest_level_geocode_reliability_description","confidence_level_code","confidence_level_description","2021_meshblock_id","2021_meshblock_code","2021_meshblock_match_code","2021_meshblock_match_description","2016_meshblock_id","2016_meshblock_code","2016_meshblock_match_code","2016_meshblock_match_description","address_type_code","primary_address_pid","address_join_type","collector_district_id","collector_district_code","commonwealth_electoral_boundary_id","commonwealth_electoral_boundary_name","statistical_local_area_id","statistical_local_area_code","statistical_local_area_name","state_electoral_boundary_id","state_electoral_boundary_name","state_electoral_effective_start","state_electoral_effective_end","state_electoral_new_pid","state_electoral_new_name","state_electoral_new_effective_start","state_electoral_new_effective_end","address_level_longitude","address_level_latitude","address_level_elevation","address_level_planimetric_accuracy","address_level_boundary_extent","address_level_geocode_reliability_code","address_level_geocode_reliability_description","street_level_longitude","street_level_latitude","street_level_planimetric_accuracy","street_level_boundary_extent","street_level_geocode_reliability_code","street_level_geocode_reliability_description","locality_level_longitude","locality_level_latitude","locality_level_planimetric_accuracy","locality_level_geocode_reliability_code","locality_level_geocode_reliability_description","gnaf_legal_parcel_identifier","locality_class_code"]}} }, "GBR - Government": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xMjM1MzIzMX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0aWQ9YmY0NjM5NzItNmM2Yi00OGRiLTg0MTYtYzg5OGQ3YjA5MjFifnFsPTI0fmdlbz0w"},"attributes":{"gbr_government":["eer_code","eer_code_pre_2011","eer_name","gor_code","gor_code_pre_2011","gor_name","la_code","la_code_pre_2011","la_name","lea_code","lea_name","ward_code","ward_code_pre_2011","ward_name","cens_out_area"]}} }, "GBR - Health": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9NzcgU3RhdGlvbiBSb2FkLCBLZWx0eSwgS1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xMjM1MzIzMX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0aWQ9YmY0NjM5NzItNmM2Yi00OGRiLTg0MTYtYzg5OGQ3YjA5MjFifnFsPTI0fmdlbz0w"},"attributes":{"gbr_health":["authority_code","authority_code_2011","authority_name","pclh_code","pclh_code_2011","pclh_name","ward_code","ward_code_2011","ward_name","ccg_code","ccg_name","doh_code"]}} }, "GBR - Location Essential/Complete": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9RXhwZXJpYW4gRGF0YSBRdWFsaXR5LCBGcmlhcnMgSG91c2UsIDE2MCBCbGFja2ZyaWFycyBSb2FkLCBMb25kb24sIFNFMSAuLi4sIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTUyNDQyNTZ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJCQ5NzE4YzMyYS1iNmQzLTQ0NTgtOWQ1OS1hNWIzOTMyYjQzOTEkJCQ"},"attributes":{"uk_location_complete":["latitude","longitude","match_level","udprn","uprn","x_coordinate","y_coordinate"]}} }, "GBR - what3words": { "value": {"country_iso":"GBR","keys":{"global_address_key":"aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRmY2U4YTQzMC0wZjMzLTQxZWYtOTRmNy05ZWVjOGJhOWU0NzYkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw"},"attributes":{"what3words":["latitude","longitude","name","description"]}} }, "NZL - Geocodes": { "value": {"country_iso":"NZL","keys":{"global_address_key":"aWQ9TGV2ZWwgOCBETEEgUGhpbGxpcHMgRm94IFRvd2VyIFRvd2VyIDEsIDIwNSBRdWVlbiBTdHJlZXQsIEF1Y2tsYW5kIENlbnRyYWwsIEF1Y2tsYW5kIDEwMTAsIE5ldyBaZWFsYW5kfmFsdF9rZXk9fmRhdGFzZXQ9TlpMX1BBRn5mb3JtYXRfa2V5PU5aTCQkNzYyTlpMLU5PTlpMSHd6a0J3QUFBQUFJQWdFQUFBQndlSTBBQWhBQVlBQUFBQUFCQUV4bGRtVnNJRGdnUkV4QklGQm9hV3hzYVhCeklFWnZlQ0JVYjNkbGNnQUFBUC4uU0FBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFUR1YyWld3Z09DQkVURUVnVUdocGJHeHBjSE1nUm05NElGUnZkMlZ5SUZSdmQyVnlJREVzSURJd05TQlJkV1ZsYmlCVGRISmxaWFFzSUVGMVkydHNZVzVrSUVObGJuUnlZV3dzSUVGMVkydHNZVzVrSURFd01UQUFBQUFBQUEtLSQkJA"},"attributes":{"nzl_regional_geocodes":["addressable","centroid_of_property_latitude","centroid_of_property_longitude","centroid_of_property_nztm_x_coordinate","centroid_of_property_nztm_y_coordinate","front_of_property_latitude","front_of_property_longitude","front_of_property_nztm_x_coordinate","front_of_property_nztm_y_coordinate","general_electorate_code","general_electorate_name","linz_parcel_id","maori_electorate_code","maori_electorate_name","match_level","mesh_block_code","property_purpose_type","regional_council_code","regional_council_name","territorial_authority_code","territorial_authority_name"]}} }, "USA - Geocodes": { "value": {"country_iso":"USA","keys":{"global_address_key":"aWQ9VXJiIExhIFBsYXRhLDEgQ2FsbGUgMSxDb21lcmlvLFBSLDAwNzgyLTI3MTd+YWx0X2tleT1VcmIgTGEgUGxhdGF8MSBDYWxsZSAxfHxDb21lcmlvLFBSLDAwNzgyLTI3MTd+Zm9ybWF0SWQ9YTM5NjU1ODctYmIyNS00NmFkLTlkNmMtY2E4MDQ4YmQ0NGY2flFMPTl+Z2VvPTA="},"attributes":{"usa_regional_geocodes":["latitude","longitude","match_level","census_tract","census_block","core_based_statistical_area","congressional_district_code","county_code"]}} } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichmentV2Response" }, "examples": { "GLO - Global Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"geocodes":{"latitude":33.68945,"longitude":-117.87401,"match_level":"building"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"geocodes":{"latitude":{"code":"S200","message":"Match","value":"33.68945"},"longitude":{"code":"S200","message":"Match","value":"-117.87401"},"match_level":{"code":"S200","message":"Match","value":"building"}}}}} }, "GLO - Premium Location Insight": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"premium_location_insight":{"geocodes":{"latitude":54.6020056,"longitude":-5.8302126,"match_level":"building"},"geocodes_building_xy":{"x_coordinate":152718.84,"y_coordinate":529726.57},"geocodes_access":[{"latitude":54.6020056,"longitude":-5.8302126}],"time":[{"time_zone_id":"Europe/London","generic":"United Kingdom Time","standard":"Greenwich Mean Time","daylight":"British Summer Time","reference_time":{"tag":"BST","standard_offset":"00:00:00","daylight_savings":"01:00:00","sunrise":"2023-04-11T06:32:15.2599306+01:00","sunset":"2023-04-11T20:16:52.0569033+01:00"},"time_transition":[{"tag":"BST","standard_offset":"00:00:00","daylight_savings":"01:00:00","utc_start":"2023-03-26T01:00:00Z","utc_end":"2023-10-29T01:00:00Z"},{"tag":"GMT","standard_offset":"00:00:00","daylight_savings":"00:00:00","utc_start":"2023-10-29T01:00:00Z","utc_end":"2024-03-31T01:00:00Z"},{"tag":"BST","standard_offset":"00:00:00","daylight_savings":"01:00:00","utc_start":"2024-03-31T01:00:00Z","utc_end":"2024-10-27T01:00:00Z"}]}]}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"premium_location_insight":{"geocodes":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_building_xy":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_access":{"code":"S200","message":"Match","value":"[complex type]"},"time":{"code":"S200","message":"Match","value":"[complex type]"}}}}} }, "GLO - Premium Location Insight Lite": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"premium_location_insight":{"geocodes":{"latitude":54.6020056,"longitude":-5.8302126,"match_level":"building"},"geocodes_building_xy":{"x_coordinate":152718.84,"y_coordinate":529726.57},"geocodes_access":[{"latitude":54.6020056,"longitude":-5.8302126}]}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"premium_location_insight":{"geocodes":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_building_xy":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_access":{"code":"S200","message":"Match","value":"[complex type]"}}}}} }, "AUS - Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"aus_regional_geocodes":{"latitude":-31.06740552,"longitude":152.83315122,"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.833151218104,"highest_level_latitude":-31.0674055233909,"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.833151218104,"address_level_latitude":-31.0674055233909,"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.831107798991,"street_level_latitude":-31.0627225231523,"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.829982639523,"locality_level_latitude":-31.0598233330185,"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"}},"metadata":{"code":"S206","message":"Success","detail":"Some of the requested attribute(s) retrieved.","datasets":{"aus_regional_geocodes":{"latitude":{"code":"S200","message":"Match","value":"-31.06740552"},"longitude":{"code":"S200","message":"Match","value":"152.83315122,"},"match_level":{"code":"S200","message":"Match","value":"building"},"sa1":{"code":"S200","message":"Match","value":"1115514"},"meshblock":{"code":"S200","message":"Match","value":"10402970000"},"lga_code":{"code":"S200","message":"Match","value":"14350"},"lga_name":{"code":"S200","message":"Match","value":"Kempsey (A)"},"street_pid":{"code":"S200","message":"Match","value":"NSW2838126"},"locality_pid":{"code":"S200","message":"Match","value":"NSW4281"},"geocode_level_code":{"code":"S200","message":"Match","value":"7"},"geocode_level_description":{"code":"S200","message":"Match","value":"Locality, street and parcel level geocodes"},"geocode_type_code":{"code":"S200","message":"Match","value":"PC"},"geocode_type_description":{"code":"S200","message":"Match","value":"Property centroid"},"highest_level_longitude":{"code":"S200","message":"Match","value":"152.833151218104"},"highest_level_latitude":{"code":"S200","message":"Match","value":"-31.0674055233909"},"highest_level_elevation":{"code":"E404","message":"Not found","value":""},"highest_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"highest_level_boundary_extent":{"code":"E404","message":"Not found","value":""},"highest_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"2"},"highest_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to place centroid within address site boundary"},"confidence_level_code":{"code":"S200","message":"Match","value":"2"},"confidence_level_description":{"code":"S200","message":"Match","value":"All three contributors have supplied an identical address"},"2021_meshblock_id":{"code":"S200","message":"Match","value":"MB2110402970000"},"2021_meshblock_code":{"code":"S200","message":"Match","value":"10402970000"},"2021_meshblock_match_code":{"code":"S200","message":"Match","value":"1"},"2021_meshblock_match_description":{"code":"S200","message":"Match","value":"Parcel level match"},"2016_meshblock_id":{"code":"S200","message":"Match","value":"MB1610402970000"},"2016_meshblock_code":{"code":"S200","message":"Match","value":"10402970000"},"2016_meshblock_match_code":{"code":"S200","message":"Match","value":"1"},"2016_meshblock_match_description":{"code":"S200","message":"Match","value":"Parcel level match"},"address_type_code":{"code":"E404","message":"Not found","value":""},"primary_address_pid":{"code":"E404","message":"Not found","value":""},"address_join_type":{"code":"E404","message":"Not found","value":""},"collector_district_id":{"code":"S200","message":"Match","value":"NSW1081403"},"collector_district_code":{"code":"S200","message":"Match","value":"1081403"},"commonwealth_electoral_boundary_id":{"code":"S200","message":"Match","value":"NSW32"},"commonwealth_electoral_boundary_name":{"code":"S200","message":"Match","value":"COWPER"},"statistical_local_area_id":{"code":"S200","message":"Match","value":"NSW125104350"},"statistical_local_area_code":{"code":"S200","message":"Match","value":"125104350"},"statistical_local_area_name":{"code":"S200","message":"Match","value":"KEMPSEY (A)"},"state_electoral_boundary_id":{"code":"S200","message":"Match","value":"NSW231"},"state_electoral_boundary_name":{"code":"S200","message":"Match","value":"OXLEY"},"state_electoral_effective_start":{"code":"S200","message":"Match","value":"24/03/2007 00:00:00"},"state_electoral_effective_end":{"code":"S200","message":"Match","value":"28/03/2015 00:00:00"},"state_electoral_new_pid":{"code":"S200","message":"Match","value":"NSW242"},"state_electoral_new_name":{"code":"S200","message":"Match","value":"OXLEY"},"state_electoral_new_effective_start":{"code":"S200","message":"Match","value":"28/03/2015 00:00:00"},"state_electoral_new_effective_end":{"code":"E404","message":"Not found","value":""},"address_level_longitude":{"code":"S200","message":"Match","value":"152.833151218104"},"address_level_latitude":{"code":"S200","message":"Match","value":"-31.0674055233909"},"address_level_elevation":{"code":"E404","message":"Not found","value":""},"address_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"address_level_boundary_extent":{"code":"E404","message":"Not found","value":""},"address_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"2"},"address_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to place centroid within address site boundary"},"street_level_longitude":{"code":"S200","message":"Match","value":"152.831107798991"},"street_level_latitude":{"code":"S200","message":"Match","value":"-31.0627225231523"},"street_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"street_level_boundary_extent":{"code":"S200","message":"Match","value":"651"},"street_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"4"},"street_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to associate address site with a unique road feature"},"locality_level_longitude":{"code":"S200","message":"Match","value":"152.829982639523"},"locality_level_latitude":{"code":"S200","message":"Match","value":"-31.0598233330185"},"locality_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"locality_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"5"},"locality_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood"},"gnaf_legal_parcel_identifier":{"code":"S200","message":"Match","value":"B/366584"},"locality_class_code":{"code":"S200","message":"Match","value":"G"}}}}} }, "GBR - Government": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"gbr_government":{"eer_code":"S15000001","eer_code_pre_2011":"11","eer_name":"Scotland","gor_code":"S99999999","gor_code_pre_2011":"X","gor_name":"Scotland (pseudo)","lea_code":"QR","lea_name":"Fife","la_code":"S12000047","la_name":"Fife","ward_code":"S13003128","ward_name":"Cowdenbeath","cens_out_area":"S00110266"}},"metadata":{"code":"S206","message":"Success","detail":"Some of the requested attribute(s) retrieved.","datasets":{"gbr_government":{"eer_code":{"code":"S200","message":"Match","value":"S15000001"},"eer_code_pre_2011":{"code":"S200","message":"Match","value":"11"},"eer_name":{"code":"S200","message":"Match","value":"Scotland"},"gor_code":{"code":"S200","message":"Match","value":"S99999999"},"gor_code_pre_2011":{"code":"S200","message":"Match","value":"X"},"gor_name":{"code":"S200","message":"Match","value":"Scotland (pseudo)"},"lea_code":{"code":"S200","message":"Match","value":"QR"},"lea_name":{"code":"S200","message":"Match","value":"Fife"},"la_code":{"code":"S200","message":"Match","value":"S12000047"},"la_code_pre_2011":{"code":"E404","message":"Not found","value":""},"la_name":{"code":"S200","message":"Match","value":"Fife"},"ward_code":{"code":"S200","message":"Match","value":"S13003128"},"ward_code_pre_2011":{"code":"E404","message":"Not found","value":""},"ward_name":{"code":"S200","message":"Match","value":"Cowdenbeath"},"cens_out_area":{"code":"S200","message":"Match","value":"S00110266"}}}}} }, "GBR - Health": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"gbr_health":{"authority_code_2011":"S08000029","authority_name":"Fife","pclh_code":"006","pclh_code_2011":"S03000006","pclh_name":"Dunfermline and West Fife Community Health Partnership","ward_code_2011":"S13003128","ward_name":"Cowdenbeath","ccg_code":"S03000006","ccg_name":"Dunfermline and West Fife Community Health Partnership","doh_code":"006"}},"metadata":{"code":"S206","message":"Success","detail":"Some of the requested attribute(s) retrieved.","datasets":{"gbr_health":{"authority_code":{"code":"E404","message":"Not found","value":""},"authority_code_2011":{"code":"S200","message":"Match","value":"S08000029"},"authority_name":{"code":"S200","message":"Match","value":"Fife"},"pclh_code":{"code":"S200","message":"Match","value":"006"},"pclh_code_2011":{"code":"S200","message":"Match","value":"S03000006"},"pclh_name":{"code":"S200","message":"Match","value":"Dunfermline and West Fife Community Health Partnership"},"ward_code":{"code":"E404","message":"Not found","value":""},"ward_code_2011":{"code":"S200","message":"Match","value":"S13003128"},"ward_name":{"code":"S200","message":"Match","value":"Cowdenbeath"},"ccg_code":{"code":"S200","message":"Match","value":"S03000006"},"ccg_name":{"code":"S200","message":"Match","value":"Dunfermline and West Fife Community Health Partnership"},"doh_code":{"code":"S200","message":"Match","value":"006"}}}}} }, "GBR - Location Essential/Complete": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"uk_location_complete":{"latitude":51.5014256,"longitude":-0.104257,"match_level":"building","udprn":"55244256","uprn":"10091977422","x_coordinate":531677.95,"y_coordinate":179757.59}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"uk_location_complete":{"latitude":{"code":"S200","message":"Match","value":"51.5014256"},"longitude":{"code":"S200","message":"Match","value":"-0.104257"},"match_level":{"code":"S200","message":"Match","value":"building"},"udprn":{"code":"S200","message":"Match","value":"55244256"},"uprn":{"code":"S200","message":"Match","value":"10091977422"},"x_coordinate":{"code":"S200","message":"Match","value":"531677.95"},"y_coordinate":{"code":"S200","message":"Match","value":"179757.59"}}}}} }, "GBR - what3words": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"what3words":{"latitude":51.751172,"longitude":-1.24623,"name":"pretty.needed.chill","description":"near Oxford, Oxfordshire"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"what3words":{"latitude":{"code":"S200","message":"Match","value":"51.751172"},"longitude":{"code":"S200","message":"Match","value":"-1.24623"},"name":{"code":"S200","message":"Match","value":"pretty.needed.chill"},"description":{"code":"S200","message":"Match","value":"near Oxford, Oxfordshire"}}}}} }, "NZL - Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"nzl_regional_geocodes":{"front_of_property_nztm_x_coordinate":1757352.77679428,"front_of_property_nztm_y_coordinate":5920390.38954181,"centroid_of_property_nztm_x_coordinate":1757328.32545739,"centroid_of_property_nztm_y_coordinate":5920399.80535698,"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.84930884682109,"front_of_property_longitude":174.76492824881467,"centroid_of_property_latitude":-36.849228077790954,"centroid_of_property_longitude":174.76465216104987,"match_level":"building"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"nzl_regional_geocodes":{"front_of_property_nztm_x_coordinate":{"code":"S200","message":"Match","value":"1757352.77679428"},"front_of_property_nztm_y_coordinate":{"code":"S200","message":"Match","value":"5920390.38954181"},"centroid_of_property_nztm_x_coordinate":{"code":"S200","message":"Match","value":"1757328.32545739"},"centroid_of_property_nztm_y_coordinate":{"code":"S200","message":"Match","value":"5920399.80535698"},"linz_parcel_id":{"code":"S200","message":"Match","value":"5047052"},"property_purpose_type":{"code":"S200","message":"Match","value":"Business"},"addressable":{"code":"S200","message":"Match","value":"N"},"mesh_block_code":{"code":"S200","message":"Match","value":"434000"},"territorial_authority_code":{"code":"S200","message":"Match","value":"76"},"territorial_authority_name":{"code":"S200","message":"Match","value":"Auckland"},"regional_council_code":{"code":"S200","message":"Match","value":"2"},"regional_council_name":{"code":"S200","message":"Match","value":"Auckland Region"},"general_electorate_code":{"code":"S200","message":"Match","value":"001"},"general_electorate_name":{"code":"S200","message":"Match","value":"Auckland Central"},"maori_electorate_code":{"code":"S200","message":"Match","value":"3"},"maori_electorate_name":{"code":"S200","message":"Match","value":"Tamaki Makaurau"},"front_of_property_latitude":{"code":"S200","message":"Match","value":"-36.84930884682109"},"front_of_property_longitude":{"code":"S200","message":"Match","value":"174.76492824881467"},"centroid_of_property_latitude":{"code":"S200","message":"Match","value":"-36.849228077790954"},"centroid_of_property_longitude":{"code":"S200","message":"Match","value":"174.76465216104987"},"match_level":{"code":"S200","message":"Match","value":"building"}}}}} }, "USA - Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"usa_regional_geocodes":{"latitude":18.215183,"longitude":-66.226806,"match_level":"building","census_tract":"952000","census_block":"2012","core_based_statistical_area":"41980","congressional_district_code":"7298116","county_code":"045"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"usa_regional_geocodes":{"latitude":{"code":"S200","message":"Match","value":"18.215183"},"longitude":{"code":"S200","message":"Match","value":"-66.226806"},"match_level":{"code":"S200","message":"Match","value":"building"},"census_tract":{"code":"S200","message":"Match","value":"952000"},"census_block":{"code":"S200","message":"Match","value":"2012"},"core_based_statistical_area":{"code":"S200","message":"Match","value":"41980"},"congressional_district_code":{"code":"S200","message":"Match","value":"7298116"},"county_code":{"code":"S200","message":"Match","value":"045"}}}}} } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EnrichmentV2Response" }, "examples": { "GLO - Global Geocodes": { "value": "\n \n \n 33.68945\n -117.87401\n building\n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n 33.68945\n \n \n S200\n Match\n -117.87401\n \n \n S200\n Match\n building\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "GLO - Premium Location Insight": { "value": "\n \n \n \n 54.6020056\n -5.8302126\n building\n \n \n 152718.84\n 529726.57\n \n \n \n 54.6020056\n -5.8302126\n \n \n \n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n [complex type]\n \n \n S200\n Match\n [complex type]\n \n \n S200\n Match\n [complex type]\n \n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "GLO - Premium Location Insight Lite": { "value": "\n \n \n \n 54.6020056\n -5.8302126\n building\n \n \n 152718.84\n 529726.57\n \n \n \n 54.6020056\n -5.8302126\n \n \n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n [complex type]\n \n \n S200\n Match\n [complex type]\n \n \n S200\n Match\n [complex type]\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "AUS - Geocodes": { "value": "\n \n \n -31.06740552\n 152.83315122\n building\n 1115514\n 10402970000\n 14350\n Kempsey (A)\n NSW2838126\n NSW4281\n 7\n Locality, street and parcel level geocodes\n PC\n Property centroid\n 152.833151218104\n -31.0674055233909\n 2\n Geocode accuracy sufficient to place centroid within address site boundary\n 2\n All three contributors have supplied an identical address\n <_x0032_021_meshblock_id>MB2110402970000\n <_x0032_021_meshblock_code>10402970000\n <_x0032_021_meshblock_match_code>1\n <_x0032_021_meshblock_match_description>Parcel level match\n <_x0032_016_meshblock_id>MB1610402970000\n <_x0032_016_meshblock_code>10402970000\n <_x0032_016_meshblock_match_code>1\n <_x0032_016_meshblock_match_description>Parcel level match\n NSW1081403\n 1081403\n NSW32\n COWPER\n NSW125104350\n 125104350\n KEMPSEY (A)\n NSW231\n OXLEY\n 24/03/2007 00:00:00\n 28/03/2015 00:00:00\n NSW242\n OXLEY\n 28/03/2015 00:00:00\n 152.833151218104\n -31.0674055233909\n 2\n Geocode accuracy sufficient to place centroid within address site boundary\n 152.831107798991\n -31.0627225231523\n 651\n 4\n Geocode accuracy sufficient to associate address site with a unique road feature\n 152.829982639523\n -31.0598233330185\n 5\n Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood\n B/366584\n G\n \n \n \n S206\n Success\n Some of the requested attribute(s) retrieved.\n \n \n \n S200\n Match\n -31.06740552\n \n \n S200\n Match\n 152.83315122,\n \n \n S200\n Match\n building\n \n \n S200\n Match\n 1115514\n \n \n S200\n Match\n 10402970000\n \n \n S200\n Match\n 14350\n \n \n S200\n Match\n Kempsey (A)\n \n \n S200\n Match\n NSW2838126\n \n \n S200\n Match\n NSW4281\n \n \n S200\n Match\n 7\n \n \n S200\n Match\n Locality, street and parcel level geocodes\n \n \n S200\n Match\n PC\n \n \n S200\n Match\n Property centroid\n \n \n S200\n Match\n 152.833151218104\n \n \n S200\n Match\n -31.0674055233909\n \n \n E404\n Not found\n \n \n \n E404\n Not found\n \n \n \n E404\n Not found\n \n \n \n S200\n Match\n 2\n \n \n S200\n Match\n Geocode accuracy sufficient to place centroid within address site boundary\n \n \n S200\n Match\n 2\n \n \n S200\n Match\n All three contributors have supplied an identical address\n \n <_x0032_021_meshblock_id>\n S200\n Match\n MB2110402970000\n \n <_x0032_021_meshblock_code>\n S200\n Match\n 10402970000\n \n <_x0032_021_meshblock_match_code>\n S200\n Match\n 1\n \n <_x0032_021_meshblock_match_description>\n S200\n Match\n Parcel level match\n \n <_x0032_016_meshblock_id>\n S200\n Match\n MB1610402970000\n \n <_x0032_016_meshblock_code>\n S200\n Match\n 10402970000\n \n <_x0032_016_meshblock_match_code>\n S200\n Match\n 1\n \n <_x0032_016_meshblock_match_description>\n S200\n Match\n Parcel level match\n \n \n E404\n Not found\n \n \n \n E404\n Not found\n \n \n \n E404\n Not found\n \n \n \n S200\n Match\n NSW1081403\n \n \n S200\n Match\n 1081403\n \n \n S200\n Match\n NSW32\n \n \n S200\n Match\n COWPER\n \n \n S200\n Match\n NSW125104350\n \n \n S200\n Match\n 125104350\n \n \n S200\n Match\n KEMPSEY (A)\n \n \n S200\n Match\n NSW231\n \n \n S200\n Match\n OXLEY\n \n \n S200\n Match\n 24/03/2007 00:00:00\n \n \n S200\n Match\n 28/03/2015 00:00:00\n \n \n S200\n Match\n NSW242\n \n \n S200\n Match\n OXLEY\n \n \n S200\n Match\n 28/03/2015 00:00:00\n \n \n E404\n Not found\n \n \n \n S200\n Match\n 152.833151218104\n \n \n S200\n Match\n -31.0674055233909\n \n \n E404\n Not found\n \n \n \n E404\n Not found\n \n \n \n E404\n Not found\n \n \n \n S200\n Match\n 2\n \n \n S200\n Match\n Geocode accuracy sufficient to place centroid within address site boundary\n \n \n S200\n Match\n 152.831107798991\n \n \n S200\n Match\n -31.0627225231523\n \n \n E404\n Not found\n \n \n \n S200\n Match\n 651\n \n \n S200\n Match\n 4\n \n \n S200\n Match\n Geocode accuracy sufficient to associate address site with a unique road feature\n \n \n S200\n Match\n 152.829982639523\n \n \n S200\n Match\n -31.0598233330185\n \n \n E404\n Not found\n \n \n \n S200\n Match\n 5\n \n \n S200\n Match\n Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood\n \n \n S200\n Match\n B/366584\n \n \n S200\n Match\n G\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "GBR - Government": { "value": "\n \n \n S15000001\n 11\n Scotland\n S99999999\n X\n Scotland (pseudo)\n QR\n Fife\n S12000047\n Fife\n S13003128\n Cowdenbeath\n S00110266\n \n \n \n S206\n Success\n Some of the requested attribute(s) retrieved.\n \n \n \n S200\n Match\n S15000001\n \n \n S200\n Match\n 11\n \n \n S200\n Match\n Scotland\n \n \n S200\n Match\n S99999999\n \n \n S200\n Match\n X\n \n \n S200\n Match\n Scotland (pseudo)\n \n \n S200\n Match\n QR\n \n \n S200\n Match\n Fife\n \n \n S200\n Match\n S12000047\n \n \n E404\n Not found\n \n \n \n S200\n Match\n Fife\n \n \n S200\n Match\n S13003128\n \n \n E404\n Not found\n \n \n \n S200\n Match\n Cowdenbeath\n \n \n S200\n Match\n S00110266\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "GBR - Health": { "value": "\n \n \n S08000029\n Fife\n 006\n S03000006\n Dunfermline and West Fife Community Health Partnership\n S13003128\n Cowdenbeath\n S03000006\n Dunfermline and West Fife Community Health Partnership\n 006\n \n \n \n S206\n Success\n Some of the requested attribute(s) retrieved.\n \n \n \n E404\n Not found\n \n \n \n S200\n Match\n S08000029\n \n \n S200\n Match\n Fife\n \n \n S200\n Match\n 006\n \n \n S200\n Match\n S03000006\n \n \n S200\n Match\n Dunfermline and West Fife Community Health Partnership\n \n \n E404\n Not found\n \n \n \n S200\n Match\n S13003128\n \n \n S200\n Match\n Cowdenbeath\n \n \n S200\n Match\n S03000006\n \n \n S200\n Match\n Dunfermline and West Fife Community Health Partnership\n \n \n S200\n Match\n 006\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "GBR - Location Essential/Complete": { "value": "\n \n \n 51.5014256\n -0.104257\n building\n 55244256\n 10091977422\n 531677.95\n 179757.59\n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n 51.5014256\n \n \n S200\n Match\n -0.104257\n \n \n S200\n Match\n building\n \n \n S200\n Match\n 55244256\n \n \n S200\n Match\n 10091977422\n \n \n S200\n Match\n 531677.95\n \n \n S200\n Match\n 179757.59\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "GBR - what3words": { "value": "\n \n \n 51.751172\n -1.24623\n pretty.needed.chill\n near Oxford, Oxfordshire\n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n 51.751172\n \n \n S200\n Match\n -1.24623\n \n \n S200\n Match\n pretty.needed.chill\n \n \n S200\n Match\n near Oxford, Oxfordshire\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "NZL - Geocodes": { "value": "\n \n \n 1757352.77679428\n 5920390.38954181\n 1757328.32545739\n 5920399.80535698\n 5047052\n Business\n N\n 434000\n 76\n Auckland\n 2\n Auckland Region\n 001\n Auckland Central\n 3\n Tamaki Makaurau\n -36.84930884682109\n 174.76492824881467\n -36.849228077790954\n 174.76465216104987\n building\n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n 1757352.77679428\n \n \n S200\n Match\n 5920390.38954181\n \n \n S200\n Match\n 1757328.32545739\n \n \n S200\n Match\n 5920399.80535698\n \n \n S200\n Match\n 5047052\n \n \n S200\n Match\n Business\n \n \n S200\n Match\n N\n \n \n S200\n Match\n 434000\n \n \n S200\n Match\n 76\n \n \n S200\n Match\n Auckland\n \n \n S200\n Match\n 2\n \n \n S200\n Match\n Auckland Region\n \n \n S200\n Match\n 001\n \n \n S200\n Match\n Auckland Central\n \n \n S200\n Match\n 3\n \n \n S200\n Match\n Tamaki Makaurau\n \n \n S200\n Match\n -36.84930884682109\n \n \n S200\n Match\n 174.76492824881467\n \n \n S200\n Match\n -36.849228077790954\n \n \n S200\n Match\n 174.76465216104987\n \n \n S200\n Match\n building\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" }, "USA - Geocodes": { "value": "\n \n \n 18.215183\n -66.226806\n building\n 952000\n 2012\n 41980\n 7298116\n 045\n \n \n \n S200\n Success\n All requested attribute(s) retrieved.\n \n \n \n S200\n Match\n 18.215183\n \n \n S200\n Match\n -66.226806\n \n \n S200\n Match\n building\n \n \n S200\n Match\n 952000\n \n \n S200\n Match\n 2012\n \n \n S200\n Match\n 41980\n \n \n S200\n Match\n 7298116\n \n \n S200\n Match\n 045\n \n \n \n \n 00000000-0000-0000-0000-000000000000\n" } } }, "application/x-msgpack": { "schema": { "$ref": "#/components/schemas/EnrichmentV2Response" }, "examples": { "GLO - Global Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"geocodes":{"latitude":33.68945,"longitude":-117.87401,"match_level":"building"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"geocodes":{"latitude":{"code":"S200","message":"Match","value":"33.68945"},"longitude":{"code":"S200","message":"Match","value":"-117.87401"},"match_level":{"code":"S200","message":"Match","value":"building"}}}}} }, "GLO - Premium Location Insight": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"premium_location_insight":{"geocodes":{"latitude":54.6020056,"longitude":-5.8302126,"match_level":"building"},"geocodes_building_xy":{"x_coordinate":152718.84,"y_coordinate":529726.57},"geocodes_access":[{"latitude":54.6020056,"longitude":-5.8302126}],"time":[{"time_zone_id":"Europe/London","generic":"United Kingdom Time","standard":"Greenwich Mean Time","daylight":"British Summer Time","reference_time":{"tag":"BST","standard_offset":"00:00:00","daylight_savings":"01:00:00","sunrise":"2023-04-11T06:32:15.2599306+01:00","sunset":"2023-04-11T20:16:52.0569033+01:00"},"time_transition":[{"tag":"BST","standard_offset":"00:00:00","daylight_savings":"01:00:00","utc_start":"2023-03-26T01:00:00Z","utc_end":"2023-10-29T01:00:00Z"},{"tag":"GMT","standard_offset":"00:00:00","daylight_savings":"00:00:00","utc_start":"2023-10-29T01:00:00Z","utc_end":"2024-03-31T01:00:00Z"},{"tag":"BST","standard_offset":"00:00:00","daylight_savings":"01:00:00","utc_start":"2024-03-31T01:00:00Z","utc_end":"2024-10-27T01:00:00Z"}]}]}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"premium_location_insight":{"geocodes":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_building_xy":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_access":{"code":"S200","message":"Match","value":"[complex type]"},"time":{"code":"S200","message":"Match","value":"[complex type]"}}}}} }, "GLO - Premium Location Insight Lite": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"premium_location_insight":{"geocodes":{"latitude":54.6020056,"longitude":-5.8302126,"match_level":"building"},"geocodes_building_xy":{"x_coordinate":152718.84,"y_coordinate":529726.57},"geocodes_access":[{"latitude":54.6020056,"longitude":-5.8302126}]}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"premium_location_insight":{"geocodes":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_building_xy":{"code":"S200","message":"Match","value":"[complex type]"},"geocodes_access":{"code":"S200","message":"Match","value":"[complex type]"}}}}} }, "AUS - Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"aus_regional_geocodes":{"latitude":-31.06740552,"longitude":152.83315122,"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.833151218104,"highest_level_latitude":-31.0674055233909,"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.833151218104,"address_level_latitude":-31.0674055233909,"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.831107798991,"street_level_latitude":-31.0627225231523,"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.829982639523,"locality_level_latitude":-31.0598233330185,"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"}},"metadata":{"code":"S206","message":"Success","detail":"Some of the requested attribute(s) retrieved.","datasets":{"aus_regional_geocodes":{"latitude":{"code":"S200","message":"Match","value":"-31.06740552"},"longitude":{"code":"S200","message":"Match","value":"152.83315122,"},"match_level":{"code":"S200","message":"Match","value":"building"},"sa1":{"code":"S200","message":"Match","value":"1115514"},"meshblock":{"code":"S200","message":"Match","value":"10402970000"},"lga_code":{"code":"S200","message":"Match","value":"14350"},"lga_name":{"code":"S200","message":"Match","value":"Kempsey (A)"},"street_pid":{"code":"S200","message":"Match","value":"NSW2838126"},"locality_pid":{"code":"S200","message":"Match","value":"NSW4281"},"geocode_level_code":{"code":"S200","message":"Match","value":"7"},"geocode_level_description":{"code":"S200","message":"Match","value":"Locality, street and parcel level geocodes"},"geocode_type_code":{"code":"S200","message":"Match","value":"PC"},"geocode_type_description":{"code":"S200","message":"Match","value":"Property centroid"},"highest_level_longitude":{"code":"S200","message":"Match","value":"152.833151218104"},"highest_level_latitude":{"code":"S200","message":"Match","value":"-31.0674055233909"},"highest_level_elevation":{"code":"E404","message":"Not found","value":""},"highest_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"highest_level_boundary_extent":{"code":"E404","message":"Not found","value":""},"highest_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"2"},"highest_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to place centroid within address site boundary"},"confidence_level_code":{"code":"S200","message":"Match","value":"2"},"confidence_level_description":{"code":"S200","message":"Match","value":"All three contributors have supplied an identical address"},"2021_meshblock_id":{"code":"S200","message":"Match","value":"MB2110402970000"},"2021_meshblock_code":{"code":"S200","message":"Match","value":"10402970000"},"2021_meshblock_match_code":{"code":"S200","message":"Match","value":"1"},"2021_meshblock_match_description":{"code":"S200","message":"Match","value":"Parcel level match"},"2016_meshblock_id":{"code":"S200","message":"Match","value":"MB1610402970000"},"2016_meshblock_code":{"code":"S200","message":"Match","value":"10402970000"},"2016_meshblock_match_code":{"code":"S200","message":"Match","value":"1"},"2016_meshblock_match_description":{"code":"S200","message":"Match","value":"Parcel level match"},"address_type_code":{"code":"E404","message":"Not found","value":""},"primary_address_pid":{"code":"E404","message":"Not found","value":""},"address_join_type":{"code":"E404","message":"Not found","value":""},"collector_district_id":{"code":"S200","message":"Match","value":"NSW1081403"},"collector_district_code":{"code":"S200","message":"Match","value":"1081403"},"commonwealth_electoral_boundary_id":{"code":"S200","message":"Match","value":"NSW32"},"commonwealth_electoral_boundary_name":{"code":"S200","message":"Match","value":"COWPER"},"statistical_local_area_id":{"code":"S200","message":"Match","value":"NSW125104350"},"statistical_local_area_code":{"code":"S200","message":"Match","value":"125104350"},"statistical_local_area_name":{"code":"S200","message":"Match","value":"KEMPSEY (A)"},"state_electoral_boundary_id":{"code":"S200","message":"Match","value":"NSW231"},"state_electoral_boundary_name":{"code":"S200","message":"Match","value":"OXLEY"},"state_electoral_effective_start":{"code":"S200","message":"Match","value":"24/03/2007 00:00:00"},"state_electoral_effective_end":{"code":"S200","message":"Match","value":"28/03/2015 00:00:00"},"state_electoral_new_pid":{"code":"S200","message":"Match","value":"NSW242"},"state_electoral_new_name":{"code":"S200","message":"Match","value":"OXLEY"},"state_electoral_new_effective_start":{"code":"S200","message":"Match","value":"28/03/2015 00:00:00"},"state_electoral_new_effective_end":{"code":"E404","message":"Not found","value":""},"address_level_longitude":{"code":"S200","message":"Match","value":"152.833151218104"},"address_level_latitude":{"code":"S200","message":"Match","value":"-31.0674055233909"},"address_level_elevation":{"code":"E404","message":"Not found","value":""},"address_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"address_level_boundary_extent":{"code":"E404","message":"Not found","value":""},"address_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"2"},"address_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to place centroid within address site boundary"},"street_level_longitude":{"code":"S200","message":"Match","value":"152.831107798991"},"street_level_latitude":{"code":"S200","message":"Match","value":"-31.0627225231523"},"street_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"street_level_boundary_extent":{"code":"S200","message":"Match","value":"651"},"street_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"4"},"street_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to associate address site with a unique road feature"},"locality_level_longitude":{"code":"S200","message":"Match","value":"152.829982639523"},"locality_level_latitude":{"code":"S200","message":"Match","value":"-31.0598233330185"},"locality_level_planimetric_accuracy":{"code":"E404","message":"Not found","value":""},"locality_level_geocode_reliability_code":{"code":"S200","message":"Match","value":"5"},"locality_level_geocode_reliability_description":{"code":"S200","message":"Match","value":"Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood"},"gnaf_legal_parcel_identifier":{"code":"S200","message":"Match","value":"B/366584"},"locality_class_code":{"code":"S200","message":"Match","value":"G"}}}}} }, "GBR - Government": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"gbr_government":{"eer_code":"S15000001","eer_code_pre_2011":"11","eer_name":"Scotland","gor_code":"S99999999","gor_code_pre_2011":"X","gor_name":"Scotland (pseudo)","lea_code":"QR","lea_name":"Fife","la_code":"S12000047","la_name":"Fife","ward_code":"S13003128","ward_name":"Cowdenbeath","cens_out_area":"S00110266"}},"metadata":{"code":"S206","message":"Success","detail":"Some of the requested attribute(s) retrieved.","datasets":{"gbr_government":{"eer_code":{"code":"S200","message":"Match","value":"S15000001"},"eer_code_pre_2011":{"code":"S200","message":"Match","value":"11"},"eer_name":{"code":"S200","message":"Match","value":"Scotland"},"gor_code":{"code":"S200","message":"Match","value":"S99999999"},"gor_code_pre_2011":{"code":"S200","message":"Match","value":"X"},"gor_name":{"code":"S200","message":"Match","value":"Scotland (pseudo)"},"lea_code":{"code":"S200","message":"Match","value":"QR"},"lea_name":{"code":"S200","message":"Match","value":"Fife"},"la_code":{"code":"S200","message":"Match","value":"S12000047"},"la_code_pre_2011":{"code":"E404","message":"Not found","value":""},"la_name":{"code":"S200","message":"Match","value":"Fife"},"ward_code":{"code":"S200","message":"Match","value":"S13003128"},"ward_code_pre_2011":{"code":"E404","message":"Not found","value":""},"ward_name":{"code":"S200","message":"Match","value":"Cowdenbeath"},"cens_out_area":{"code":"S200","message":"Match","value":"S00110266"}}}}} }, "GBR - Health": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"gbr_health":{"authority_code_2011":"S08000029","authority_name":"Fife","pclh_code":"006","pclh_code_2011":"S03000006","pclh_name":"Dunfermline and West Fife Community Health Partnership","ward_code_2011":"S13003128","ward_name":"Cowdenbeath","ccg_code":"S03000006","ccg_name":"Dunfermline and West Fife Community Health Partnership","doh_code":"006"}},"metadata":{"code":"S206","message":"Success","detail":"Some of the requested attribute(s) retrieved.","datasets":{"gbr_health":{"authority_code":{"code":"E404","message":"Not found","value":""},"authority_code_2011":{"code":"S200","message":"Match","value":"S08000029"},"authority_name":{"code":"S200","message":"Match","value":"Fife"},"pclh_code":{"code":"S200","message":"Match","value":"006"},"pclh_code_2011":{"code":"S200","message":"Match","value":"S03000006"},"pclh_name":{"code":"S200","message":"Match","value":"Dunfermline and West Fife Community Health Partnership"},"ward_code":{"code":"E404","message":"Not found","value":""},"ward_code_2011":{"code":"S200","message":"Match","value":"S13003128"},"ward_name":{"code":"S200","message":"Match","value":"Cowdenbeath"},"ccg_code":{"code":"S200","message":"Match","value":"S03000006"},"ccg_name":{"code":"S200","message":"Match","value":"Dunfermline and West Fife Community Health Partnership"},"doh_code":{"code":"S200","message":"Match","value":"006"}}}}} }, "GBR - Location Essential/Complete": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"uk_location_complete":{"latitude":51.5014256,"longitude":-0.104257,"match_level":"building","udprn":"55244256","uprn":"10091977422","x_coordinate":531677.95,"y_coordinate":179757.59}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"uk_location_complete":{"latitude":{"code":"S200","message":"Match","value":"51.5014256"},"longitude":{"code":"S200","message":"Match","value":"-0.104257"},"match_level":{"code":"S200","message":"Match","value":"building"},"udprn":{"code":"S200","message":"Match","value":"55244256"},"uprn":{"code":"S200","message":"Match","value":"10091977422"},"x_coordinate":{"code":"S200","message":"Match","value":"531677.95"},"y_coordinate":{"code":"S200","message":"Match","value":"179757.59"}}}}} }, "GBR - what3words": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"what3words":{"latitude":51.751172,"longitude":-1.24623,"name":"pretty.needed.chill","description":"near Oxford, Oxfordshire"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"what3words":{"latitude":{"code":"S200","message":"Match","value":"51.751172"},"longitude":{"code":"S200","message":"Match","value":"-1.24623"},"name":{"code":"S200","message":"Match","value":"pretty.needed.chill"},"description":{"code":"S200","message":"Match","value":"near Oxford, Oxfordshire"}}}}} }, "NZL - Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"nzl_regional_geocodes":{"front_of_property_nztm_x_coordinate":1757352.77679428,"front_of_property_nztm_y_coordinate":5920390.38954181,"centroid_of_property_nztm_x_coordinate":1757328.32545739,"centroid_of_property_nztm_y_coordinate":5920399.80535698,"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.84930884682109,"front_of_property_longitude":174.76492824881467,"centroid_of_property_latitude":-36.849228077790954,"centroid_of_property_longitude":174.76465216104987,"match_level":"building"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"nzl_regional_geocodes":{"front_of_property_nztm_x_coordinate":{"code":"S200","message":"Match","value":"1757352.77679428"},"front_of_property_nztm_y_coordinate":{"code":"S200","message":"Match","value":"5920390.38954181"},"centroid_of_property_nztm_x_coordinate":{"code":"S200","message":"Match","value":"1757328.32545739"},"centroid_of_property_nztm_y_coordinate":{"code":"S200","message":"Match","value":"5920399.80535698"},"linz_parcel_id":{"code":"S200","message":"Match","value":"5047052"},"property_purpose_type":{"code":"S200","message":"Match","value":"Business"},"addressable":{"code":"S200","message":"Match","value":"N"},"mesh_block_code":{"code":"S200","message":"Match","value":"434000"},"territorial_authority_code":{"code":"S200","message":"Match","value":"76"},"territorial_authority_name":{"code":"S200","message":"Match","value":"Auckland"},"regional_council_code":{"code":"S200","message":"Match","value":"2"},"regional_council_name":{"code":"S200","message":"Match","value":"Auckland Region"},"general_electorate_code":{"code":"S200","message":"Match","value":"001"},"general_electorate_name":{"code":"S200","message":"Match","value":"Auckland Central"},"maori_electorate_code":{"code":"S200","message":"Match","value":"3"},"maori_electorate_name":{"code":"S200","message":"Match","value":"Tamaki Makaurau"},"front_of_property_latitude":{"code":"S200","message":"Match","value":"-36.84930884682109"},"front_of_property_longitude":{"code":"S200","message":"Match","value":"174.76492824881467"},"centroid_of_property_latitude":{"code":"S200","message":"Match","value":"-36.849228077790954"},"centroid_of_property_longitude":{"code":"S200","message":"Match","value":"174.76465216104987"},"match_level":{"code":"S200","message":"Match","value":"building"}}}}} }, "USA - Geocodes": { "value": {"transaction_id":"00000000-0000-0000-0000-000000000000","result":{"usa_regional_geocodes":{"latitude":18.215183,"longitude":-66.226806,"match_level":"building","census_tract":"952000","census_block":"2012","core_based_statistical_area":"41980","congressional_district_code":"7298116","county_code":"045"}},"metadata":{"code":"S200","message":"Success","detail":"All requested attribute(s) retrieved.","datasets":{"usa_regional_geocodes":{"latitude":{"code":"S200","message":"Match","value":"18.215183"},"longitude":{"code":"S200","message":"Match","value":"-66.226806"},"match_level":{"code":"S200","message":"Match","value":"building"},"census_tract":{"code":"S200","message":"Match","value":"952000"},"census_block":{"code":"S200","message":"Match","value":"2012"},"core_based_statistical_area":{"code":"S200","message":"Match","value":"41980"},"congressional_district_code":{"code":"S200","message":"Match","value":"7298116"},"county_code":{"code":"S200","message":"Match","value":"045"}}}}} } } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "406": { "description": "Not Acceptable" }, "408": { "description": "Request Timeout" }, "415": { "description": "Unsupported Media Type" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server Error" }, "503": { "description": "Service Unavailable" } }, "security": [ { "OAuth2": [ ] }, { "Auth-Token": [ ] } ] } } }, "components": { "schemas": { "DatasetMetadata": { "type": "object", "properties": { "code": { "type": "string", "description": "Attribute-level metadata code.", "nullable": true, "example": "S200" }, "message": { "type": "string", "description": "Attribute-level metadata message.", "nullable": true, "example": "Match" }, "value": { "type": "string", "description": "The attribute's value that was returned by the API.", "nullable": true } }, "additionalProperties": false, "description": "The attribute's metadata." }, "EnrichmentV2AttributesAusRegionalGeocodes": { "enum": [ "latitude", "longitude", "match_level", "sa1", "meshblock", "lga_code", "lga_name", "street_pid", "locality_pid", "geocode_level_code", "geocode_level_description", "geocode_type_code", "geocode_type_description", "highest_level_longitude", "highest_level_latitude", "highest_level_elevation", "highest_level_planimetric_accuracy", "highest_level_boundary_extent", "highest_level_geocode_reliability_code", "highest_level_geocode_reliability_description", "confidence_level_code", "confidence_level_description", "2021_meshblock_id", "2021_meshblock_code", "2021_meshblock_match_code", "2021_meshblock_match_description", "2016_meshblock_id", "2016_meshblock_code", "2016_meshblock_match_code", "2016_meshblock_match_description", "address_type_code", "primary_address_pid", "address_join_type", "collector_district_id", "collector_district_code", "commonwealth_electoral_boundary_id", "commonwealth_electoral_boundary_name", "statistical_local_area_id", "statistical_local_area_code", "statistical_local_area_name", "state_electoral_boundary_id", "state_electoral_boundary_name", "state_electoral_effective_start", "state_electoral_effective_end", "state_electoral_new_pid", "state_electoral_new_name", "state_electoral_new_effective_start", "state_electoral_new_effective_end", "address_level_longitude", "address_level_latitude", "address_level_elevation", "address_level_planimetric_accuracy", "address_level_boundary_extent", "address_level_geocode_reliability_code", "address_level_geocode_reliability_description", "street_level_longitude", "street_level_latitude", "street_level_planimetric_accuracy", "street_level_boundary_extent", "street_level_geocode_reliability_code", "street_level_geocode_reliability_description", "locality_level_longitude", "locality_level_latitude", "locality_level_planimetric_accuracy", "locality_level_geocode_reliability_code", "locality_level_geocode_reliability_description", "gnaf_legal_parcel_identifier", "locality_class_code" ], "type": "string", "description": "The dataset named AUS Regional Geocodes its associated attributes." }, "EnrichmentV2AttributesGbrGovernment": { "enum": [ "eer_code", "eer_code_pre_2011", "eer_name", "gor_code", "gor_code_pre_2011", "gor_name", "lea_code", "lea_name", "la_code", "la_code_pre_2011", "la_name", "ward_code", "ward_code_pre_2011", "ward_name", "cens_out_area" ], "type": "string", "description": "The dataset named GBR Government and its associated attributes." }, "EnrichmentV2AttributesGbrHealth": { "enum": [ "authority_code", "authority_code_2011", "authority_name", "pclh_code", "pclh_code_2011", "pclh_name", "ward_code", "ward_code_2011", "ward_name", "ccg_code", "ccg_name", "doh_code" ], "type": "string", "description": "The dataset named GBR Health and its associated attributes." }, "EnrichmentV2AttributesGbrRegionalGeocode": { "enum": [ "latitude", "longitude", "match_level", "udprn", "uprn", "x_coordinate", "y_coordinate" ], "type": "string", "description": "The dataset named GBR Regional Geocodes its associated attributes." }, "EnrichmentV2AttributesGeocode": { "enum": [ "latitude", "longitude", "match_level" ], "type": "string", "description": "The dataset named Geocodes and its associated attributes." }, "EnrichmentV2AttributesNzlRegionalGeocodes": { "enum": [ "front_of_property_nztm_x_coordinate", "front_of_property_nztm_y_coordinate", "centroid_of_property_nztm_x_coordinate", "centroid_of_property_nztm_y_coordinate", "linz_parcel_id", "property_purpose_type", "addressable", "mesh_block_code", "territorial_authority_code", "territorial_authority_name", "regional_council_code", "regional_council_name", "general_electorate_code", "general_electorate_name", "maori_electorate_code", "maori_electorate_name", "front_of_property_latitude", "front_of_property_longitude", "centroid_of_property_latitude", "centroid_of_property_longitude", "match_level" ], "type": "string", "description": "The dataset named NZL Regional Geocodes its associated attributes." }, "EnrichmentV2AttributesPremiumLocationInsight": { "enum": [ "geocodes", "geocodes_building_xy", "geocodes_access", "time" ], "type": "string", "description": "The dataset named Premium Location Insight and its associated attributes.\n\n (The time attribute is excluded in Premium Location Insight Lite.)
" }, "EnrichmentV2AttributesUkLocationComplete": { "enum": [ "latitude", "longitude", "match_level", "udprn", "uprn", "x_coordinate", "y_coordinate" ], "type": "string", "description": "The dataset named UK Location Complete its associated attributes." }, "EnrichmentV2AttributesUkLocationEssential": { "enum": [ "latitude", "longitude", "match_level", "udprn", "uprn", "x_coordinate", "y_coordinate" ], "type": "string", "description": "The dataset named UK Location Essential its associated attributes." }, "EnrichmentV2AttributesUsaRegionalGeocodes": { "enum": [ "latitude", "longitude", "match_level", "census_tract", "census_block", "core_based_statistical_area", "congressional_district_code", "county_code" ], "type": "string", "description": "The dataset named USA Regional Geocodes its associated attributes." }, "EnrichmentV2AttributesWhat3Words": { "enum": [ "latitude", "longitude", "name", "description" ], "type": "string", "description": "The dataset named what3words and its associated attributes." }, "EnrichmentV2AusRegionalGeocodesMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" }, "sa1": { "$ref": "#/components/schemas/DatasetMetadata" }, "meshblock": { "$ref": "#/components/schemas/DatasetMetadata" }, "lga_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "lga_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_pid": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_pid": { "$ref": "#/components/schemas/DatasetMetadata" }, "geocode_level_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "geocode_level_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "geocode_type_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "geocode_type_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_elevation": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_planimetric_accuracy": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_boundary_extent": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_geocode_reliability_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "highest_level_geocode_reliability_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "confidence_level_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "confidence_level_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "2021_meshblock_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "2021_meshblock_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "2021_meshblock_match_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "2021_meshblock_match_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "2016_meshblock_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "2016_meshblock_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "2016_meshblock_match_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "2016_meshblock_match_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_type_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "primary_address_pid": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_join_type": { "$ref": "#/components/schemas/DatasetMetadata" }, "collector_district_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "collector_district_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "commonwealth_electoral_boundary_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "commonwealth_electoral_boundary_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "statistical_local_area_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "statistical_local_area_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "statistical_local_area_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_boundary_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_boundary_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_effective_start": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_effective_end": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_new_pid": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_new_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_new_effective_start": { "$ref": "#/components/schemas/DatasetMetadata" }, "state_electoral_new_effective_end": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_elevation": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_planimetric_accuracy": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_boundary_extent": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_geocode_reliability_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "address_level_geocode_reliability_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_level_longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_level_latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_level_planimetric_accuracy": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_level_boundary_extent": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_level_geocode_reliability_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "street_level_geocode_reliability_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_level_longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_level_latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_level_planimetric_accuracy": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_level_geocode_reliability_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_level_geocode_reliability_description": { "$ref": "#/components/schemas/DatasetMetadata" }, "gnaf_legal_parcel_identifier": { "$ref": "#/components/schemas/DatasetMetadata" }, "locality_class_code": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the AUS Regional Geocodes dataset." }, "EnrichmentV2DatasetAttributes": { "type": "object", "properties": { "geocodes": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesGeocode" }, "description": "The dataset named Geocodes and its associated attributes.", "nullable": true, "xml": { "name": "geocodes", "wrapped": true } }, "usa_regional_geocodes": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesUsaRegionalGeocodes" }, "description": "The dataset named USA Regional Geocodes and its associated attributes.", "nullable": true, "xml": { "name": "usa_regional_geocodes", "wrapped": true } }, "aus_regional_geocodes": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesAusRegionalGeocodes" }, "description": "The dataset named AUS Regional Geocodes and its associated attributes.", "nullable": true, "xml": { "name": "aus_regional_geocodes", "wrapped": true } }, "nzl_regional_geocodes": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesNzlRegionalGeocodes" }, "description": "The dataset named NZL Regional Geocodes and its associated attributes.", "nullable": true, "xml": { "name": "nzl_regional_geocodes", "wrapped": true } }, "uk_location_complete": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesUkLocationComplete" }, "description": "The dataset named UK Location Complete and its associated attributes.", "nullable": true, "xml": { "name": "uk_location_complete", "wrapped": true } }, "uk_location_essential": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesUkLocationEssential" }, "description": "The dataset named UK Location Essential and its associated attributes.", "nullable": true, "xml": { "name": "uk_location_essential", "wrapped": true } }, "gbr_government": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesGbrGovernment" }, "description": "The dataset named GBR Government and its associated attributes.", "nullable": true, "xml": { "name": "gbr_government", "wrapped": true } }, "gbr_health": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesGbrHealth" }, "description": "The dataset named GBR Health and its associated attributes.", "nullable": true, "xml": { "name": "gbr_health", "wrapped": true } }, "premium_location_insight": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesPremiumLocationInsight" }, "description": "The dataset named Premium Location Insight and its associated attributes.", "nullable": true, "xml": { "name": "premium_location_insight", "wrapped": true } }, "what3words": { "type": "array", "items": { "$ref": "#/components/schemas/EnrichmentV2AttributesWhat3Words" }, "description": "The dataset named what3words and its associated attributes.", "nullable": true, "xml": { "name": "what3words", "wrapped": true } } }, "additionalProperties": false, "description": "Datasets and their specific attributes." }, "EnrichmentV2DatasetAusRegionalGeocodes": { "type": "object", "properties": { "latitude": { "type": "number", "description": "Latitude of the address in degrees.", "format": "double", "nullable": true, "example": -31.067406 }, "longitude": { "type": "number", "description": "Longitude of the address in degrees.", "format": "double", "nullable": true, "example": 152.83315 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "building" }, "sa1": { "type": "string", "description": "7 digit SA1 code.", "nullable": true, "example": "1115514" }, "meshblock": { "type": "string", "description": "11 digit meshblock code.", "nullable": true, "example": "10402970000" }, "lga_code": { "type": "string", "description": "5-digit LGA code.", "nullable": true, "example": "14350" }, "lga_name": { "type": "string", "description": "The name of the Local Government Area.", "nullable": true, "example": "Kempsey (A)" }, "street_pid": { "type": "string", "description": "This is a unique street persistent identifier.", "nullable": true, "example": "NSW2838126" }, "locality_pid": { "type": "string", "description": "This is a unique locality persistent identifier.", "nullable": true, "example": "NSW4281" }, "geocode_level_code": { "type": "string", "description": "This is the geocode level code. The value is a number between 0 and 7.", "nullable": true, "example": "7" }, "geocode_level_description": { "type": "string", "description": "This is the geocode level description.", "nullable": true, "example": "Locality, street and parcel level geocodes" }, "geocode_type_code": { "type": "string", "description": "This is the geocode type code. The value is 2-4 alphabetic characters in uppercase.", "nullable": true, "example": "PC" }, "geocode_type_description": { "type": "string", "description": "This is the geocode type description.", "nullable": true, "example": "Property centroid" }, "highest_level_longitude": { "type": "number", "description": "The highest-level longitude in degrees.", "format": "double", "nullable": true, "example": 152.83315 }, "highest_level_latitude": { "type": "number", "description": "The highest-level latitude in degrees.", "format": "double", "nullable": true, "example": -31.067406 }, "highest_level_elevation": { "type": "string", "description": "The highest-level elevation.", "nullable": true }, "highest_level_planimetric_accuracy": { "type": "string", "description": "The highest-level planimetric accuracy.", "nullable": true }, "highest_level_boundary_extent": { "type": "string", "description": "The highest-level boundary extent.", "nullable": true }, "highest_level_geocode_reliability_code": { "type": "string", "description": "The highest-level geocode reliability code.", "nullable": true, "example": "2" }, "highest_level_geocode_reliability_description": { "type": "string", "description": "The highest-level geocode reliability description.", "nullable": true, "example": "Geocode accuracy sufficient to place centroid within address site boundary" }, "confidence_level_code": { "type": "string", "description": "This is the confidence level code. The value is numerical.", "nullable": true, "example": "2" }, "confidence_level_description": { "type": "string", "description": "This is the confidence level descriptor. The value is alphabetic.", "nullable": true, "example": "All three contributors have supplied an identical address" }, "2021_meshblock_id": { "type": "string", "description": "The 2021 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.", "nullable": true, "example": "MB2110402970000" }, "2021_meshblock_code": { "type": "string", "description": "The 11-digit 2021 version of the Mesh Block Code.", "nullable": true, "example": "10402970000" }, "2021_meshblock_match_code": { "type": "string", "description": "The code for the level of matching to 2021 Mesh Blocks.", "nullable": true, "example": "1" }, "2021_meshblock_match_description": { "type": "string", "description": "The description of the 2021 Mesh Block match level.", "nullable": true, "example": "Parcel level match" }, "2016_meshblock_id": { "type": "string", "description": "The 2016 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.", "nullable": true, "example": "MB1610402970000" }, "2016_meshblock_code": { "type": "string", "description": "The 11-digit 2016 version of the Mesh Block Code.", "nullable": true, "example": "10402970000" }, "2016_meshblock_match_code": { "type": "string", "description": "The code for the level of matching to 2016 Mesh Blocks.", "nullable": true, "example": "1" }, "2016_meshblock_match_description": { "type": "string", "description": "The description of the 2016 Mesh Block match level.", "nullable": true, "example": "Parcel level match" }, "address_type_code": { "type": "string", "description": "Returns the Address Type, indicating if the address is a Primary or Secondary address. If the Primary/Secondary relationship does not exist, then this element would be blank, otherwise the possible values are P and S: P:PrimaryAddress; S:SecondaryAddress.", "nullable": true }, "primary_address_pid": { "type": "string", "description": "This element will only be populated if the input address is a secondary address. In that case, this element would contain the PID of the primary address.", "nullable": true }, "address_join_type": { "type": "string", "description": "Returns the JoinType Code. The possible values are 1 or 2: 1:Both parent and child have the same root address; 2: Parent and child may or may not have the same root address.", "nullable": true }, "collector_district_id": { "type": "string", "description": "This is a unique Collector District persistent identifier.", "nullable": true, "example": "NSW1081403" }, "collector_district_code": { "type": "string", "description": "This is the Collector District Code.", "nullable": true, "example": "1081403" }, "commonwealth_electoral_boundary_id": { "type": "string", "description": "This is a unique Commonwealth Electoral Boundary persistent identifier.", "nullable": true, "example": "NSW32" }, "commonwealth_electoral_boundary_name": { "type": "string", "description": "This is the Commonwealth Electoral Boundary name.", "nullable": true, "example": "COWPER" }, "statistical_local_area_id": { "type": "string", "description": "This is a Statistical Local Area persistent identifier.", "nullable": true, "example": "NSW125104350" }, "statistical_local_area_code": { "type": "string", "description": "9-digit SLA code.", "nullable": true, "example": "125104350" }, "statistical_local_area_name": { "type": "string", "description": "This is a Statistical Local Area name.", "nullable": true, "example": "KEMPSEY (A)" }, "state_electoral_boundary_id": { "type": "string", "description": "This is a State Electoral Boundary persistent identifier.", "nullable": true, "example": "NSW231" }, "state_electoral_boundary_name": { "type": "string", "description": "This is a State Electoral Boundary name.", "nullable": true, "example": "OXLEY" }, "state_electoral_effective_start": { "type": "string", "description": "This is the date that the electorate becomes effective.", "nullable": true, "example": "24/03/2007 00:00:00" }, "state_electoral_effective_end": { "type": "string", "description": "This is the end date when electorate is no longer in effect.", "nullable": true, "example": "28/03/2015 00:00:00" }, "state_electoral_new_pid": { "type": "string", "description": "This is the State Electoral Boundary identifier for new electorate that will be in effect.", "nullable": true, "example": "NSW242" }, "state_electoral_new_name": { "type": "string", "description": "This is the State Electoral Boundary name for new electorate that will be in effect.", "nullable": true, "example": "OXLEY" }, "state_electoral_new_effective_start": { "type": "string", "description": "This is the start date that the new electorate will become effective.", "nullable": true, "example": "28/03/2015 00:00:00" }, "state_electoral_new_effective_end": { "type": "string", "description": "This is the end date when the new electorate will no longer be in effect.", "nullable": true }, "address_level_longitude": { "type": "number", "description": "The address-level longitude in degrees.", "format": "double", "nullable": true, "example": 152.83315 }, "address_level_latitude": { "type": "number", "description": "The address-level latitude in degrees.", "format": "double", "nullable": true, "example": -31.067406 }, "address_level_elevation": { "type": "string", "description": "The address-level elevation.", "nullable": true }, "address_level_planimetric_accuracy": { "type": "string", "description": "The address-level planimetric accuracy.", "nullable": true }, "address_level_boundary_extent": { "type": "string", "description": "The address-level boundary extent.", "nullable": true }, "address_level_geocode_reliability_code": { "type": "string", "description": "The address-level geocode reliability code.", "nullable": true, "example": "2" }, "address_level_geocode_reliability_description": { "type": "string", "description": "The address-level geocode reliability description.", "nullable": true, "example": "Geocode accuracy sufficient to place centroid within address site boundary" }, "street_level_longitude": { "type": "number", "description": "The street-level longitude in degrees.", "format": "double", "nullable": true, "example": 152.8311 }, "street_level_latitude": { "type": "number", "description": "The street-level latitude in degrees.", "format": "double", "nullable": true, "example": -31.062723 }, "street_level_planimetric_accuracy": { "type": "string", "description": "The street-level planimetric accuracy.", "nullable": true }, "street_level_boundary_extent": { "type": "string", "description": "The street-level boundary extent.", "nullable": true, "example": "651" }, "street_level_geocode_reliability_code": { "type": "string", "description": "The street-level geocode reliability code. The value of this is either “4”, or blank.", "nullable": true, "example": "4" }, "street_level_geocode_reliability_description": { "type": "string", "description": "The street-level geocode reliability description. If the reliability code is “4”, this is “Geocode accuracy sufficient to associate address site with a unique road feature”.", "nullable": true, "example": "Geocode accuracy sufficient to associate address site with a unique road feature" }, "locality_level_longitude": { "type": "number", "description": "The locality-level longitude in degrees.", "format": "double", "nullable": true, "example": 152.82999 }, "locality_level_latitude": { "type": "number", "description": "The locality-level latitude in degrees.", "format": "double", "nullable": true, "example": -31.059824 }, "locality_level_planimetric_accuracy": { "type": "string", "description": "The locality-level planimetric accuracy.", "nullable": true }, "locality_level_geocode_reliability_code": { "type": "string", "description": "The locality-level geocode reliability code. The value of this is either “5”, “6”, or blank.", "nullable": true, "example": "5" }, "locality_level_geocode_reliability_description": { "type": "string", "description": "The locality-level geocode reliability description.", "nullable": true, "example": "Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood" }, "gnaf_legal_parcel_identifier": { "type": "string", "description": "The Legal Parcel Id field is populated with the cadastral information using the same concatenations (where applicable) as adopted for the Jurisdiction Id used in the Cadastre theme (CAD table) of the CadLite product.", "nullable": true, "example": "B/366584" }, "locality_class_code": { "type": "string", "description": "Describes the class of locality (e.g. Gazetted, topographic feature, indigenous location and etc.).", "nullable": true, "example": "G" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the AUS Regional Geocodes dataset." }, "EnrichmentV2DatasetGbrGovernment": { "type": "object", "properties": { "eer_code": { "type": "string", "description": "European Electoral Region Code.", "nullable": true, "example": "E15000007" }, "eer_code_pre_2011": { "type": "string", "description": "European Electoral Region Code Pre-2011.", "nullable": true, "example": "07" }, "eer_name": { "type": "string", "description": "European Electoral Region Name.", "nullable": true, "example": "London" }, "gor_code": { "type": "string", "description": "Government Office for Region Code.", "nullable": true, "example": "E12000007" }, "gor_code_pre_2011": { "type": "string", "description": "Government Office for Region Code Pre-2011.", "nullable": true, "example": "H" }, "gor_name": { "type": "string", "description": "Government Office for Region Name.", "nullable": true, "example": "London" }, "lea_code": { "type": "string", "description": "Local Education Authority Code.", "nullable": true, "example": "210" }, "lea_name": { "type": "string", "description": "Local Education Authority Name.", "nullable": true, "example": "Southwark" }, "la_code": { "type": "string", "description": "Local Authority Code.", "nullable": true, "example": "E09000028" }, "la_code_pre_2011": { "type": "string", "description": "Local Authority Code Pre-2011.", "nullable": true, "example": "00BE" }, "la_name": { "type": "string", "description": "Local Authority Name.", "nullable": true, "example": "Southwark" }, "ward_code": { "type": "string", "description": "Local Authority Ward Code.", "nullable": true, "example": "E05011095" }, "ward_code_pre_2011": { "type": "string", "description": "Local Authority Ward Code Pre-2011.", "nullable": true, "example": "00AXGN" }, "ward_name": { "type": "string", "description": "Local Authority Ward Name.", "nullable": true, "example": "Borough & Bankside" }, "cens_out_area": { "type": "string", "description": "Census Output Area.", "nullable": true, "example": "E00019790" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the GBR Government dataset." }, "EnrichmentV2DatasetGbrHealth": { "type": "object", "properties": { "authority_code": { "type": "string", "description": "NHS Authority Code.", "nullable": true, "example": "Q36" }, "authority_code_2011": { "type": "string", "description": "NHS Authority Code 2011.", "nullable": true, "example": "E18000007" }, "authority_name": { "type": "string", "description": "NHS Authority Name.", "nullable": true, "example": "London" }, "pclh_code": { "type": "string", "description": "Primary Care/Local Health Code.", "nullable": true, "example": "5LE" }, "pclh_code_2011": { "type": "string", "description": "Primary Care/Local Health Code 2011.", "nullable": true, "example": "E16000059" }, "pclh_name": { "type": "string", "description": "Primary Care/Local Health Name.", "nullable": true, "example": "Southwark" }, "ward_code": { "type": "string", "description": "Local Authority Ward Code.", "nullable": true, "example": "E05011095" }, "ward_code_2011": { "type": "string", "description": "Local Authority Ward Code 2011.", "nullable": true, "example": "E05011095" }, "ward_name": { "type": "string", "description": "Local Authority Ward Name.", "nullable": true, "example": "Borough & Bankside" }, "ccg_code": { "type": "string", "description": "CCG Current Area Code.", "nullable": true, "example": "E38000244" }, "ccg_name": { "type": "string", "description": "CCG Current Area Name.", "nullable": true, "example": "NHS South East London CCG" }, "doh_code": { "type": "string", "description": "CCG Former/DH Area Code.", "nullable": true, "example": "72Q" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the GBR Health dataset." }, "EnrichmentV2DatasetGbrRegionalGeocodes": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude.", "format": "double", "nullable": true, "example": 51.501427 }, "longitude": { "type": "number", "description": "The longitude.", "format": "double", "nullable": true, "example": -0.104257 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Building" }, "udprn": { "type": "string", "description": "The udprn.", "nullable": true, "example": "55244256" }, "uprn": { "type": "string", "description": "The uprn.", "nullable": true, "example": "010091977422" }, "x_coordinate": { "type": "number", "description": "The X coordinate.", "format": "double", "nullable": true, "example": 531677.94 }, "y_coordinate": { "type": "number", "description": "The Y coordinate.", "format": "double", "nullable": true, "example": 179757.6 } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the GBR Regional Geocodes dataset." }, "EnrichmentV2DatasetGeocodes": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude.", "format": "double", "nullable": true, "example": 52.9413 }, "longitude": { "type": "number", "description": "The longitude.", "format": "double", "nullable": true, "example": 1.16312 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Premises" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the Geocodes dataset." }, "EnrichmentV2DatasetKeys": { "required": [ "global_address_key" ], "type": "object", "properties": { "global_address_key": { "minLength": 1, "type": "string", "description": "A unique Experian identifier.", "example": "aWQ9fDEgQXVkcmV5IFphcHAgRHJpdmV8SHVkc29ufEplcnNleSBDaXR5LCBOSiAwNzMwNX5mb3JtYXRJZD0xMjM0NX5RTD05fmdlbz0w" } }, "additionalProperties": false, "description": "Keys you can use to search datasets." }, "EnrichmentV2DatasetNzlRegionalGeocodes": { "type": "object", "properties": { "front_of_property_nztm_x_coordinate": { "type": "number", "description": "The Geocode 'X' coordinate for the front of the building.", "format": "double", "nullable": true, "example": 1757352.8 }, "front_of_property_nztm_y_coordinate": { "type": "number", "description": "The Geocode 'Y' coordinate for the front of the building.", "format": "double", "nullable": true, "example": 5920390.5 }, "centroid_of_property_nztm_x_coordinate": { "type": "number", "description": "The Geocode 'X' coordinate for the centre of the property.", "format": "double", "nullable": true, "example": 1757328.4 }, "centroid_of_property_nztm_y_coordinate": { "type": "number", "description": "The Geocode 'Y' coordinate for the centre of the property.", "format": "double", "nullable": true, "example": 5920400 }, "linz_parcel_id": { "type": "string", "description": "This is a unique identifier of the address record.", "nullable": true, "example": "5047052" }, "property_purpose_type": { "type": "string", "description": "The type of property, the possible values are: Business, Farm, Holiday Home, Residential or Empty section.", "nullable": true, "example": "Business" }, "addressable": { "type": "string", "description": "This defines whether the address is deliverable or not. The possible values are \"Y\" or \"N\".", "nullable": true, "example": "N" }, "mesh_block_code": { "type": "string", "description": "The unique identifier assigned to each Mesh Block.", "nullable": true, "example": "434000" }, "territorial_authority_code": { "type": "string", "description": "The unique identifier assigned to the Territorial Authority.", "nullable": true, "example": "76" }, "territorial_authority_name": { "type": "string", "description": "The name assigned to the Territorial Authority.", "nullable": true, "example": "Auckland" }, "regional_council_code": { "type": "string", "description": "The unique identifier assigned to the Regional Council.", "nullable": true, "example": "2" }, "regional_council_name": { "type": "string", "description": "The name assigned to the Regional Council.", "nullable": true, "example": "Auckland Region" }, "general_electorate_code": { "type": "string", "description": "The unique identifier assigned to the General Electorate.", "nullable": true, "example": "001" }, "general_electorate_name": { "type": "string", "description": "The name assigned to the General Electorate.", "nullable": true, "example": "Auckland Central" }, "maori_electorate_code": { "type": "string", "description": "The unique identifier assigned to the Maori Electorate.", "nullable": true, "example": "3" }, "maori_electorate_name": { "type": "string", "description": "The name assigned to the Maori Electorate.", "nullable": true, "example": "Tamaki Makaurau" }, "front_of_property_latitude": { "type": "number", "description": "The latitude for the front of the building.", "format": "double", "nullable": true, "example": -36.849308 }, "front_of_property_longitude": { "type": "number", "description": "The longitude for the front of the building.", "format": "double", "nullable": true, "example": 174.76492 }, "centroid_of_property_latitude": { "type": "number", "description": "The latitude for the centre of the property.", "format": "double", "nullable": true, "example": -36.849228 }, "centroid_of_property_longitude": { "type": "number", "description": "The longitude for the centre of the property.", "format": "double", "nullable": true, "example": 174.76465 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Building" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the NZL Regional Geocodes dataset." }, "EnrichmentV2DatasetPremiumLocationInsight": { "type": "object", "properties": { "geocodes": { "$ref": "#/components/schemas/PremiumLocationInsightGeocodes" }, "geocodes_building_xy": { "$ref": "#/components/schemas/PremiumLocationInsightGeocodesBuildingXy" }, "geocodes_access": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumLocationInsightGeocodesAccess" }, "description": "Access geocode for the specified address.", "nullable": true, "xml": { "name": "geocodes_access", "wrapped": true } }, "time": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumLocationInsightTime" }, "description": "Time zone information returned based on a specified address. (This attribute is excluded in Premium Location Insight Lite.)", "nullable": true, "xml": { "name": "time", "wrapped": true } } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the Premium Location Insight dataset." }, "EnrichmentV2DatasetUkLocationComplete": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude.", "format": "double", "nullable": true, "example": 51.50112 }, "longitude": { "type": "number", "description": "The longitude.", "format": "double", "nullable": true, "example": -0.1041234 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Building" }, "udprn": { "type": "string", "description": "Specifies the UDPRN for the specified address.", "nullable": true, "example": "55244256" }, "uprn": { "type": "string", "description": "Specifies the UPRN for the specified address.", "nullable": true, "example": "010091977422" }, "x_coordinate": { "type": "number", "description": "The x coordinate.", "format": "double", "nullable": true, "example": 531677.94 }, "y_coordinate": { "type": "number", "description": "The y coordinate.", "format": "double", "nullable": true, "example": 179757.6 } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the UK Location Complete dataset." }, "EnrichmentV2DatasetUkLocationEssential": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude.", "format": "double", "nullable": true, "example": 51.50112 }, "longitude": { "type": "number", "description": "The longitude.", "format": "double", "nullable": true, "example": -0.1041234 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Building" }, "udprn": { "type": "string", "description": "The UDPRN.", "nullable": true, "example": "55244256" }, "uprn": { "type": "string", "description": "The UPRN.", "nullable": true, "example": "010091977422" }, "x_coordinate": { "type": "number", "description": "The x coordinate.", "format": "double", "nullable": true, "example": 531677.94 }, "y_coordinate": { "type": "number", "description": "The y coordinate.", "format": "double", "nullable": true, "example": 179757.6 } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the UK Location Essential dataset." }, "EnrichmentV2DatasetUsaRegionalGeocodes": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude.", "format": "double", "nullable": true, "example": 33.693283 }, "longitude": { "type": "number", "description": "The longitude.", "format": "double", "nullable": true, "example": -117.87428 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Street" }, "census_tract": { "type": "string", "description": "Geographical region defined by US Census Bureau for the purpose of taking a census (6 digits).", "nullable": true, "example": "050210" }, "census_block": { "type": "string", "description": "Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract (4 digits).", "nullable": true, "example": "2025" }, "core_based_statistical_area": { "type": "string", "description": "Geographical area maintained by US Office of Management and Budget (OMB) which consists of one or more counties anchored by an urban center.\nCBSAs are categorized as Metropolitan (at least one urbanized area of 50,000+ inhabitants) or Micropolitan (at least one urban cluster of between 10,000 and 50,000 inhabitants);\nthese are also referred to as MSAs (5 digits).", "nullable": true, "example": "12060" }, "congressional_district_code": { "type": "string", "description": "US Federal Information Processing Standards (FIPS) codes to identify US electoral divisions (7 digits). The first two digits represent the state,\nthe second two digits represent the congressional district, and the final three digits designate the number of the Congress.", "nullable": true, "example": "1307116" }, "county_code": { "type": "string", "description": "County code within a US state or possession (3 digits).", "nullable": true, "example": "135" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the USA Regional Geocodes dataset." }, "EnrichmentV2DatasetWhat3Words": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude.", "format": "double", "nullable": true, "example": 51.75117 }, "longitude": { "type": "number", "description": "The longitude.", "format": "double", "nullable": true, "example": -1.24623 }, "name": { "type": "string", "description": "The what3words location.", "nullable": true, "example": "pretty.needed.chill" }, "description": { "type": "string", "description": "The nearest place", "nullable": true, "example": "near Oxford, Oxfordshire" } }, "additionalProperties": false, "description": "Enrichment attributes that can be returned, based on the what3words dataset." }, "EnrichmentV2GbrGovernmentMetadata": { "type": "object", "properties": { "eer_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "eer_code_pre_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "eer_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "gor_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "gor_code_pre_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "gor_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "lea_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "lea_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "la_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "la_code_pre_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "la_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "ward_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "ward_code_pre_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "ward_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "cens_out_area": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the GBR Government dataset." }, "EnrichmentV2GbrHealthMetadata": { "type": "object", "properties": { "authority_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "authority_code_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "authority_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "pclh_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "pclh_code_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "pclh_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "ward_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "ward_code_2011": { "$ref": "#/components/schemas/DatasetMetadata" }, "ward_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "ccg_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "ccg_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "doh_code": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the GBR Health dataset." }, "EnrichmentV2GbrRegionalGeocodesMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" }, "udprn": { "$ref": "#/components/schemas/DatasetMetadata" }, "uprn": { "$ref": "#/components/schemas/DatasetMetadata" }, "x_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "y_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the GBR Regional Geocodes dataset." }, "EnrichmentV2GeocodesMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the Geocodes dataset." }, "EnrichmentV2Metadata": { "type": "object", "properties": { "code": { "type": "string", "description": "Response-level metadata code.", "nullable": true, "example": "S200" }, "message": { "type": "string", "description": "Response-level metadata message.", "nullable": true, "example": "Success" }, "detail": { "type": "string", "description": "Response-level metadata detail.", "nullable": true, "example": "All requested attribute(s) retrieved." }, "datasets": { "$ref": "#/components/schemas/EnrichmentV2MetadataDatasets" } }, "additionalProperties": false, "description": "The metadata model." }, "EnrichmentV2MetadataDatasets": { "type": "object", "properties": { "geocodes": { "$ref": "#/components/schemas/EnrichmentV2GeocodesMetadata" }, "usa_regional_geocodes": { "$ref": "#/components/schemas/EnrichmentV2UsaRegionalGeocodesMetadata" }, "aus_regional_geocodes": { "$ref": "#/components/schemas/EnrichmentV2AusRegionalGeocodesMetadata" }, "nzl_regional_geocodes": { "$ref": "#/components/schemas/EnrichmentV2NzlRegionalGeocodesMetadata" }, "uk_location_complete": { "$ref": "#/components/schemas/EnrichmentV2UkLocationCompleteMetadata" }, "uk_location_essential": { "$ref": "#/components/schemas/EnrichmentV2UkLocationEssentialMetadata" }, "gbr_government": { "$ref": "#/components/schemas/EnrichmentV2GbrGovernmentMetadata" }, "gbr_health": { "$ref": "#/components/schemas/EnrichmentV2GbrHealthMetadata" }, "premium_location_insight": { "$ref": "#/components/schemas/EnrichmentV2PremiumLocationInsightMetadata" }, "what3words": { "$ref": "#/components/schemas/EnrichmentV2What3WordsMetadata" } }, "additionalProperties": false, "description": "The dataset name and related attributes." }, "EnrichmentV2NzlRegionalGeocodesMetadata": { "type": "object", "properties": { "front_of_property_nztm_x_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "front_of_property_nztm_y_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "centroid_of_property_nztm_x_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "centroid_of_property_nztm_y_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "linz_parcel_id": { "$ref": "#/components/schemas/DatasetMetadata" }, "property_purpose_type": { "$ref": "#/components/schemas/DatasetMetadata" }, "addressable": { "$ref": "#/components/schemas/DatasetMetadata" }, "mesh_block_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "territorial_authority_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "territorial_authority_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "regional_council_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "regional_council_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "general_electorate_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "general_electorate_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "maori_electorate_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "maori_electorate_name": { "$ref": "#/components/schemas/DatasetMetadata" }, "front_of_property_latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "front_of_property_longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "centroid_of_property_latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "centroid_of_property_longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the NZL Regional Geocodes dataset." }, "EnrichmentV2PremiumLocationInsightMetadata": { "type": "object", "properties": { "geocodes": { "$ref": "#/components/schemas/DatasetMetadata" }, "geocodes_building_xy": { "$ref": "#/components/schemas/DatasetMetadata" }, "geocodes_access": { "$ref": "#/components/schemas/DatasetMetadata" }, "time": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the Premium Location Insight dataset.\n\n (The time attribute is excluded in Premium Location Insight Lite.)
" }, "EnrichmentV2Request": { "required": [ "attributes", "keys" ], "type": "object", "properties": { "country_iso": { "maxLength": 3, "minLength": 0, "type": "string", "description": "The 3-letter ISO country code.", "nullable": true }, "keys": { "$ref": "#/components/schemas/EnrichmentV2DatasetKeys" }, "attributes": { "$ref": "#/components/schemas/EnrichmentV2DatasetAttributes" } }, "additionalProperties": false, "description": "The request model.", "xml": { "name": "request" } }, "EnrichmentV2Response": { "type": "object", "properties": { "reference_id": { "type": "string", "description": "If you chose to submit a \"Reference-Id\" in the response body, the value will be returned with the response.", "nullable": true }, "transaction_id": { "type": "string", "description": "Unique Experian-assigned transaction identifier.", "nullable": true, "example": "ab123ab1-abc1-1234-abcd-ab1a123a1a12" }, "error": { "$ref": "#/components/schemas/ResponseError" }, "result": { "$ref": "#/components/schemas/EnrichmentV2Result" }, "metadata": { "$ref": "#/components/schemas/EnrichmentV2Metadata" } }, "additionalProperties": false, "description": "The response model.", "xml": { "name": "response" } }, "EnrichmentV2Result": { "type": "object", "properties": { "geocodes": { "$ref": "#/components/schemas/EnrichmentV2DatasetGeocodes" }, "usa_regional_geocodes": { "$ref": "#/components/schemas/EnrichmentV2DatasetUsaRegionalGeocodes" }, "aus_regional_geocodes": { "$ref": "#/components/schemas/EnrichmentV2DatasetAusRegionalGeocodes" }, "nzl_regional_geocodes": { "$ref": "#/components/schemas/EnrichmentV2DatasetNzlRegionalGeocodes" }, "uk_location_complete": { "$ref": "#/components/schemas/EnrichmentV2DatasetUkLocationComplete" }, "uk_location_essential": { "$ref": "#/components/schemas/EnrichmentV2DatasetUkLocationEssential" }, "gbr_government": { "$ref": "#/components/schemas/EnrichmentV2DatasetGbrGovernment" }, "gbr_health": { "$ref": "#/components/schemas/EnrichmentV2DatasetGbrHealth" }, "premium_location_insight": { "$ref": "#/components/schemas/EnrichmentV2DatasetPremiumLocationInsight" }, "what3words": { "$ref": "#/components/schemas/EnrichmentV2DatasetWhat3Words" } }, "additionalProperties": false, "description": "Details about the result. Includes the enriched data." }, "EnrichmentV2UkLocationCompleteMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" }, "udprn": { "$ref": "#/components/schemas/DatasetMetadata" }, "uprn": { "$ref": "#/components/schemas/DatasetMetadata" }, "x_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "y_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the UK Location Complete dataset." }, "EnrichmentV2UkLocationEssentialMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" }, "udprn": { "$ref": "#/components/schemas/DatasetMetadata" }, "uprn": { "$ref": "#/components/schemas/DatasetMetadata" }, "x_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" }, "y_coordinate": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the UK Location Essential dataset." }, "EnrichmentV2UsaRegionalGeocodesMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "match_level": { "$ref": "#/components/schemas/DatasetMetadata" }, "census_tract": { "$ref": "#/components/schemas/DatasetMetadata" }, "census_block": { "$ref": "#/components/schemas/DatasetMetadata" }, "core_based_statistical_area": { "$ref": "#/components/schemas/DatasetMetadata" }, "congressional_district_code": { "$ref": "#/components/schemas/DatasetMetadata" }, "county_code": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the USA Regional Geocodes dataset." }, "EnrichmentV2What3WordsMetadata": { "type": "object", "properties": { "latitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "longitude": { "$ref": "#/components/schemas/DatasetMetadata" }, "name": { "$ref": "#/components/schemas/DatasetMetadata" }, "description": { "$ref": "#/components/schemas/DatasetMetadata" } }, "additionalProperties": false, "description": "Attribute-level metadata for the what3words dataset." }, "PremiumLocationInsightGeocodes": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude of the property.", "format": "double", "nullable": true, "example": 52.9413 }, "longitude": { "type": "number", "description": "The longitude of the property.", "format": "double", "nullable": true, "example": 1.16312 }, "match_level": { "type": "string", "description": "Specifies the accuracy of the coordinates for the specified address.", "nullable": true, "example": "Building" } }, "additionalProperties": false, "description": "Geocode attributes for the specified address." }, "PremiumLocationInsightGeocodesAccess": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude of access geocode.", "format": "double", "nullable": true, "example": 52.9413 }, "longitude": { "type": "number", "description": "The longitude of access geocode.", "format": "double", "nullable": true, "example": 1.16312 } }, "additionalProperties": false, "description": "Access geocode for the specified address." }, "PremiumLocationInsightGeocodesBuildingXy": { "type": "object", "properties": { "x_coordinate": { "type": "number", "description": "The Geocode 'X' coordinate for the centre of the property.", "format": "double", "nullable": true, "example": 152718.84 }, "y_coordinate": { "type": "number", "description": "The Geocode 'Y' coordinate for the centre of the property.", "format": "double", "nullable": true, "example": 529726.56 } }, "additionalProperties": false, "description": "Building XY coordinate for the specified address." }, "PremiumLocationInsightReferenceTime": { "type": "object", "properties": { "tag": { "type": "string", "description": "Time zone applicable based on current timestamp.", "nullable": true, "example": "EET" }, "standard_offset": { "type": "string", "description": "Standard offset returned based on current timestamp.", "nullable": true, "example": "02:00:00" }, "daylight_savings": { "type": "string", "description": "Daylight savings returned based on current timestamp.", "nullable": true, "example": "00:00:00" }, "sunrise": { "type": "string", "description": "Sunrise time at the given time zone based on current timestamp.", "nullable": true, "example": "2023-04-07T05:38:08.767292+02:00" }, "sunset": { "type": "string", "description": "Sunset time at the given time zone based on current timestamp.", "nullable": true, "example": "2023-04-07T18:16:40.8507771+02:00" } }, "additionalProperties": false, "description": "Time zone information returned based on current timestamp." }, "PremiumLocationInsightTime": { "type": "object", "properties": { "time_zone_id": { "type": "string", "description": "Time zone id.", "nullable": true, "example": "Africa/Cairo" }, "generic": { "type": "string", "description": "Generic time zone name.", "nullable": true, "example": "Eastern European Time" }, "standard": { "type": "string", "description": "Standard time zone name.", "nullable": true, "example": "Eastern European Standard Time" }, "daylight": { "type": "string", "description": "Daylight time zone name.", "nullable": true, "example": "Eastern European Summer Time" }, "reference_time": { "$ref": "#/components/schemas/PremiumLocationInsightReferenceTime" }, "time_transition": { "type": "array", "items": { "$ref": "#/components/schemas/PremiumLocationInsightTimeTransition" }, "description": "Daylight savings time (DST) transitions information returned based on a specified address.", "nullable": true, "xml": { "name": "time_transition", "wrapped": true } } }, "additionalProperties": false, "description": "Time zone information returned based on a specified address." }, "PremiumLocationInsightTimeTransition": { "type": "object", "properties": { "tag": { "type": "string", "description": "Time zone applicable based on a specified UTC start time and end time.", "nullable": true, "example": "EET" }, "standard_offset": { "type": "string", "description": "Standard offset returned based on a specified UTC start time and end time.", "nullable": true, "example": "02:00:00" }, "daylight_savings": { "type": "string", "description": "Daylight savings returned based on a specified UTC start time and end time.", "nullable": true, "example": "00:00:00" }, "utc_start": { "type": "string", "description": "Starting time of this UTC offset and DST.", "nullable": true, "example": "2014-09-25T21:00:00Z" }, "utc_end": { "type": "string", "description": "Ending time of this UTC offset and DST.", "nullable": true, "example": "2023-04-27T22:00:00Z" } }, "additionalProperties": false, "description": "Daylight savings time (DST) transitions information returned based on a specified address." }, "ResponseError": { "type": "object", "properties": { "type": { "type": "string", "description": "A link to documentation that provides more details about the error you’ve encountered.", "nullable": true }, "title": { "type": "string", "description": "The title of the error.", "nullable": true, "example": "Bad Request" }, "detail": { "type": "string", "description": "A description of the error.", "nullable": true, "example": "The request body was malformed." }, "instance": { "type": "string", "description": "The endpoint that returned the error.", "nullable": true } }, "additionalProperties": false, "description": "Error model containing the error details." } }, "securitySchemes": { "OAuth2": { "type": "http", "description": "Token URL: https://sso.experianaperture.io/oauth2/aust0wkxjeKyT3HRO4x7/v1/token \n\n Flow: clientCredentials", "scheme": "Bearer", "bearerFormat": "JWT" }, "Auth-Token": { "type": "apiKey", "description": "Your unique key, called a token, that is required to submit an API request.", "name": "Auth-Token", "in": "header" }, "x-app-key": { "type": "apiKey", "description": "Alternative Auth Token header.", "name": "x-app-key", "in": "header" } } } }