--- title: "Validate an address." method: POST path: "/address/validate/v1" tags: ["Address Validation"] --- # Validate an address. `POST /address/validate/v1` ## Headers - `Reference-Id` string - `Timeout-Seconds` integer - `Add-Components` boolean - `Add-Metadata` boolean - `Add-Enrichment` boolean - `Add-ExtraMatchInfo` boolean ## Request body - AddressValidateV1Request — Used for combined Validate and Enrichment call - `country_iso` string, required — The country ISO3 code of address. - `datasets` string[], required — The datasets for address validation. - `max_suggestions` integer, nullable — The maximum number of suggestions a search request should return (should be between 1 and 100). - `components` AddressInputComponents, required — The address search input component. - `unspecified` string[], nullable — The input component collection. - `names` AddressInputComponentName[], nullable — The names component. - `forename` string, nullable — The first name. - `middlename` string, nullable — Middle initial. - `surname` string, nullable — The surname. - `locality` AddressLocalityConstrains — A class representing search locality constraints - `region` AddressRestrictionRules — A class that represents address restriction rules - `exists` boolean, nullable — Gets or sets a value indicating whether the address element is required to exist for returned addresses or required to not exist. Null value means that both records with and without such element will be returned. - `must_be` string[], nullable — Gets or sets an array of values, causing the returned result to include only records that have one of the values - `must_not_be` string[], nullable — Gets or sets an array of values, causing the returned result to include only records that exclude the values - `options` AddressNameValuePair[], nullable — Additional options. - `name` string, nullable — The name of the pair. - `value` string, nullable — The value of the pair. - `attributes` AddressFormatV1RequestAttributes — AddressFormatV1RequestAttributes used for format and enrich. - `geocodes` EnrichmentV2AttributesGeocode[], nullable — The dataset named Geocodes and its associated attributes. - `usa_regional_geocodes` EnrichmentV2AttributesUsaRegionalGeocodes[], nullable — The dataset named USA Regional Geocodes and its associated attributes. - `aus_regional_geocodes` EnrichmentV2AttributesAusRegionalGeocodes[], nullable — The dataset named AUS Regional Geocodes and its associated attributes. - `nzl_regional_geocodes` EnrichmentV2AttributesNzlRegionalGeocodes[], nullable — The dataset named NZL Regional Geocodes and its associated attributes. - `uk_location_complete` EnrichmentV2AttributesUkLocationComplete[], nullable — The dataset named UK Location Complete and its associated attributes. - `uk_location_essential` EnrichmentV2AttributesUkLocationEssential[], nullable — The dataset named UK Location Essential and its associated attributes. - `gbr_government` EnrichmentV2AttributesGbrGovernment[], nullable — The dataset named GBR Government and its associated attributes. - `gbr_health` EnrichmentV2AttributesGbrHealth[], nullable — The dataset named GBR Health and its associated attributes. - `gbr_business` EnrichmentV2AttributesGbAdditionalBusinessAddressValidate[], nullable — The dataset named GBR Business and its associated attributes. - `premium_location_insight` EnrichmentV2AttributesPremiumLocationInsight[], nullable — The dataset named Premium Location Insight and its associated attributes. - `what3words` EnrichmentV2AttributesWhat3Words[], nullable — The dataset named what3words and its associated attributes. - `gbr_location_grid` EnrichmentV2GbrLocationGrid[], nullable — The dataset named GBR Location Grid and its associated attributes. - `gbr_parliament` EnrichmentV2GbrParliament[], nullable — The dataset named GBR Parliament and its associated attributes. - `gbr_mosaic` EnrichmentV2GbrMosaic[], nullable — The dataset named GBR Mosaic and its associated attributes. - `gbr_mosaic_financial` EnrichmentV2GbrMosaicFinancial[], nullable — The dataset named GBR Mosaic Financial and its associated attributes. - `gbr_alias` EnrichmentV2GbrAlias[], nullable — The dataset named GBR Alias and its associated attributes. - `gbr_quality` EnrichmentV2GbrQuality[], nullable — The dataset named GBR Quality and its associated attributes. - `addressbase_classification` EnrichmentV2AprClassification[], nullable — The dataset named Addressbase Classification and its associated attributes. - `addressbase_cross_reference` EnrichmentV2AprCrossReference[], nullable — The dataset named Addressbase Cross Reference and its associated attributes. - `addressbase_government` EnrichmentV2AprGovernment[], nullable — The dataset named Addressbase Government and its associated attributes. - `addressbase_health` EnrichmentV2AprHealth[], nullable — The dataset named Addressbase Health and its associated attributes. - `addressbase_location_grid` EnrichmentV2AprLocationGrid[], nullable — The dataset named Addressbase Location Grid and its associated attributes. - `addressbase_parliament` EnrichmentV2AprParliament[], nullable — The dataset named Addressbase Parliament and its associated attributes. - `addressbase_quality` EnrichmentV2AprQuality[], nullable — The dataset named Addressbase Quality and its associated attributes. - `addressbase_street` EnrichmentV2AprStreet[], nullable — The dataset named Addressbase Street and its associated attributes. - `addressbase_topography` EnrichmentV2AprTopography[], nullable — The dataset named Addressbase Topography and its associated attributes. - `addressbase_voa` EnrichmentV2AprVoa[], nullable — The dataset named Addressbase Voa and its associated attributes. - `irl_mosaic` EnrichmentV2IrlMosaic[], nullable — The dataset named IRL Mosaic and its associated attributes. - `nzl_household` EnrichmentV2NzlHousehold[], nullable — The dataset named NZL Household and its associated attributes. - `nzl_mosaic` EnrichmentV2NzlMosaic[], nullable — The dataset named NZL Mosaic and its associated attributes. - `nzl_property` EnrichmentV2NzlProperty[], nullable — The dataset named NZL Property and its associated attributes. - `sgp_mosaic` EnrichmentV2SgpMosaic[], nullable — The dataset named SGP Mosaic and its associated attributes. - `layouts` string[], nullable — Custom layout name. - `layout_format` 'default' | 'address_lines' — The format of the customized address layout. ## Response `200` OK - AddressValidateV1Response — Response model for AddressValidateV1 endpoint. - `error` ResponseError — Error model containing the error details. - `type` string, nullable — A link to documentation that provides more details about the error you’ve encountered. - `title` string, nullable — The title of the error. - `detail` string, nullable — A description of the error. - `instance` string, nullable — The endpoint that returned the error. - `result` AddressValidateV1Result — Address validate V1 result. - `validation_detail` AddressValidationDetail — Address validation details. - `building_firm_name_corrected` boolean — Building or Firm name has been added or changed. - `primary_number_corrected` boolean — Primary Number has been added or changed. - `street_corrected` boolean — Street has been (non-trivially) corrected. - `rural_route_highway_contract_matched` boolean — Rural Route or Highway Contract has been matched. - `city_name_corrected` boolean — City name has been added or changed. - `city_name_alias_matched` boolean — City name has been alias matched. - `state_corrected` boolean — State or Province has been added or changed. - `zip_code_corrected` boolean — Post code has been added or corrected. - `secondary_num_retained` boolean — Secondary number has been retained. - `iden_pre_st_info_retained` boolean — Identifiable pre-street information has been retained. - `gen_pre_st_info_retained` boolean — General pre-street information has been retained. - `post_st_info_retained` boolean — Post-street information has been retained. - `global_address_key` string, nullable — The ID of the address received as part of a validation. - `more_results_available` boolean, nullable — To indicate that there are more suggestions available than the results provided. - `confidence` string, nullable — The outcome (confidence level) of the validation. - `address` Address7Lines — Seven address lines representing a formatted address for the chosen country. - `address_line_1` string, nullable — The first line of address containing a number of specific components relating to the premises and street. - `address_line_2` string, nullable — The second line of address containing a number of specific components relating to the premises and street. - `address_line_3` string, nullable — The third line of address containing a number of specific components relating to the premises and street. - `locality` string, nullable — The town, locality or suburb. - `region` string, nullable — The city, state code or province. - `postal_code` string, nullable — The post/zip code. - `country` string, nullable — The localised country name. - `addresses_formatted` AddressFormattedAddressLines[], nullable — Customized address layouts. - `layout_name` string, nullable — The address layout name. - `not_enough_lines` boolean — There are not enough address lines configured to display the whole address. - `has_truncated_lines` boolean — Truncation has occurred on one or more address lines. - `address` object, nullable — The customized address layouts in default format. - `has_missing_sub_premises` boolean — The missing subpremise attribute specifies if the address is missing a subpremise when using the verification engine.It can be ignored when using all other engines. - `address_lines` AddressLine[], nullable — The customized address layouts in address-line format. - `label` string, nullable — The label of address line. - `line` string, nullable — The text of address line. - `has_overflown_to_other_line` boolean — Indicating some address elements were lost from this line or not. - `is_truncated` boolean — Indicating truncation occurred on this line or not. - `line_content` 'none' | 'address' | 'name' | 'ancillary' | 'dataplus' — The type of address line. - `components` AddressComponent — The components that differ by country and address type. Note that parameters with blank values will not be returned. - `language` string, nullable — Address language. - `country_name` string, nullable — The name of the country where the address is located. - `country_iso_3` string, nullable — The 3-letter ISO country code. - `country_iso_2` string, nullable — The 2-letter ISO country code. - `country_iso_numeric` string, nullable — The numeric ISO country code. - `postal_code` AddressComponentPostalCode — The post code component. - `full_name` string, nullable — The full name of the postal code. - `primary` string, nullable — The primary name of the postal code. - `secondary` string, nullable — The secondary name of the postal code. - `delivery_service` AddressComponentDeliveryService — The delivery service component. - `full_name` string, nullable — The full name of the delivery service. - `service_type` string, nullable — The delivery service type. - `service_number` string, nullable — The delivery service number. - `post_centre_name` string, nullable — The delivery service post center name. - `secondary_delivery_service` AddressComponentDeliveryService — The delivery service component. - `full_name` string, nullable — The full name of the delivery service. - `service_type` string, nullable — The delivery service type. - `service_number` string, nullable — The delivery service number. - `post_centre_name` string, nullable — The delivery service post center name. - `sub_building` AddressComponentSubBuilding — The sub building component. - `name` string, nullable — The name of a building or property. - `entrance` AddressComponentSubBuildingItem — An item of sub-building information, such as a floor or entrance number or name. - `full_name` string, nullable — The full name of this subcomponent. - `type` string, nullable — The type of this subcomponent. - `value` string, nullable — The value of this subcomponent. - `floor` AddressComponentSubBuildingItem — An item of sub-building information, such as a floor or entrance number or name. - `full_name` string, nullable — The full name of this subcomponent. - `type` string, nullable — The type of this subcomponent. - `value` string, nullable — The value of this subcomponent. - `door` AddressComponentSubBuildingItem — An item of sub-building information, such as a floor or entrance number or name. - `full_name` string, nullable — The full name of this subcomponent. - `type` string, nullable — The type of this subcomponent. - `value` string, nullable — The value of this subcomponent. - `building` AddressComponentBuilding — The building component. - `building_name` string, nullable — The building name. - `secondary_name` string, nullable — The secondary building name. - `building_number` string, nullable — The building number. - `secondary_number` string, nullable — The secondary name of the building (if available). - `allotment_number` string, nullable — The allotment name where a person or property resides. - `organization` AddressComponentOrganization — The organization component. - `department_name` string, nullable — The department name within an organization. - `secondary_department_name` string, nullable — The secondary department name within an organization. - `company_name` string, nullable — The company name. - `business` AddressComponentBusinessOrganization — The business component. - `company_name` string, nullable — The company name from an additional business dataset. - `street` AddressComponentStreet — The street component. - `full_name` string, nullable — The combination of the other populated secondary street components: prefix, name, type, suffix. - `prefix` string, nullable — The street prefix only. - `name` string, nullable — The street name only. - `type` string, nullable — The street type only. - `suffix` string, nullable — The street suffix only. - `secondary_street` AddressComponentStreet — The street component. - `full_name` string, nullable — The combination of the other populated secondary street components: prefix, name, type, suffix. - `prefix` string, nullable — The street prefix only. - `name` string, nullable — The street name only. - `type` string, nullable — The street type only. - `suffix` string, nullable — The street suffix only. - `route_service` AddressComponentRouteService — The route service component. - `full_name` string, nullable — The full name of the route service. - `service_type` string, nullable — The route service type. - `service_number` string, nullable — The route service number. - `delivery_name` string, nullable — The route service delivery name. - `qualifier` string, nullable — The route service qualifier. - `locality` AddressComponentLocality — The locality component. - `region` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `sub_region` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `town` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `district` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `sub_district` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `physical_locality` AddressComponentLocality — The locality component. - `region` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `sub_region` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `town` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `district` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `sub_district` AddressComponentLocalityItem — A single place name, code and a description of its type. - `name` string, nullable — The name for this subcomponent. - `code` string, nullable — The code of this subcomponent. - `description` string, nullable — The description of this subcomponent. - `additional_elements` AddressComponentAdditionalElements — The additional elements component. - `locality` AddressComponentAdditionalLocality — The additional locality component. - `sub_region` AddressComponentAdditionalSubRegion — The additional sub region component. - `administrative_county` string, nullable — The name of the administratve county. - `former_postal_county` string, nullable — The name of the former postal county. - `traditional_county` string, nullable — The name of the traditional county. - `suggestions_key` string, nullable — The suggestions key for address suggestion refinement. - `suggestions_prompt` string, nullable — The prompt to display to the user, indicating what information they should enter next. - `suggestions` AddressSuggestion[], nullable — The collection of the suggestions that match the address validate input. - `global_address_key` string, nullable — The ID of the address received as part of a validation. - `text` string, nullable — The suggestion that should be presented to the user as a possible match to their input. - `matched` array[], nullable — A collection of the characters in the suggestion that have been matched. Integrators can use this information to highlight matched text. - integer[] - `format` string, nullable — The format URL of the suggested address. - `stepin` string, nullable — The stepin URL of the cluster of addresses. - `number_of_addresses` integer — The stepin URL of the cluster of addresses. - `dataset` string, nullable — The dataset of the suggestion. - `additional_attributes` AddressNameValuePair[], nullable — The additional attributes of the suggestion. - `name` string, nullable — The name of the pair. - `value` string, nullable — The value of the pair. - `names` string[], nullable — The additional attributes of the suggestion. - `uprn` string, nullable — The UPRN of the suggestion. - `match_type` string, nullable — Match type for verified address. - `match_confidence` string, nullable — Match confidence for verified address. - `match_info` MatchInfoFlags — Class to map validation match info flags from proweb. - `postcode_action` string, nullable — Postcode action info. - `address_action` string, nullable — Address action info. - `generic_info` string[], nullable — General match codes info. - `aus_info` string[], nullable — AUS specific match codes info. - `deu_info` string[], nullable — DEU specific match codes info. - `fra_info` string[], nullable — FRA specific match codes info. - `gbr_info` string[], nullable — GBR specific match codes info. - `nld_info` string[], nullable — NLD specific match codes info. - `nzl_info` string[], nullable — NZL specific match codes info. - `sgp_info` string[], nullable — SGP specific match codes info. - `metadata` AddressMetadata — The address metadata. - `address_info` AddressMetadataInfo — Address information. - `sources` string[], nullable — Source of address information. - `number_of_households` string, nullable — Number of households for records in GBR Not Yet Built, or multi-occupancy count of the owning delivery point for GBR Multiple Residence. - `just_built_date` string, nullable — Construction date of the record, if it has been constructed in the last 6 months (GBR specific). - `identifier` AddressMetadataInfoId — The ID metadata of formatted address. - `umrrn` string, nullable — Royal Mail's Unique Multiple Residence Reference Number, an eight-digit code linked to UDPRNs in Royal Mail's Multiple Residence dataset. - `udprn` string, nullable — Royal Mail's Unique Delivery Point Reference Number, an eight-digit code assigned to every delivery point in the Postcode Address File (PAF). - `uprn` string, nullable — Unique Property Reference Number, a unique 12-digit identifier for each land and property unit (AddressBase and AddressBase with Names). - `dpid` string, nullable — Australia Post's Delivery Point Identifier, an eight-digit number that uniquely identifies a physical location to which Australia Post delivers mail - applicable to AUS and NZL addresses. - `gnafPid` string, nullable — Geoscape Australia's Geocoded National Address File Persistent Identifier (G-NAF ID). - `paf_address_key` string, nullable — PAF Address key (GBR specific). - `hin` string, nullable — Household Identification Number (applicable for AUS addresses). - `organization_key` string, nullable — Unique 14-character key for the organization record. - `lpi_key` string, nullable — Unique 14-character key for the LPI record. - `dps` string, nullable — A two character code uniquely identifying an individual delivery point within a postcode. - `parent_uprn` string, nullable — The UPRN of the parent property associated with a record. - `building_id` string, nullable — This is a unique number which identifies each building or premises. - `barcode` AddressMetadataBarcode — Address barcode. - `delivery_point_barcode` string, nullable — The delivery point barcode (applicable for USA addresses only). - `check_digit` string, nullable — The delivery point barcode's check digit (applicable for USA addresses only). - `sort_plan_number` string, nullable — The sort plan number barcode (applicable for AUS addresses only). - `route_classification` AddressMetadataRouteClassification — Address deliverability and type indicators. - `carrier_route` string, nullable — The carrier route value (applicable for USA addresses only). - `id` string, nullable — The street identifier (applicable for AUS addresses only). - `elot` string, nullable — Contains a sequence number and an ascending/descending code. The number indicates the first occurrence of delivery made to the add-on range within the carrier route. The code indicates the approximate delivery order within the sequence number. - `roudis_id` string, nullable — This reference code provides an entry point into the ROUDIS2000 file provided by La Poste. - `address_classification` AddressMetadataAddressClassification — Address deliverability and type indicators. - `address_type` AddressMetadataAddressType — The address type. - `code` string, nullable — The code of the address type (applicable to USA, AUS and NZL addresses). - `description` string, nullable — The description of the address type (applicable to USA, AUS and NZL addresses). - `delivery_type` string, nullable — Type of mail delivery at the address. Either "business", "residential" or "mixed". - `is_deliverable` string, nullable — Indicator if the address is deliverable - applicable to NZL addresses only. - `dpv` AddressMetadataDpv — Delivery Point Validation information for the address (USA only). - `cmra_indicator` string, nullable — Indicates that the address is a private business that acts as a commercial mail-receiving agent for specific clients. - `seed_indicator` string, nullable — Seed records are control records placed by the USPS to prevent unauthorized tampering (e.g., creation of lists containing every single delivery point in a geographical region). A seed address will deactivate DPV functionality. To re-activate, please visit the Self Service Portal. - `dpv_indicator` string, nullable — Indicates whether selected address is confirmed as deliverable via DPV (Delivery Point Validation) process. For all possible values, please visit our technical documentation portal. - `footnotes` string[], nullable — USPS codes denoting DPV match levels. For a list of all possible values, please visit our technical documentation portal. - `vacancy_indicator` string, nullable — An address known to be unoccupied for over 90 days and therefore not receiving mail deliveries. - `no_stats_indicator` string, nullable — An address known to not receive mail deliveries (e.g. a house under construction). - `pbsa_indicator` string, nullable — Indicates addresses known to be Post Office Box Street Addresses (PBSA). - `lacs_indicator` string, nullable — Gets or sets the Locatable Address ConversionSystem Link Indicator. It links addresses that were converted due to USPS changes to their new addresses. This affects many rural addresses with assigned city-style names for 911 emergencies. - `lacs_code` string, nullable — Gets or sets the Locatable Address ConversionSystem Link Code. It links addresses that were converted due to USPS changes to their new addresses. This affects many rural addresses with assigned city-style names for 911 emergencies. - `urbanization` string, nullable — Gets or sets Urbanization property of the address. - `delivery_line_1` string, nullable — Gets or sets delivery line 1 of the address. - `delivery_line_2` string, nullable — Gets or sets delivery line 2 of the address. - `last_line` string, nullable — Gets or sets last line of the address. - `no_stat_reason_code` string[], nullable — Gets or sets DPV No stat reason code - `drop` string, nullable — Gets or sets DPV Drop indicator - `throwback` string, nullable — Gets or sets DPV Throwback indicator - `non_delivery_days_indicator` string, nullable — Gets or sets DPV Non Delivery Day indicator - `non_delivery_days_value` string[], nullable — Gets or sets DPV Non Delivery Week Days indicator - `no_secure_location` string, nullable — Gets or sets DPV No Secure Location indicator - `door_not_accessible` string, nullable — Gets or sets DPV Door Not Accessible indicator - `enhanced_dpv_code` string, nullable — Gets or sets Enhanced DPV Return Code - `firm_name` string, nullable — Gets or sets Firm Name field of the address. - `enrichment` AddressFormatV1ResponseEnrichment — Enrichment response object, used for format and enrich requests. - `transaction_id` string, nullable — The transaction id of the request. - `result` EnrichmentV2ResultAddressValidate — Details about the result. Includes the enriched data. - `geocodes` EnrichmentV2DatasetGeocodes — Enrichment attributes that can be returned, based on the Geocodes dataset. - `latitude` number, double, nullable — The latitude. - `longitude` number, double, nullable — The longitude. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `usa_regional_geocodes` EnrichmentV2DatasetUsaRegionalGeocodes — Enrichment attributes that can be returned, based on the USA Regional Geocodes dataset. - `latitude` number, double, nullable — The latitude. - `longitude` number, double, nullable — The longitude. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `census_tract` string, nullable — Geographical region defined by US Census Bureau for the purpose of taking a census (6 digits). - `census_block` string, nullable — Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract (4 digits). - `core_based_statistical_area` string, nullable — Geographical area maintained by US Office of Management and Budget (OMB) which consists of one or more counties anchored by an urban center. CBSAs 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); these are also referred to as MSAs (5 digits). - `congressional_district_code` string, nullable — US Federal Information Processing Standards (FIPS) codes to identify US electoral divisions (7 digits). The first two digits represent the state, the second two digits represent the congressional district, and the final three digits designate the number of the Congress. - `county_code` string, nullable — County code within a US state or possession (3 digits). - `aus_regional_geocodes` EnrichmentV2DatasetAusRegionalGeocodes — Enrichment attributes that can be returned, based on the AUS Regional Geocodes dataset. - `latitude` number, double, nullable — Latitude of the address in degrees. - `longitude` number, double, nullable — Longitude of the address in degrees. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `sa1` string, nullable — 7 digit SA1 code. - `meshblock` string, nullable — 11 digit meshblock code. - `lga_code` string, nullable — 5-digit LGA code. - `lga_name` string, nullable — The name of the Local Government Area. - `street_pid` string, nullable — This is a unique street persistent identifier. - `locality_pid` string, nullable — This is a unique locality persistent identifier. - `geocode_level_code` string, nullable — This is the geocode level code. The value is a number between 0 and 7. - `geocode_level_description` string, nullable — This is the geocode level description. - `geocode_type_code` string, nullable — This is the geocode type code. The value is 2-4 alphabetic characters in uppercase. - `geocode_type_description` string, nullable — This is the geocode type description. - `highest_level_longitude` number, double, nullable — The highest-level longitude in degrees. - `highest_level_latitude` number, double, nullable — The highest-level latitude in degrees. - `highest_level_elevation` string, nullable — The highest-level elevation. - `highest_level_planimetric_accuracy` string, nullable — The highest-level planimetric accuracy. - `highest_level_boundary_extent` string, nullable — The highest-level boundary extent. - `highest_level_geocode_reliability_code` string, nullable — The highest-level geocode reliability code. - `highest_level_geocode_reliability_description` string, nullable — The highest-level geocode reliability description. - `confidence_level_code` string, nullable — This is the confidence level code. The value is numerical. - `confidence_level_description` string, nullable — This is the confidence level descriptor. The value is alphabetic. - `2021_meshblock_id` string, nullable — 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. - `2021_meshblock_code` string, nullable — The 11-digit 2021 version of the Mesh Block Code. - `2021_meshblock_match_code` string, nullable — The code for the level of matching to 2021 Mesh Blocks. - `2021_meshblock_match_description` string, nullable — The description of the 2021 Mesh Block match level. - `2016_meshblock_id` string, nullable — 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. - `2016_meshblock_code` string, nullable — The 11-digit 2016 version of the Mesh Block Code. - `2016_meshblock_match_code` string, nullable — The code for the level of matching to 2016 Mesh Blocks. - `2016_meshblock_match_description` string, nullable — The description of the 2016 Mesh Block match level. - `address_type_code` string, nullable — 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. - `primary_address_pid` string, nullable — 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. - `address_join_type` string, nullable — 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. - `collector_district_id` string, nullable — This is a unique Collector District persistent identifier. - `collector_district_code` string, nullable — This is the Collector District Code. - `commonwealth_electoral_boundary_id` string, nullable — This is a unique Commonwealth Electoral Boundary persistent identifier. - `commonwealth_electoral_boundary_name` string, nullable — This is the Commonwealth Electoral Boundary name. - `statistical_local_area_id` string, nullable — This is a Statistical Local Area persistent identifier. - `statistical_local_area_code` string, nullable — 9-digit SLA code. - `statistical_local_area_name` string, nullable — This is a Statistical Local Area name. - `state_electoral_boundary_id` string, nullable — This is a State Electoral Boundary persistent identifier. - `state_electoral_boundary_name` string, nullable — This is a State Electoral Boundary name. - `state_electoral_effective_start` string, nullable — This is the date that the electorate becomes effective. - `state_electoral_effective_end` string, nullable — This is the end date when electorate is no longer in effect. - `state_electoral_new_pid` string, nullable — This is the State Electoral Boundary identifier for new electorate that will be in effect. - `state_electoral_new_name` string, nullable — This is the State Electoral Boundary name for new electorate that will be in effect. - `state_electoral_new_effective_start` string, nullable — This is the start date that the new electorate will become effective. - `state_electoral_new_effective_end` string, nullable — This is the end date when the new electorate will no longer be in effect. - `address_level_longitude` number, double, nullable — The address-level longitude in degrees. - `address_level_latitude` number, double, nullable — The address-level latitude in degrees. - `address_level_elevation` string, nullable — The address-level elevation. - `address_level_planimetric_accuracy` string, nullable — The address-level planimetric accuracy. - `address_level_boundary_extent` string, nullable — The address-level boundary extent. - `address_level_geocode_reliability_code` string, nullable — The address-level geocode reliability code. - `address_level_geocode_reliability_description` string, nullable — The address-level geocode reliability description. - `street_level_longitude` number, double, nullable — The street-level longitude in degrees. - `street_level_latitude` number, double, nullable — The street-level latitude in degrees. - `street_level_planimetric_accuracy` string, nullable — The street-level planimetric accuracy. - `street_level_boundary_extent` string, nullable — The street-level boundary extent. - `street_level_geocode_reliability_code` string, nullable — The street-level geocode reliability code. The value of this is either “4”, or blank. - `street_level_geocode_reliability_description` string, nullable — 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”. - `locality_level_longitude` number, double, nullable — The locality-level longitude in degrees. - `locality_level_latitude` number, double, nullable — The locality-level latitude in degrees. - `locality_level_planimetric_accuracy` string, nullable — The locality-level planimetric accuracy. - `locality_level_geocode_reliability_code` string, nullable — The locality-level geocode reliability code. The value of this is either “5”, “6”, or blank. - `locality_level_geocode_reliability_description` string, nullable — The locality-level geocode reliability description. - `gnaf_legal_parcel_identifier` string, nullable — 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. - `locality_class_code` string, nullable — Describes the class of locality (e.g. Gazetted, topographic feature, indigenous location and etc.). - `nzl_regional_geocodes` EnrichmentV2DatasetNzlRegionalGeocodes — Enrichment attributes that can be returned, based on the NZL Regional Geocodes dataset. - `front_of_property_nztm_x_coordinate` number, double, nullable — The Geocode 'X' coordinate for the front of the building. - `front_of_property_nztm_y_coordinate` number, double, nullable — The Geocode 'Y' coordinate for the front of the building. - `centroid_of_property_nztm_x_coordinate` number, double, nullable — The Geocode 'X' coordinate for the centre of the property. - `centroid_of_property_nztm_y_coordinate` number, double, nullable — The Geocode 'Y' coordinate for the centre of the property. - `linz_parcel_id` string, nullable — This is a unique identifier of the address record. - `property_purpose_type` string, nullable — The type of property, the possible values are: Business, Farm, Holiday Home, Residential or Empty section. - `addressable` string, nullable — This defines whether the address is deliverable or not. The possible values are "Y" or "N". - `mesh_block_code` string, nullable — The unique identifier assigned to each Mesh Block. - `territorial_authority_code` string, nullable — The unique identifier assigned to the Territorial Authority. - `territorial_authority_name` string, nullable — The name assigned to the Territorial Authority. - `regional_council_code` string, nullable — The unique identifier assigned to the Regional Council. - `regional_council_name` string, nullable — The name assigned to the Regional Council. - `general_electorate_code` string, nullable — The unique identifier assigned to the General Electorate. - `general_electorate_name` string, nullable — The name assigned to the General Electorate. - `maori_electorate_code` string, nullable — The unique identifier assigned to the Maori Electorate. - `maori_electorate_name` string, nullable — The name assigned to the Maori Electorate. - `front_of_property_latitude` number, double, nullable — The latitude for the front of the building. - `front_of_property_longitude` number, double, nullable — The longitude for the front of the building. - `centroid_of_property_latitude` number, double, nullable — The latitude for the centre of the property. - `centroid_of_property_longitude` number, double, nullable — The longitude for the centre of the property. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `uk_location_complete` EnrichmentV2DatasetUkLocationComplete — Enrichment attributes that can be returned, based on the UK Location Complete dataset. - `latitude` number, double, nullable — The latitude. - `longitude` number, double, nullable — The longitude. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `udprn` string, nullable — Specifies the UDPRN for the specified address. - `uprn` string, nullable — Specifies the UPRN for the specified address. - `x_coordinate` number, double, nullable — The x coordinate. - `y_coordinate` number, double, nullable — The y coordinate. - `uk_location_essential` EnrichmentV2DatasetUkLocationEssential — Enrichment attributes that can be returned, based on the UK Location Essential dataset. - `latitude` number, double, nullable — The latitude. - `longitude` number, double, nullable — The longitude. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `udprn` string, nullable — The UDPRN. - `uprn` string, nullable — The UPRN. - `x_coordinate` number, double, nullable — The x coordinate. - `y_coordinate` number, double, nullable — The y coordinate. - `gbr_government` EnrichmentV2DatasetGbrGovernment — Enrichment attributes that can be returned, based on the GBR Government dataset. - `eer_code` string, nullable — European Electoral Region Code. - `eer_code_pre_2011` string, nullable — European Electoral Region Code Pre-2011. - `eer_name` string, nullable — European Electoral Region Name. - `gor_code` string, nullable — Government Office for Region Code. - `gor_code_pre_2011` string, nullable — Government Office for Region Code Pre-2011. - `gor_name` string, nullable — Government Office for Region Name. - `lea_code` string, nullable — Local Education Authority Code. - `lea_name` string, nullable — Local Education Authority Name. - `la_code` string, nullable — Local Authority Code. - `la_code_pre_2011` string, nullable — Local Authority Code Pre-2011. - `la_name` string, nullable — Local Authority Name. - `ward_code` string, nullable — Local Authority Ward Code. - `ward_code_pre_2011` string, nullable — Local Authority Ward Code Pre-2011. - `ward_name` string, nullable — Local Authority Ward Name. - `cens_out_area` string, nullable — Census Output Area. - `gbr_business` EnrichmentV2DatasetGbAdditionalBusinessAddressValidate — Enrichment attributes that can be returned, based on the what3words dataset. - `urn` string, nullable — The latitude. - `commercial_mosaic` CommercialMosaicElements — The Commercial mosaic elements. - `group_type_code` string, nullable — The group type code. - `group_type_description` string, nullable — The group type description. - `group_code` string, nullable — The group code. - `group_description` string, nullable — The group description. - `registration` string, nullable — The longitude. - `non_limited_company_key` string, nullable — The longitude. - `phone` string, nullable — The longitude. - `number_of_employees` string, nullable — The longitude. - `standard_industry_classification` StandardIndustryClassificationElements — The standard industry classification elements of a business. - `sic_2007_code` string, nullable — The sic 2007 code. - `sic_2007_description` string, nullable — The sic 2007 description. - `thomson_code` string, nullable — The Thomson code. - `thomson_description` string, nullable — The Thomson description. - `location` LocationElements — The location elements of a business. - `code` string, nullable — The code of a business. - `description` string, nullable — The description of a business. - `small_or_home_office` boolean — Is a business small or home office one. - `gbr_health` EnrichmentV2DatasetGbrHealth — Enrichment attributes that can be returned, based on the GBR Health dataset. - `authority_code` string, nullable — NHS Authority Code. - `authority_code_2011` string, nullable — NHS Authority Code 2011. - `authority_name` string, nullable — NHS Authority Name. - `pclh_code` string, nullable — Primary Care/Local Health Code. - `pclh_code_2011` string, nullable — Primary Care/Local Health Code 2011. - `pclh_name` string, nullable — Primary Care/Local Health Name. - `ward_code` string, nullable — Local Authority Ward Code. - `ward_code_2011` string, nullable — Local Authority Ward Code 2011. - `ward_name` string, nullable — Local Authority Ward Name. - `ccg_code` string, nullable — CCG Current Area Code. - `ccg_name` string, nullable — CCG Current Area Name. - `doh_code` string, nullable — CCG Former/DH Area Code. - `premium_location_insight` EnrichmentV2DatasetPremiumLocationInsight — Enrichment attributes that can be returned, based on the Premium Location Insight dataset. - `geocodes` PremiumLocationInsightGeocodes — Geocode attributes for the specified address. - `latitude` number, double, nullable — The latitude of the property. - `longitude` number, double, nullable — The longitude of the property. - `match_level` string, nullable — Specifies the accuracy of the coordinates for the specified address. - `geocodes_building_xy` PremiumLocationInsightGeocodesBuildingXy — Building XY coordinate for the specified address. - `x_coordinate` number, double, nullable — The Geocode 'X' coordinate for the centre of the property. - `y_coordinate` number, double, nullable — The Geocode 'Y' coordinate for the centre of the property. - `geocodes_access` PremiumLocationInsightGeocodesAccess[], nullable — Access geocode for the specified address. - `latitude` number, double, nullable — The latitude of access geocode. - `longitude` number, double, nullable — The longitude of access geocode. - `time` PremiumLocationInsightTime[], nullable — Time zone information returned based on a specified address. (This attribute is excluded in Premium Location Insight Lite.) - `time_zone_id` string, nullable — Time zone id. - `generic` string, nullable — Generic time zone name. - `standard` string, nullable — Standard time zone name. - `daylight` string, nullable — Daylight time zone name. - `reference_time` PremiumLocationInsightReferenceTime — Time zone information returned based on current timestamp. - `tag` string, nullable — Time zone applicable based on current timestamp. - `standard_offset` string, nullable — Standard offset returned based on current timestamp. - `daylight_savings` string, nullable — Daylight savings returned based on current timestamp. - `sunrise` string, nullable — Sunrise time at the given time zone based on current timestamp. - `sunset` string, nullable — Sunset time at the given time zone based on current timestamp. - `time_transition` PremiumLocationInsightTimeTransition[], nullable — Daylight savings time (DST) transitions information returned based on a specified address. - `tag` string, nullable — Time zone applicable based on a specified UTC start time and end time. - `standard_offset` string, nullable — Standard offset returned based on a specified UTC start time and end time. - `daylight_savings` string, nullable — Daylight savings returned based on a specified UTC start time and end time. - `utc_start` string, nullable — Starting time of this UTC offset and DST. - `utc_end` string, nullable — Ending time of this UTC offset and DST. - `what3words` EnrichmentV2DatasetWhat3Words — Enrichment attributes that can be returned, based on the what3words dataset. - `latitude` number, double, nullable — The latitude. - `longitude` number, double, nullable — The longitude. - `name` string, nullable — The what3words location. - `description` string, nullable — The nearest place - `gbr_location_grid` EnrichmentV2GbrLocationGridResult — Response for GBR Location Grid dataset. - `postzon` EnrichmentV2GbrLocationGridPostzonResult — Response for GBR 100m Postzon Grid. - `x_coordinate` number, double, nullable — Native OS or OSNI grid-reference. - `y_coordinate` number, double, nullable — Native OS or OSNI grid-reference. - `os_x_coordinate` number, double, nullable — 100m OS Easting grid-reference. - `os_y_coordinate` number, double, nullable — 100m OS Northing grid-reference. - `latitude` number, double, nullable — WGS84 projection compatible with the GPS system and returned to six decimal places. - `longitude` number, double, nullable — WGS84 projection compatible with the GPS system and returned to six decimal places. - `os_landranger` string, nullable — OS Land-ranger format derived from OS East and OS North. - `codepoint` EnrichmentV2GbrLocationGridCodepointResult — Response for GBR CodePoint Grid. - `x_coordinate` number, double, nullable — Native OS or OSNI grid-reference. - `y_coordinate` number, double, nullable — Native OS or OSNI grid-reference. - `pqi` string, nullable — Assesses the quality of the grid based on the quality of the AddressPoints used. - `is_delivery_service` string, nullable — Value is always "Yes" or "No", depending on whether the postcode is a PO Box. - `ndp` string, nullable — Indicates the number of delivery points on PAF for the current postcode. - `ndp_pqi` string, nullable — Represents the number of matched addresses within the postcode that have the same PQI in AddressPoint as the PQI given to this postcode. - `ndp_domestic` string, nullable — Represents the number of non-PO Box delivery points with no PAF organization name. - `ndp_commercial` string, nullable — Represents the number of non-PO Box delivery points which have a PAF organization name. - `ndp_delivery_service` string, nullable — Represents the number of PO Box delivery points. - `ndp_matched` string, nullable — Represents the number of good AddressPoints after de-duplication of AddressPoints with the same coordinates. - `ndp_unmatched` string, nullable — Represents the number of Delivery Points on PAF unmatched to OS data. - `gbr_parliament` EnrichmentV2GbrParliamentResult — Response for GBR Parliament dataset. - `westminster` EnrichmentV2GbrParliamentWestminsterResult — Response for GBR Westminster Parliament. - `constituency_code` string, nullable — Official code given to the Parliamentary Constituency. - `constituency` string, nullable — Official name given to the Parliamentary Constituency. - `mp` string, nullable — Name of the MP representing their constituency. - `mp_party` string, nullable — Name of the party to which the MP belongs. - `scotland` EnrichmentV2GbrParliamentScotlandResult — Response for GBR Scottish Parliament. - `constituency_code` string, nullable — Official code given to the Scottish Parliamentary Constituency. - `constituency` string, nullable — Official name given to the Scottish Parliamentary Constituency. - `region` string, nullable — Official name given to the Scottish Parliament electoral region. - `region_code` string, nullable — Official code given to the Scottish Parliament electoral region. - `mp` string, nullable — Name of the MSP representing the constituency. - `mp_party` string, nullable — Name of the party to which the MSP belongs. - `regional_msp1` string, nullable — Name of the first MSP representing the electoral region. - `regional_msp1_party` string, nullable — Name of the party to which the first regional MSP belongs. - `regional_msp2` string, nullable — Name of the second MSP representing the electoral region. - `regional_msp2_party` string, nullable — Name of the party to which the second regional MSP belongs. - `regional_msp3` string, nullable — Name of the third MSP representing the electoral region. - `regional_msp3_party` string, nullable — Name of the party to which the third regional MSP belongs. - `regional_msp4` string, nullable — Name of the fourth MSP representing the electoral region. - `regional_msp4_party` string, nullable — Name of the party to which the fourth regional MSP belongs. - `regional_msp5` string, nullable — Name of the fifth MSP representing the electoral region. - `regional_msp5_party` string, nullable — Name of the party to which the fifth regional MSP belongs. - `regional_msp6` string, nullable — Name of the sixth MSP representing the electoral region. - `regional_msp6_party` string, nullable — Name of the party to which the sixth regional MSP belongs. - `regional_msp7` string, nullable — Name of the seventh MSP representing the electoral region. - `regional_msp7_party` string, nullable — Name of the party to which the seventh regional MSP belongs. - `gbr_mosaic` EnrichmentV2GbrMosaicResult — Response for GBR Mosaic dataset. - `household` EnrichmentV2GbrCommonElementsWithVersionResult — Response for dataset with versioning consisting of type code, type, group code and group elements. - `version` string, nullable - `type_code` string, nullable — Type Code. - `type` string, nullable — Type Name. - `group_code` string, nullable — Group Code. - `group` string, nullable — Group Name. - `postal_code` EnrichmentV2GbrCommonElementsWithVersionResult — Response for dataset with versioning consisting of type code, type, group code and group elements. - `version` string, nullable - `type_code` string, nullable — Type Code. - `type` string, nullable — Type Name. - `group_code` string, nullable — Group Code. - `group` string, nullable — Group Name. - `gbr_mosaic_financial` EnrichmentV2GbrMosaicFinancialResult — Response for GBR Mosaic Financial dataset. - `postal_code` EnrichmentV2GbrCommonElementsResult — Response for dataset consisting of type code, type, group code and group elements. - `type_code` string, nullable — Type Code. - `type` string, nullable — Type Name. - `group_code` string, nullable — Group Code. - `group` string, nullable — Group Name. - `household` EnrichmentV2GbrCommonElementsResult — Response for dataset consisting of type code, type, group code and group elements. - `type_code` string, nullable — Type Code. - `type` string, nullable — Type Name. - `group_code` string, nullable — Group Code. - `group` string, nullable — Group Name. - `gbr_alias` EnrichmentV2GbrAliasResult — Response for GBR Alias dataset. - `aliases` EnrichmentV2GbrAliasElementsResult — Response for GBR PAF. - `building_name` string, nullable — PAF Building Name Delivery Point Alias. - `also_known_as` string, nullable — PAF Also Known As Delivery Point Alias. - `department` string, nullable — PAF Department Delivery Point Alias. - `organization_description` string, nullable — PAF Organization Description Delivery Point Alias. - `organization_at_residential` string, nullable — PAF Organization Residential Delivery Point Alias. - `trading_name` string, nullable — PAF Trading Name Delivery Point Alias. - `misc` string, nullable — PAF Miscellaneous Delivery Point Alias. - `welsh_alternative` string, nullable — PAF Welsh Alternative Delivery Point Alias. - `gbr_quality` EnrichmentV2GbrQualityResult — Response for GBR Quality dataset. - `record` EnrichmentV2GbrQualityRecordResult — Response for GBR PAF Match Quality. - `address` string, nullable — PAF Quality of Address - `postal_code` string, nullable — PAF Quality of Postcode - `addressbase_classification` EnrichmentV2AprClassificationResult — Response for Addressbase Classification dataset. - `code` EnrichmentV2AprClassificationCodeResult — Response for Addressbase Classification Code. - `code` string, nullable — Code describing land use classification. - `primary` string, nullable — Description of primary classification element. - `secondary` string, nullable — Description of secondary classification element. - `tertiary` string, nullable — Description of tertiary classification element. - `quaternary` string, nullable — Description of quaternary classification element. - `record` EnrichmentV2AprClassificationRecordResult — Response for Addressbase Classification Record. - `key` string, nullable — Unique key of the classification record. - `start_date` string, nullable — Start date of classification record. - `end_date` string, nullable — End date of classification record. - `update_date` string, nullable — Last update date of classification record. - `entry_date` string, nullable — Entry date of classification record. - `scheme` EnrichmentV2AprClassificationSchemeResult — Response for Addressbase Classification Scheme. - `scheme` string, nullable — Name of the classification scheme. - `version` string, nullable — Version of the classification scheme. - `addressbase_cross_reference` EnrichmentV2AprCrossReferenceResult — Response for Addressbase Cross Reference dataset. - `addresslayer_2` EnrichmentV2AprCrossReferenceAddressLayer2Result — Response for Addressbase Cross Reference Address Layer 2. - `primary_key` string, nullable — Primary key of the record in external dataset. - `key` string, nullable — Unique key for the cross reference record. - `version` string, nullable — Version number of the source object. - `created_date` string, nullable — Date the record was created. - `update_date` string, nullable — Date the record was last changed. - `entry_date` string, nullable — Date of data entry. - `council_tax` EnrichmentV2AprCrossReferenceCouncilTaxResult — Response for Addressbase Cross Reference Council Tax. - `primary_key` string, nullable — Primary key of the record in external dataset. - `key` string, nullable — Unique key for the cross reference record. - `version` string, nullable — Version number of the source object. - `created_date` string, nullable — Date the record was created. - `update_date` string, nullable — Date the record was last changed. - `entry_date` string, nullable — Date of data entry. - `integrated_transport_network` EnrichmentV2AprCrossReferenceIntegratedTransportNetworkResult — Response for Addressbase Cross Reference Integrated Transport Network. - `primary_key` string, nullable — Primary key of the record in external dataset. - `key` string, nullable — Unique key for the cross reference record. - `version` string, nullable — Version number of the source object. - `created_date` string, nullable — Date the record was created. - `update_date` string, nullable — Date the record was last changed. - `entry_date` string, nullable — Date of data entry. - `non_domestic_rates` EnrichmentV2AprCrossReferenceNonDomesticRatesResult — Response for Addressbase Cross Reference Non Domestic Rates. - `primary_key` string, nullable — Primary key of the record in external dataset. - `key` string, nullable — Unique key for the cross reference record. - `version` string, nullable — Version number of the source object. - `created_date` string, nullable — Date the record was created. - `update_date` string, nullable — Date the record was last changed. - `entry_date` string, nullable — Date of data entry. - `topography_layer` EnrichmentV2AprCrossReferenceTopographyLayerResult — Response for Addressbase Cross Reference Topography Layer. - `primary_key` string, nullable — Primary key of the record in external dataset. - `key` string, nullable — Unique key for the cross reference record. - `version` string, nullable — Version number of the source object. - `created_date` string, nullable — Date the record was created. - `update_date` string, nullable — Date the record was last changed. - `entry_date` string, nullable — Date of data entry. - `addressbase_government` EnrichmentV2AprGovernmentResult — Response for Addressbase Government dataset. - `government` EnrichmentV2AprGovernmentElementsResult — Response for Addressbase Government Elements. - `eer_code` string, nullable — Code for European Electoral Region. - `eer_name` string, nullable — Name of European Electoral Region. - `gor_code` string, nullable — Code for Government Office Region. - `gor_name` string, nullable — Name of Government Office Region. - `lea_code` string, nullable — Code for Local Education Authority. - `lea_name` string, nullable — Name of Local Education Authority. - `la_code` string, nullable — Code for Local Authority. - `la_name` string, nullable — Name of Local Authority. - `ward_code` string, nullable — Code for Local Authority Ward. - `ward_name` string, nullable — Name of Local Authority Ward. - `cens_out_area` string, nullable — Census Area output code. - `addressbase_health` EnrichmentV2AprHealthResult — Response for Addressbase Health dataset. - `health` EnrichmentV2AprHealthElementsResult — Response for Addressbase Health Elements. - `authority_code` string, nullable — Code for NHS Authority. - `authority_name` string, nullable — Name of NHS Authority. - `pclh_code` string, nullable — Code for Primary Care Trust or Local Health Group. - `pclh_name` string, nullable — Name of Primary Care Trust or Local Health Group. - `ward_code` string, nullable — Code for Local Authority Ward. - `ward_name` string, nullable — Name of Local Authority Ward. - `ccg_code` string, nullable — Code for Clinical Commissioning Group or equivalent. - `ccg_name` string, nullable — Name of Clinical Commissioning Group or equivalent. - `doh_code` string, nullable — Department of Health area code. - `addressbase_location_grid` EnrichmentV2AprLocationGridResult — Response for Addressbase Location Grid dataset. - `blpu` EnrichmentV2AprLocationGridBlpuResult — Response for Addressbase Location Grid Blpu. - `x_coordinate` number, double, nullable — Easting coordinate of the BLPU in metres (1 cm resolution). - `y_coordinate` number, double, nullable — Northing coordinate of the BLPU in metres (1 cm resolution). - `ap_x_coordinate` number, double, nullable — Easting coordinate in 10 cm resolution, zero-padded to 8 digits. - `ap_y_coordinate` number, double, nullable — Northing coordinate in 10 cm resolution, zero-padded to 8 digits. - `latitude` number, double, nullable — Latitude of the BLPU using the ETRS89 coordinate system. - `longitude` number, double, nullable — Longitude of the BLPU using the ETRS89 coordinate system. - `rpc` string, nullable — Indicates the location type of the grid reference (e.g., visual centre, postcode-based). - `postal_code` string, nullable — The postcode associated with the BLPU. - `building` EnrichmentV2AprLocationGridBuildingResult — Response for Addressbase Location Grid Building. - `x_coordinate` number, double, nullable — Easting coordinate of the building in metres (1 cm resolution). - `y_coordinate` number, double, nullable — Northing coordinate of the building in metres (1 cm resolution). - `ap_x_coordinate` number, double, nullable — Easting coordinate in 10 cm resolution, zero-padded to 8 digits. - `ap_y_coordinate` number, double, nullable — Northing coordinate in 10 cm resolution, zero-padded to 8 digits. - `postal_code` EnrichmentV2AprLocationGridPostalCodeResult — Response for Addressbase Location Grid Postal Code. - `x_coordinate` number, double, nullable — Easting coordinate of the postcode in metres (1 cm resolution). - `y_coordinate` number, double, nullable — Northing coordinate of the postcode in metres (1 cm resolution). - `ap_x_coordinate` number, double, nullable — Easting coordinate in 10 cm resolution, zero-padded to 8 digits. - `ap_y_coordinate` number, double, nullable — Northing coordinate in 10 cm resolution, zero-padded to 8 digits. - `street` EnrichmentV2AprLocationGridStreetResult — Response for Addressbase Location Grid Street. - `x_coordinate` number, double, nullable — Easting coordinate of the street in metres (1 cm resolution). - `y_coordinate` number, double, nullable — Northing coordinate of the street in metres (1 cm resolution). - `ap_x_coordinate` number, double, nullable — Easting coordinate in 10 cm resolution, zero-padded to 8 digits. - `ap_y_coordinate` number, double, nullable — Northing coordinate in 10 cm resolution, zero-padded to 8 digits. - `addressbase_parliament` EnrichmentV2AprParliamentResult — Response for Addressbase Parliament dataset. - `westminster` EnrichmentV2AprParliamentWestminsterResult — Response for Addressbase Parliament Westminster. - `constituency_code` string, nullable — Code for Parliamentary Constituency. - `constituency` string, nullable — Name of Parliamentary Constituency. - `mp` string, nullable — Name of the MP. - `mp_party` string, nullable — Political party of the MP. - `addressbase_quality` EnrichmentV2AprQualityResult — Response for Addressbase Quality dataset. - `custodian` EnrichmentV2AprQualityCustodianResult — Response for Addressbase Quality Custodian. - `custodian` string, nullable — Name of the custodian organization. - `custodian_uprn` string, nullable — UPRN of the custodian location. - `custodian_language` string, nullable — Local language name of the custodian. - `custodian_code` string, nullable — Four-digit code identifying the custodian. - `metadata` EnrichmentV2AprQualityMetadataResult — Response for Addressbase Quality Metadata. - `coordinate_system` string, nullable — Name of the coordinate system used. - `coordinate_unit` string, nullable — Unit of measurement used. - `postal_code_type` string, nullable — Indicates small or large user postcode. - `gazetteer_name` string, nullable — Name of the dataset. - `gazetteer_scope` string, nullable — Description of dataset contents. - `linked_data` string, nullable — External sources used to update dataset. - `gazetteer_owner` string, nullable — Organization responsible for the dataset. - `metadata_date` string, nullable — Date metadata was last updated. - `classification_scheme` string, nullable — Classification scheme used in dataset. - `gazetteer_date` string, nullable — Date dataset is considered current. - `record` EnrichmentV2AprQualityRecordResult — Response for Addressbase Quality Record. - `blpu_status` string, nullable — Indicates the status of the address associated with the BLPU record. - `lpi_status` string, nullable — Indicates the status of the address associated with the LPI record. - `state` string, nullable — Indicates the current state of the BLPU. - `state_date` string, nullable — The date on which the BLPU entered its current state. - `start_date` string, nullable — The date on which the BLPU was defined. - `update_date` string, nullable — The date on which the record was last updated. - `entry_date` string, nullable — The date of data entry. - `update_frequency` string, nullable — Indicates how frequently the data is updated. - `is_official` string, nullable — Indicates the status of an address in the official street naming and numbering register. - `paf_update_date` string, nullable — The date on which a Royal Mail Delivery Point Address was last updated. - `addressbase_street` EnrichmentV2AprStreetResult — Response for Addressbase Street dataset. - `grid` EnrichmentV2AprStreetGridResult — Response for Addressbase Street Grid. - `start_x_coordinate` number, double, nullable — The Easting co-ordinate of the start point of the street. - `start_y_coordinate` number, double, nullable — The Northing co-ordinate of the start point of the street. - `end_x_coordinate` number, double, nullable — The Easting co-ordinate of the end point of the street. - `end_y_coordinate` number, double, nullable — The Northing co-ordinate of the end point of the street. - `start_latitude` number, double, nullable — Latitude of the start point of the street in accordance with the ETRS89 co-ordinate reference system. - `start_longitude` number, double, nullable — Longitude of the start point of the street in accordance with the ETRS89 co-ordinate reference system. - `end_latitude` number, double, nullable — Latitude of the end point of the street in accordance with the ETRS89 co-ordinate reference system. - `end_longitude` number, double, nullable — Longitude of the end point of the street in accordance with the ETRS89 co-ordinate reference system. - `tolerance` string, nullable — The potential variance in metres of the start and end co-ordinates of the street. - `record` EnrichmentV2AprStreetRecordResult — Response for Addressbase Street Record. - `type` string, nullable — Indicates the street type represented by the record. - `authority` string, nullable — Indicates the Street Naming and Numbering Authority or Local Highway Authority. - `classification` string, nullable — Indicates the classification of the street record. - `surface_type` string, nullable — Shows the type of surface on the street. - `state` string, nullable — Shows the current state of the street. - `state_date` string, nullable — The date on which the street entered its current state. - `version` string, nullable — Version number of the street record. - `usrn` EnrichmentV2AprStreetUsrnResult — Response for Addressbase Street Usrn. - `usrn` string, nullable — An 8-character code assigned to every street. - `usrn_match` string, nullable — Indicates how the address was matched to the USRN (manual or spatial match). - `addressbase_topography` EnrichmentV2AprTopographyResult — Response for Addressbase Topography dataset. - `topographic_ids` EnrichmentV2AprTopographyTopographicIdsResult — Response for Addressbase Topography TopographicIds. - `addresslayer_2` string, nullable — TOID of the nearest feature in OS MasterMap Address Layer 2, typically for buildings. - `topography_layer` string, nullable — TOID of the nearest topographical feature in OS MasterMap Topographic Layer. - `integrated_transport_network` string, nullable — TOID of the nearest transport feature, usually the road providing access to the object. - `addressbase_voa` EnrichmentV2AprVoaResult — Response for Addressbase Voa dataset. - `primary_description` EnrichmentV2AprVoaPrimaryDescriptionResult — Response for Addressbase Voa Primary Description. - `scheme` string, nullable — Name of VOA classification scheme. - `version` string, nullable — Version of VOA classification scheme. - `key` string, nullable — Unique key of the classification record. - `code` string, nullable — Code describing VOA classification. - `start_date` string, nullable — Start date of classification record. - `end_date` string, nullable — End date of classification record. - `update_date` string, nullable — Last update date of classification record. - `entry_date` string, nullable — Entry date of classification record. - `special_category` EnrichmentV2AprVoaSpecialCategoryResult — Response for Addressbase Voa Special Category. - `scheme` string, nullable — Name of VOA special category scheme. - `version` string, nullable — Version of VOA special category scheme. - `key` string, nullable — Unique key of the classification record. - `code` string, nullable — Code describing VOA special category. - `start_date` string, nullable — Start date of classification record. - `end_date` string, nullable — End date of classification record. - `update_date` string, nullable — Last update date of classification record. - `entry_date` string, nullable — Entry date of classification record. - `irl_mosaic` EnrichmentV2IrlMosaicResult — Response for IRL Mosaic dataset. - `household` EnrichmentV2IrlMosaicHouseholdResult — Response for IRL Mosaic Household. - `type_code` string, nullable — MOSAIC Type Code. - `type` string, nullable — MOSAIC Type Name. - `group_code` string, nullable — MOSAIC Group Code. - `group` string, nullable — MOSAIC Group Name. - `area_code` string, nullable — MOSAIC Area Code. - `nzl_household` EnrichmentV2NzlHouseholdResult — Response for NZL Household dataset. - `head_of_household_age` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `children_at_address` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `household_composition` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `head_of_household_lifestage` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `adults_at_address` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `nzl_mosaic` EnrichmentV2NzlMosaicResult — Response for NZL Mosaic dataset. - `mosaic` EnrichmentV2NzlMosaicElementResult — Response for NZL Mosaic's Elements. - `group_code` string, nullable — Group Code. - `type_code` string, nullable — Type Code. - `mosaic_segment` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `factor_a` EnrichmentV2NzlMosaicFactorResult — Response for NZL Mosaic's Factor Elements. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `factor_b` EnrichmentV2NzlMosaicFactorResult — Response for NZL Mosaic's Factor Elements. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `factor_c` EnrichmentV2NzlMosaicFactorResult — Response for NZL Mosaic's Factor Elements. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `factor_d` EnrichmentV2NzlMosaicFactorResult — Response for NZL Mosaic's Factor Elements. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `factor_e` EnrichmentV2NzlMosaicFactorResult — Response for NZL Mosaic's Factor Elements. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `factor_f` EnrichmentV2NzlMosaicFactorResult — Response for NZL Mosaic's Factor Elements. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `nzl_property` EnrichmentV2NzlPropertyResult — Response for NZL Property dataset. - `property_type` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `property_ownership` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `property_value` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `property_size` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `bedrooms` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `bathrooms` EnrichmentV2NzlElementCodeResult — Response for NZL Elements' Code. - `code` string, nullable — Code. - `sgp_mosaic` EnrichmentV2SgpMosaicResult — Response for SGP Mosaic dataset. - `demographic_postal_code` EnrichmentV2SgpMosaicDemographicPostalCodeResult — Response for SGP Mosaic Demographic Postal Code. - `type_code` string, nullable — MOSAIC Type Code. - `type` string, nullable — Name of MOSAIC Type. - `group_code` string, nullable — MOSAIC Group Code. - `group` string, nullable — Name of MOSAIC Group. - `residential_postal_code` EnrichmentV2SgpMosaicResidentialPostalCodeResult — Response for SGP Mosaic Residential Postal Code. - `households` string, nullable — Residential Units. - `residents` string, nullable — Population. - `affluence` EnrichmentV2SgpMosaicFactorResult — Response for SGP Mosaic Elements that contains score, percentile and decile. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `life_stage` EnrichmentV2SgpMosaicFactorResult — Response for SGP Mosaic Elements that contains score, percentile and decile. - `score` number, double, nullable — Score. - `percentile` number, double, nullable — Percentile. - `decile` number, double, nullable — Decile. - `metadata` EnrichmentV2ResultAddressValidateMetadata - `code` string, nullable - `message` string, nullable - `detail` string, nullable - `datasets` EnrichmentV2ResultAddressValidateMetadataDatasets - `geocodes` EnrichmentV2GeocodesMetadata — Attribute-level metadata for the Geocodes dataset. - `latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `match_level` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `usa_regional_geocodes` EnrichmentV2UsaRegionalGeocodesMetadata — Attribute-level metadata for the USA Regional Geocodes dataset. - `latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `match_level` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `census_tract` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `census_block` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `core_based_statistical_area` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `congressional_district_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `county_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `aus_regional_geocodes` EnrichmentV2AusRegionalGeocodesMetadata — Attribute-level metadata for the AUS Regional Geocodes dataset. - `latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `match_level` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `sa1` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `meshblock` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `lga_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `lga_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_pid` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_pid` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `geocode_level_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `geocode_level_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `geocode_type_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `geocode_type_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_elevation` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_planimetric_accuracy` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_boundary_extent` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_geocode_reliability_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `highest_level_geocode_reliability_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `confidence_level_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `confidence_level_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2021_meshblock_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2021_meshblock_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2021_meshblock_match_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2021_meshblock_match_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2016_meshblock_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2016_meshblock_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2016_meshblock_match_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `2016_meshblock_match_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_type_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `primary_address_pid` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_join_type` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `collector_district_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `collector_district_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `commonwealth_electoral_boundary_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `commonwealth_electoral_boundary_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `statistical_local_area_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `statistical_local_area_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `statistical_local_area_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_boundary_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_boundary_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_effective_start` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_effective_end` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_new_pid` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_new_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_new_effective_start` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `state_electoral_new_effective_end` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_elevation` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_planimetric_accuracy` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_boundary_extent` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_geocode_reliability_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `address_level_geocode_reliability_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_level_longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_level_latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_level_planimetric_accuracy` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_level_boundary_extent` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_level_geocode_reliability_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `street_level_geocode_reliability_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_level_longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_level_latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_level_planimetric_accuracy` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_level_geocode_reliability_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_level_geocode_reliability_description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gnaf_legal_parcel_identifier` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `locality_class_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `nzl_regional_geocodes` EnrichmentV2NzlRegionalGeocodesMetadata — Attribute-level metadata for the NZL Regional Geocodes dataset. - `front_of_property_nztm_x_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `front_of_property_nztm_y_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `centroid_of_property_nztm_x_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `centroid_of_property_nztm_y_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `linz_parcel_id` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `property_purpose_type` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `addressable` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `mesh_block_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `territorial_authority_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `territorial_authority_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `regional_council_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `regional_council_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `general_electorate_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `general_electorate_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `maori_electorate_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `maori_electorate_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `front_of_property_latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `front_of_property_longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `centroid_of_property_latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `centroid_of_property_longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `match_level` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `uk_location_complete` EnrichmentV2UkLocationCompleteMetadata — Attribute-level metadata for the UK Location Complete dataset. - `latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `match_level` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `udprn` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `uprn` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `x_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `y_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `uk_location_essential` EnrichmentV2UkLocationEssentialMetadata — Attribute-level metadata for the UK Location Essential dataset. - `latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `match_level` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `udprn` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `uprn` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `x_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `y_coordinate` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gbr_government` EnrichmentV2GbrGovernmentMetadata — Attribute-level metadata for the GBR Government dataset. - `eer_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `eer_code_pre_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `eer_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gor_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gor_code_pre_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gor_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `lea_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `lea_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `la_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `la_code_pre_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `la_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ward_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ward_code_pre_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ward_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `cens_out_area` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gbr_health` EnrichmentV2GbrHealthMetadata — Attribute-level metadata for the GBR Health dataset. - `authority_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `authority_code_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `authority_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `pclh_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `pclh_code_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `pclh_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ward_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ward_code_2011` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ward_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ccg_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `ccg_name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `doh_code` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `premium_location_insight` EnrichmentV2PremiumLocationInsightMetadata — Attribute-level metadata for the Premium Location Insight dataset. (The time attribute is excluded in Premium Location Insight Lite.)
- `geocodes` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `geocodes_building_xy` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `geocodes_access` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `time` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `what3words` EnrichmentV2What3WordsMetadata — Attribute-level metadata for the what3words dataset. - `latitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `longitude` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `name` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `description` DatasetMetadata — The attribute's metadata. - `code` string, nullable — Attribute-level metadata code. - `message` string, nullable — Attribute-level metadata message. - `value` string, nullable — The attribute's value that was returned by the API. - `gbr_location_grid` EnrichmentV2GbrLocationGridMetadata - `postzon` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `codepoint` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `gbr_parliament` EnrichmentV2GbrParliamentMetadata - `westminster` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `scotland` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `gbr_mosaic` EnrichmentV2GbrMosaicMetadata - `household` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `postal_code` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `gbr_mosaic_financial` EnrichmentV2GbrMosaicFinancialMetadata - `postal_code` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `household` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `gbr_alias` EnrichmentV2GbrAliasMetadata - `aliases` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `gbr_quality` EnrichmentV2GbrQualityMetadata - `record` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_classification` EnrichmentV2AprClassificationMetadata - `code` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `record` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `scheme` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_cross_reference` EnrichmentV2AprCrossReferenceMetadata - `addresslayer_2` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `council_tax` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `integrated_transport_network` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `non_domestic_rates` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `topography_layer` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_government` EnrichmentV2AprGovernmentMetadata - `government` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_health` EnrichmentV2AprHealthMetadata - `health` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_location_grid` EnrichmentV2AprLocationGridMetadata - `blpu` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `building` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `postal_code` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `street` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_parliament` EnrichmentV2AprParliamentMetadata - `westminster` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_quality` EnrichmentV2AprQualityMetadata - `custodian` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `metadata` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `record` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_street` EnrichmentV2AprStreetMetadata - `grid` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `record` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `usrn` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_topography` EnrichmentV2AprTopographyMetadata - `topographic_ids` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `addressbase_voa` EnrichmentV2AprVoaMetadata - `primary_description` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `special_category` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `irl_mosaic` EnrichmentV2IrlMosaicMetadata - `household` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `nzl_household` EnrichmentV2NzlHouseholdMetadata - `head_of_household_age` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `children_at_address` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `household_composition` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `head_of_household_lifestage` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `adults_at_address` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `nzl_mosaic` EnrichmentV2NzlMosaicMetadata - `mosaic` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `mosaic_segment` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `factor_a` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `factor_b` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `factor_c` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `factor_d` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `factor_e` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `factor_f` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `nzl_property` EnrichmentV2NzlPropertyMetadata - `property_type` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `property_ownership` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - `property_value` DatasetMetadataV2 - `code` string, nullable, required - `message` string, nullable, required - `value` string, nullable, required - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `406` — Not Acceptable - `408` — Request Timeout - `415` — Unsupported Media Type - `429` — Too Many Requests - `500` — Internal Server Error - `503` — Service Unavailable --- [API](https://skmtc.dev/experianaperture/apis/aperture-rest-api.md) · [All operations](https://skmtc.dev/experianaperture/apis/aperture-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/experianaperture/aperture-rest-api/revisions/f17d329b4892/schema)