openapi: 3.2.0 info: title: Aperture REST Address Validation API version: v2 servers: - url: https://api.experianaperture.io/ tags: - name: Address Validation paths: /address/datasets/v1: get: tags: - Address Validation summary: Get the available datasets for the supplied country parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: country_iso in: query description: 3-letter ISO code for country. schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressDatasetsV1Response' examples: Australia: value: result: - country_iso_3: AUS country_name: Australia datasets: - id: au-address name: Australia Postal Address - id: au-address-beta name: Australia Postal Address - id: au-address-datafusion name: Australia Enhanced Address - id: au-address-gnaf name: Australia Geocoded National Address - id: au-address-gnaf-beta name: Australia Geocoded National Address United Kingdom: value: result: - country_iso_3: GBR country_name: United Kingdom datasets: - id: gb-additional-addressbaseislands name: United Kingdom AddressBase Premium with Islands - id: gb-additional-business name: United Kingdom Business Names - id: gb-additional-businessextended name: United Kingdom Extended Business - id: gb-additional-electricity name: United Kingdom Live Utilities Data - Electricity - id: gb-additional-gas name: United Kingdom Live Utilities Data - Gas - id: gb-additional-multipleresidence name: United Kingdom Multiple Residence - id: gb-additional-names name: United Kingdom Names - id: gb-additional-notyetbuilt name: United Kingdom Not Yet Built - id: gb-address name: United Kingdom Postal Address - id: gb-address-addressbase name: United Kingdom AddressBase Premium - id: gb-address-streetlevel name: United Kingdom Postal Address Street Level - id: gb-address-wales name: Cymraeg (Welsh Language) Postal Address valid_combinations: - - gb-additional-business - gb-additional-multipleresidence - gb-additional-notyetbuilt - - gb-additional-business - gb-additional-names - - gb-additional-business - gb-additional-names - gb-additional-notyetbuilt - - gb-additional-business - gb-additional-notyetbuilt - - gb-additional-multipleresidence - gb-additional-notyetbuilt - - gb-additional-names - gb-additional-notyetbuilt United States: value: result: - country_iso_3: USA country_name: United States of America datasets: - id: us-address name: United States Postal Address '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: getAddressDatasetsV1 x-operation-id-source: derived /address/format/v1/{global_address_key}: get: tags: - Address Validation summary: Format the address with the supplied key parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: global_address_key in: path description: Global address key. required: true schema: maxLength: 4000 minLength: 0 pattern: ^(?:[A-Za-z0-9_-]*)$ type: string - name: Add-Components in: header description: Specifies if the response should contain the address broken down into its components. schema: type: boolean default: false - name: Add-Metadata in: header description: Specify whether the response should return all fields and values, in addition to the main core information. schema: type: boolean default: false - name: Add-Dpid in: header description: Specify whether the response should return DPID in the metadata result. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressFormatV1Response' examples: Australia: value: result: global_address_key: QVVTfjcuNzMwak9BVVNIQXpsQndBQUFBQUJBd0VBQUFBQk9uQ09FWUFoQUFJUUNDQUFBQUFBQVFBMk5UUTVBRFlBQVAuLlFnQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUFBVENBMk5UUTVJRk4wSUV0cGJHUmhJRkprSURVME9RQUFBQUFBfjIy confidence: Verified match address: address_line_1: L 6 549 St Kilda Rd address_line_2: '' address_line_3: '' locality: MELBOURNE region: VIC postal_code: '3004' country: AUSTRALIA components: country_name: AUSTRALIA country_iso_3: AUS country_iso_2: AU postal_code: full_name: '3004' primary: '3004' sub_building: floor: full_name: L 6 type: L value: '6' building: building_number: '549' street: full_name: St Kilda Rd name: St Kilda type: Rd locality: town: name: MELBOURNE metadata: address_info: identifier: dpid: '62147712' hin: '203060068' barcode: delivery_point_barcode: '1301012002011121210102312002130231113' sort_plan_number: '022' address_classification: delivery_type: Business United Kingdom: value: result: global_address_key: R0JSfjcuNzMwME9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQWlPLmgwWUFoTUlJQUFBQUFBQUFBTnprQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU56a2dVM1JoZEdsdmJpQlNiMkZrTENCTFJVeFVXUUFBQUFBQX4yMg confidence: Verified match address: address_line_1: 79 Station Road address_line_2: '' address_line_3: '' locality: KELTY region: '' postal_code: KY4 0BL country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: KY4 0BL primary: KY4 0BL building: building_number: '79' street: full_name: Station Road name: Station type: Road locality: region: name: Scotland code: SCT description: Constituent country sub_region: name: Fife description: Geographic county town: name: KELTY additional_elements: locality: sub_region: administrative_county: North Yorkshire former_postal_county: North Yorkshire traditional_county: Yorkshire metadata: address_info: identifier: udprn: '12353232' paf_address_key: 2304084100000000S dps: 1L barcode: delivery_point_barcode: (KY40BL2Z2) United Kingdom with Names: value: result: global_address_key: R0JSfjcuNzMwME9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQWlPLmgwWUFoTUlJQUFBQUFBQUFBTnprQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU56a2dVM1JoZEdsdmJpQlNiMkZrTENCTFJVeFVXUUFBQUFBQX4yMg confidence: Verified match address: address_line_1: 79 Station Road address_line_2: '' address_line_3: '' locality: KELTY region: '' postal_code: KY4 0BL country: UNITED KINGDOM names: - firstname: John middlename: James surname: Dow components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: KY4 0BL primary: KY4 0BL building: building_number: '79' street: full_name: Station Road name: Station type: Road locality: region: name: Scotland code: SCT description: Constituent country sub_region: name: Fife description: Geographic county town: name: KELTY additional_elements: locality: sub_region: administrative_county: North Yorkshire former_postal_county: North Yorkshire traditional_county: Yorkshire metadata: address_info: identifier: udprn: '12353232' paf_address_key: 2304084100000000S dps: 2S barcode: delivery_point_barcode: (KY40BL2Z2) United States: value: result: global_address_key: VVNBfjcuNzMwck9VU0FEd25sQndBQUFBQUJBZ0VBQUFBRHB4MzJFWUFoSUFJU0NDQUFBQUFBQUFBM053QUEuLjlrQUFBQUFQLi4uLjhBQUFBQUFBQUFBQUFBQUFBQUFBQTNOeUJOWVhOellXTm9kWE5sZEhSeklFRjJaU3d3TWpFek9TMDBNekF4QUFBQUFBQS1-MzE confidence: Verified match address: address_line_1: 77 Massachusetts Ave address_line_2: '' address_line_3: '' locality: Cambridge region: MA postal_code: 02139-4301 country: UNITED STATES OF AMERICA components: country_name: UNITED STATES OF AMERICA country_iso_3: USA country_iso_2: US postal_code: full_name: 02139-4301 primary: 02139 secondary: '4301' building: building_number: '77' street: full_name: Massachusetts Ave name: Massachusetts type: Ave locality: region: code: MA sub_region: name: Middlesex town: name: Cambridge metadata: barcode: delivery_point_barcode: 02139430177 check_digit: '3' route_classification: carrier_route: C077 elot: 0184A address_classification: address_type: code: S description: Street delivery_type: Business is_deliverable: Y dpv: cmra_indicator: N seed_indicator: ' ' dpv_indicator: Y footnotes: - AA - BB vacancy_indicator: N no_stats_indicator: Y pbsa_indicator: N lacs_indicator: ' ' lacs_code: '' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: getAddressFormatV1ByGlobalAddressKey x-operation-id-source: derived post: tags: - Address Validation summary: Format the address with the supplied key using a custom layout parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: global_address_key in: path description: Global address key. required: true schema: maxLength: 4000 minLength: 0 pattern: ^(?:[A-Za-z0-9_-]*)$ type: string - name: Add-Components in: header description: Specifies if the response should contain the address broken down into its components. schema: type: boolean default: false - name: Add-Metadata in: header description: Specify whether the response should return all fields and values, in addition to the main core information. schema: type: boolean default: false - name: Add-Enrichment in: header description: Specify whether the response should make a call to enrichment and return enrichment result. schema: type: boolean default: false - name: Add-Dpid in: header description: Specify whether the response should return DPID in the metadata result. schema: type: boolean default: false requestBody: description: The request body. content: application/json: schema: $ref: '#/components/schemas/AddressFormatV1Request' examples: Default Format: value: layouts: - default layout_format: default Default Format With Enrichment: value: layouts: - default layout_format: default attributes: geocodes: - latitude - longitude - match_level United Kingdom Business With Enrichment: value: layout_format: default attributes: gbr_business: - commercial_mosaic - location - non_limited_company_key - number_of_employees - phone - registration - standard_industry_classification - urn United Kingdom With Mosaic: value: layout_format: default attributes: gbr_mosaic: - household - postal_code United Kingdom With Location Grid: value: layout_format: default attributes: gbr_location_grid: - postzon - codepoint required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressFormatV1Response' examples: Australia: value: result: global_address_key: aWQ9TGV2ZWwgNiAgNTQ5IFN0IEtpbGRhIFJvYWQsIE1FTEJPVVJORSAgVklDIDMwMDQsIEF1c3RyYWxpYX5hbHRfa2V5PTYyMTQ3NzEyfmRhdGFzZXQ9QVVTX1BBRn5mb3JtYXRfa2V5PUFVUyRhdS1hZGRyZXNzJDcuNzMwMU9BVVNIQXZtQndBQUFBQUlBZ0VBQUFBQlBlTlNFQWdoQUFJQUFBQUFBQUFBTmdBQS4uOWRBQUFBQVAuLi4uOEFBQUFBQUFBQUFBQUFBQUFBQUFCTUlEWWdJRFUwT1NCVGRDQkxhV3hrWVNCU1pBQUFBQUFBJCQk confidence: Verified match address: address_line_1: L 6 549 St Kilda Rd address_line_2: '' address_line_3: '' locality: MELBOURNE region: VIC postal_code: '3004' country: AUSTRALIA components: country_name: AUSTRALIA country_iso_3: AUS country_iso_2: AU postal_code: full_name: '3004' primary: '3004' sub_building: floor: full_name: L 6 type: L value: '6' building: building_number: '549' street: full_name: St Kilda Rd name: St Kilda type: Rd locality: town: name: MELBOURNE metadata: address_info: identifier: dpid: '62147712' hin: '203060068' barcode: delivery_point_barcode: '1301012002011121210102312002130231113' sort_plan_number: '022' address_classification: delivery_type: Business Australia With Enrichment: value: result: global_address_key: aWQ9TGV2ZWwgNiAgNTQ5IFN0IEtpbGRhIFJvYWQsIE1FTEJPVVJORSAgVklDIDMwMDQsIEF1c3RyYWxpYX5hbHRfa2V5PTYyMTQ3NzEyfmRhdGFzZXQ9QVVTX1BBRn5mb3JtYXRfa2V5PUFVUyRhdS1hZGRyZXNzJDcuNzMwMU9BVVNIQXZtQndBQUFBQUlBZ0VBQUFBQlBlTlNFQWdoQUFJQUFBQUFBQUFBTmdBQS4uOWRBQUFBQVAuLi4uOEFBQUFBQUFBQUFBQUFBQUFBQUFCTUlEWWdJRFUwT1NCVGRDQkxhV3hrWVNCU1pBQUFBQUFBJCQk confidence: Verified match address: address_line_1: L 6 549 St Kilda Rd address_line_2: '' address_line_3: '' locality: MELBOURNE region: VIC postal_code: '3004' country: AUSTRALIA components: country_name: AUSTRALIA country_iso_3: AUS country_iso_2: AU postal_code: full_name: '3004' primary: '3004' sub_building: floor: full_name: L 6 type: L value: '6' building: building_number: '549' street: full_name: St Kilda Rd name: St Kilda type: Rd locality: town: name: MELBOURNE metadata: address_info: identifier: dpid: '62147712' hin: '203060068' barcode: delivery_point_barcode: '1301012002011121210102312002130231113' sort_plan_number: '022' address_classification: delivery_type: Business enrichment: transaction_id: 23918140-4df9-4862-aaca-db81dd757c52 result: geocodes: latitude: -37.84659 longitude: 144.98028 match_level: building metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: geocodes: latitude: code: S200 message: Match value: '-37.84659' longitude: code: S200 message: Match value: '144.98028' match_level: code: S200 message: Match value: building United Kingdom: value: result: global_address_key: aWQ9RmxhdCAxLCAyMSBBYmVyZGVlbiBXYWxrLCBTY2FyYm9yb3VnaCwgWU8xMSAxQkEsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQ0Nzc3OTh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNmFmZWFhMWMtNTZkYS00YzA4LThmZTQtYTNkOTlhYWI5MTI0JDIxJCQ confidence: Verified match address: address_line_1: Flat 1 address_line_2: 21 Aberdeen Walk address_line_3: '' locality: SCARBOROUGH region: '' postal_code: YO11 1BA country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: YO11 1BA primary: YO11 1BA sub_building: door: full_name: Flat 1 building: building_number: '21' street: full_name: Aberdeen Walk name: Aberdeen type: Walk locality: region: name: Scotland code: SCT description: Constituent country sub_region: name: Fife description: Geographic county town: name: Scarborough additional_elements: locality: sub_region: administrative_county: North Yorkshire former_postal_county: North Yorkshire traditional_county: Yorkshire metadata: address_info: identifier: udprn: '54477798' paf_address_key: 3890873300000000S dps: 1A address_classification: delivery_type: residential United Kingdom With Utilities: value: result: global_address_key: aWQ9MSBTdXNzZXggQ2xvc2UsIEJPVVJORU1PVVRIIEJIOSAzU0EsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MDE4MjcxNzN-ZGF0YXNldD1HQlJ-Zm9ybWF0X2tleT1HQlIkR0JSJDcuNzMwZU9HQlJFd2ZvQndBQUFBQUJBd0VBQUFBQVpOSElrWUFnQUFBQUFBQUFNUUFBLi45a0FBQUFBUC4uLi44QUFBQUFBQUFBQUFBQUFBQUFBQUF4SUZOMWMzTmxlQ0JEYkc5elpRQUFBQUFBfmVsZWM9dHJ1ZX5nYXM9dHJ1ZX5wb3M9MX5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTE0fm1heF9zdWdnZXN0aW9ucz03 confidence: Verified match addresses_formatted: - layout_name: Utilities address: address_line_1: 1 Sussex Close address_line_2: '' address_line_3: '' locality: Bournemouth region: '' postal_code: BH9 3SA country: United Kingdom electricity_meters: - mpan: '12345678910' uprn: '123456789' address_line_1: '' address_line_2: '' address_line_3: '1' address_line_4: '' address_line_5: Sussex Close address_line_6: '' address_line_7: '' address_line_8: BOURNEMOUTH address_line_9: '' address_postal_code: BH9 3SA trading_status: T trading_status_efd: '20040121' profile_class: '01' profile_class_efd: '1234567' meter_timeswitch_class: '123' meter_timeswitch_class_efd: '7654321' line_loss_factor: '100' line_loss_factor_efd: '7654321' standard_settlement_configuration: 0393 standard_settlement_configuration_efd: '7654321' energisation_status: E energisation_status_efd: '20040121' gsp_group_id: _H gsp_group_efd: '20040121' data_aggregator_mpid: MANW data_aggregator_efd: '20040121' data_collector_mpid: MANW data_collector_efd: '20040121' supplier_mpid: '' supplier_efd: '' meter_operator_mpid: '' meter_operator_efd: '' measurement_class: A measurement_class_efd: '20040121' green_deal_in_effect: '0' smso_mpid: '' smso_efd: '' dcc_service_flag: '' dcc_service_flag_efd: '' ihd_status: '' ihd_status_efd: '' smets_version: '' distributor_mpid: SOUT metered_indicator: '' metered_indicator_efd: '' metered_indicator_etd: '20040121' consumer_type: Domestic relationship_status_indicator: None rmp_state: O rmp_efd: '20040121' domestic_consumer_indicator: T css_supplier_mpid: '' css_supply_start_date: '' meter_serial_number: 1234567T meter_install_date: '20040121' meter_type: N map_mpid: SOUT map_mpid_efd: '20040121' installing_supplier_mpid: SPOW energy_direction: '' energy_direction_efd: '' energy_direction_etd: '' connection_type: '' connection_type_efd: '' connection_type_etd: '' esme_id: '' meter_location: '' register_digits: '' rel_address_primary_name: '1' rel_address_secondary_name: '' rel_address_street1: SUSSEX CLOSE rel_address_street2: '' rel_address_locality1: '' rel_address_locality2: '' rel_address_town: BOURNEMOUTH rel_address_postcode: BH9 3SA rel_address_logical_status: '1' rel_address_language: ENG rel_address_organisation: '' rel_address_address_type: DPA rel_address_confidence_score: '100' rel_address_classification: RD02 rel_address_latitude: '50.763416' rel_address_longitude: '-1.860534' gas_meters: - mprn: '9876543210' uprn: '987654321' rel_address_primary_name: '1' rel_address_secondary_name: '' rel_address_street1: SUSSEX CLOSE rel_address_street2: '' rel_address_locality1: '' rel_address_locality2: '' rel_address_town: BOURNEMOUTH rel_address_postcode: BH9 3SA rel_address_logical_status: '1' rel_address_language: ENG rel_address_organisation: '' rel_address_address_type: DPA rel_address_confidence_score: '100' rel_address_classification: RD02 rel_address_latitude: '50.763416' rel_address_longitude: '-1.860534' meter_serial: G4K0012345678 offtake_quantity_annual: '01234' meter_point_status: LI installer_id: SCT network_name: Scotland Gas Networks Plc. supplier_name: Scottish Power Energy Retail Limited last_meter_read_date: '20240517' last_meter_read_type: E last_meter_read_value: 01187 United Kingdom With Electricity and MOSAIC HH Elements: value: result: global_address_key: aWQ9MSBTdXNzZXggQ2xvc2UsIEJPVVJORU1PVVRIIEJIOSAzU0EsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MDE4MjcxNzN-ZGF0YXNldD1HQlJ-Zm9ybWF0X2tleT1HQlIkR0JSJDcuNzMwZU9HQlJFd2ZvQndBQUFBQUJBd0VBQUFBQVpOSElrWUFnQUFBQUFBQUFNUUFBLi45a0FBQUFBUC4uLi44QUFBQUFBQUFBQUFBQUFBQUFBQUF4SUZOMWMzTmxlQ0JEYkc5elpRQUFBQUFBfmVsZWM9dHJ1ZX5nYXM9dHJ1ZX5wb3M9MX5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTE0fm1heF9zdWdnZXN0aW9ucz03 confidence: Verified match addresses_formatted: - layout_name: ElectricityUtilityMosaicHousehold address: address_line_1: 1 Sussex Close address_line_2: '' address_line_3: '' locality: Bournemouth region: '' postal_code: BH9 3SA country: United Kingdom mosaic_household_type_code: '32' mosaic_household_type_name: First-Rung Futures mosaic_household_group_code: H mosaic_household_group_name: Aspiring Homemakers electricity_meters: - mpan: '12345678910' uprn: '123456789' address_line_1: '' address_line_2: '' address_line_3: '1' address_line_4: '' address_line_5: Sussex Close address_line_6: '' address_line_7: '' address_line_8: BOURNEMOUTH address_line_9: '' address_postal_code: BH9 3SA trading_status: T trading_status_efd: '20040121' profile_class: '01' profile_class_efd: '1234567' meter_timeswitch_class: '123' meter_timeswitch_class_efd: '7654321' line_loss_factor: '100' line_loss_factor_efd: '7654321' standard_settlement_configuration: 0393 standard_settlement_configuration_efd: '7654321' energisation_status: E energisation_status_efd: '20040121' gsp_group_id: _H gsp_group_efd: '20040121' data_aggregator_mpid: MANW data_aggregator_efd: '20040121' data_collector_mpid: MANW data_collector_efd: '20040121' supplier_mpid: '' supplier_efd: '' meter_operator_mpid: '' meter_operator_efd: '' measurement_class: A measurement_class_efd: '20040121' green_deal_in_effect: '0' smso_mpid: '' smso_efd: '' dcc_service_flag: '' dcc_service_flag_efd: '' ihd_status: '' ihd_status_efd: '' smets_version: '' distributor_mpid: SOUT metered_indicator: '' metered_indicator_efd: '' metered_indicator_etd: '20040121' consumer_type: Domestic relationship_status_indicator: None rmp_state: O rmp_efd: '20040121' domestic_consumer_indicator: T css_supplier_mpid: '' css_supply_start_date: '' meter_serial_number: 1234567T meter_install_date: '20040121' meter_type: N map_mpid: SOUT map_mpid_efd: '20040121' installing_supplier_mpid: SPOW energy_direction: '' energy_direction_efd: '' energy_direction_etd: '' connection_type: '' connection_type_efd: '' connection_type_etd: '' esme_id: '' meter_location: '' register_digits: '' rel_address_primary_name: '1' rel_address_secondary_name: '' rel_address_street1: SUSSEX CLOSE rel_address_street2: '' rel_address_locality1: '' rel_address_locality2: '' rel_address_town: BOURNEMOUTH rel_address_postcode: BH9 3SA rel_address_logical_status: '1' rel_address_language: ENG rel_address_organisation: '' rel_address_address_type: DPA rel_address_confidence_score: '100' rel_address_classification: RD02 rel_address_latitude: '50.763416' rel_address_longitude: '-1.860534' United Kingdom With Enrichment: value: result: global_address_key: aWQ9RmxhdCAxLCAyMSBBYmVyZGVlbiBXYWxrLCBTY2FyYm9yb3VnaCwgWU8xMSAxQkEsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQ0Nzc3OTh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNmFmZWFhMWMtNTZkYS00YzA4LThmZTQtYTNkOTlhYWI5MTI0JDIxJCQ confidence: Verified match address: address_line_1: Flat 1 address_line_2: 21 Aberdeen Walk address_line_3: '' locality: SCARBOROUGH region: '' postal_code: YO11 1BA country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: YO11 1BA primary: YO11 1BA sub_building: door: full_name: Flat 1 building: building_number: '21' street: full_name: Aberdeen Walk name: Aberdeen type: Walk locality: region: name: Scotland code: SCT description: Constituent country sub_region: name: Fife description: Geographic county town: name: Scarborough additional_elements: locality: sub_region: administrative_county: North Yorkshire former_postal_county: North Yorkshire traditional_county: Yorkshire metadata: address_info: identifier: udprn: '54477798' paf_address_key: 3890873300000000S dps: 1A address_classification: delivery_type: residential enrichment: transaction_id: 70ac71c8-bad1-4d7e-9e21-f1405d0647a4 result: geocodes: latitude: 54.2828 longitude: -0.40269 match_level: building metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: geocodes: latitude: code: S200 message: Match value: '54.2828' longitude: code: S200 message: Match value: '-0.40269' match_level: code: S200 message: Match value: building United Kingdom With Business Enrichment: value: result: confidence: Verified match address: address_line_1: Example Business address_line_2: Business Name address_line_3: 5-7 Cutler Street locality: LONDON region: '' postal_code: E1 7DJ country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: KY4 0BL primary: KY4 0BL building: building_name: Business Name building_number: '79' street: full_name: Cutler Street name: Cutler type: Street locality: region: name: England code: ENG description: Constituent country sub_region: name: Greater London description: Georgraphic county town: name: KELTY metadata: address_info: identifier: udprn: '12353232' paf_address_key: 2304084100000000S dps: 1L barcode: delivery_point_barcode: (KY40BL2Z2) enrichment: transaction_id: 00000000-0000-0000-0000-000000000000 result: gbr_business: urn: Tlt00004518123 commercial_mosaic: group_type_code: K41 group_type_description: Business Boosters group_code: K group_description: Independent Enterpreneurs registration: '04572604' non_limited_company_key: '04572604' phone: 020 70293777 number_of_employees: '4' standard_industry_classification: sic_2007_code: 79.90/9 sic_2007_description: Other Reservation Service Activities (Not Including Activities Of Tourist Guides) thomson_code: '79060' thomson_description: Tour Operators location: code: S description: Single location small_or_home_office: false United Kingdom with Names: value: result: global_address_key: aWQ9RmxhdCAxLCAyMSBBYmVyZGVlbiBXYWxrLCBTY2FyYm9yb3VnaCwgWU8xMSAxQkEsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQ0Nzc3OTh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNmFmZWFhMWMtNTZkYS00YzA4LThmZTQtYTNkOTlhYWI5MTI0JDIxJCQ confidence: Verified match address: address_line_1: Flat 1 address_line_2: 21 Aberdeen Walk address_line_3: '' locality: SCARBOROUGH region: '' postal_code: YO11 1BA country: UNITED KINGDOM names: - firstname: John middlename: James surname: Dow components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: YO11 1BA primary: YO11 1BA sub_building: door: full_name: Flat 1 building: building_number: '21' street: full_name: Aberdeen Walk name: Aberdeen type: Walk locality: region: name: Scotland code: SCT description: Constituent country sub_region: name: Fife description: Geographic county town: name: Scarborough additional_elements: locality: sub_region: administrative_county: North Yorkshire former_postal_county: North Yorkshire traditional_county: Yorkshire metadata: address_info: identifier: udprn: '54477798' paf_address_key: 3890873300000000S dps: 1L address_classification: delivery_type: residential United States: value: result: global_address_key: aWQ9NzcgTWFzc2FjaHVzZXR0cyBBdmUsIENhbWJyaWRnZSBNQSAwMjEzOSwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDc3IE1hc3NhY2h1c2V0dHMgQXZlfHxDYW1icmlkZ2UsTUEsMDIxMzktNDMwN35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyRkZTZhMDQ2Mi1iYTE0LTQxYTMtOWQ2Ny01YjBhZjRmNGZmZmUkNzckJA confidence: Verified match address: address_line_1: 77 Massachusetts Ave address_line_2: '' address_line_3: '' locality: Cambridge region: MA postal_code: 02139-4301 country: UNITED STATES OF AMERICA components: country_name: UNITED STATES OF AMERICA country_iso_3: USA country_iso_2: US postal_code: full_name: 02139-4301 primary: 02139 secondary: '4301' building: building_number: '77' street: full_name: Massachusetts Ave name: Massachusetts type: Ave locality: region: code: MA sub_region: name: Middlesex town: name: Cambridge metadata: barcode: delivery_point_barcode: 02139430177 check_digit: '3' route_classification: carrier_route: C077 elot: 0184A address_classification: address_type: code: S description: Street delivery_type: Business is_deliverable: Y United States With Enrichment: value: result: global_address_key: aWQ9NzcgTWFzc2FjaHVzZXR0cyBBdmUsIENhbWJyaWRnZSBNQSAwMjEzOSwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDc3IE1hc3NhY2h1c2V0dHMgQXZlfHxDYW1icmlkZ2UsTUEsMDIxMzktNDMwN35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyRkZTZhMDQ2Mi1iYTE0LTQxYTMtOWQ2Ny01YjBhZjRmNGZmZmUkNzckJA confidence: Verified match address: address_line_1: 77 Massachusetts Ave address_line_2: '' address_line_3: '' locality: Cambridge region: MA postal_code: 02139-4301 country: UNITED STATES OF AMERICA components: country_name: UNITED STATES OF AMERICA country_iso_3: USA country_iso_2: US postal_code: full_name: 02139-4301 primary: 02139 secondary: '4301' building: building_number: '77' street: full_name: Massachusetts Ave name: Massachusetts type: Ave locality: region: code: MA sub_region: name: Middlesex town: name: Cambridge metadata: barcode: delivery_point_barcode: 02139430177 check_digit: '3' route_classification: carrier_route: C077 elot: 0184A address_classification: address_type: code: S description: Street delivery_type: Business is_deliverable: Y enrichment: transaction_id: 6d2963bd-f53f-4674-a908-5463cd4ecacc result: geocodes: latitude: 42.36 longitude: -71.09221 match_level: building metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: geocodes: latitude: code: S200 message: Match value: '42.36' longitude: code: S200 message: Match value: '-71.09221' match_level: code: S200 message: Match value: building Custom Layout - default format: value: result: global_address_key: XlVTQTcuNzMwb09VU0FEd25sQndBQUFBQUJBd0VBQUFBRHB4MzJFWUFoTVFJVEFDQUFBQUFBQVFCRFlXMWljbWxrWjJVQU56Y0FBUC4uVUFBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFOemNnVFdGemMyRmphSFZ6WlhSMGN5QkJkbVVzSUVOaGJXSnlhV1JuWlN3Z1RVRWdNREl4TXprdE5ETXdOd0FBQUFBQQ confidence: Verified match addresses_formatted: - layout_name: AMEX address: AmexStreet: 1 Main St AmexTown: Surbiton AmexCountry: United Kingdom Custom Layout - address_lines format: value: result: global_address_key: XlVTQTcuNzMwb09VU0FEd25sQndBQUFBQUJBd0VBQUFBRHB4MzJFWUFoTVFJVEFDQUFBQUFBQVFCRFlXMWljbWxrWjJVQU56Y0FBUC4uVUFBQUFBRC4uLi4uQUFBQUFBQUFBQUFBQUFBQUFBQUFOemNnVFdGemMyRmphSFZ6WlhSMGN5QkJkbVVzSUVOaGJXSnlhV1JuWlN3Z1RVRWdNREl4TXprdE5ETXdOd0FBQUFBQQ confidence: Verified match addresses_formatted: - layout_name: AMEX address_lines: - label: AmexStreet line: 1 Main St line_content: address - label: AmexTown line: Surbiton line_content: address - label: AmexCountry line: United Kingdom line_content: address United Kingdom With Mosaic: value: result: global_address_key: aWQ9RmxhdCAxLCAxMCBDdWxkdXRoZWwgUm9hZCwgSW52ZXJuZXNzLCBJVjIgNEFHLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTExNzYxNDMyfmRhdGFzZXQ9R0JSX01SRn5mb3JtYXRfa2V5PUdCUiRnYi1hZGRpdGlvbmFsLW11bHRpcGxlcmVzaWRlbmNlJGRlNmU0MGNiLWVjYjAtNDhjMS1hZDA5LTQ0ZjQ2ZmFkMjYxOSQkJCR-cG9zPTZ-Z2FrX3R5cGU9YXV0b2NvbXBsZXRlfmxvY2FsaXR5PX5wb3N0YWxfY29kZT0 confidence: Verified match address: address_line_1: Flat 1 address_line_2: 10 Culduthel Road address_line_3: '' locality: INVERNESS region: '' postal_code: IV2 4AG country: UNITED KINGDOM components: language: en-GB country_name: United Kingdom country_iso_3: GBR country_iso_2: GB postal_code: full_name: IV2 4AG primary: IV2 4AG sub_building: door: full_name: Flat 1 building: building_number: '10' street: full_name: Culduthel Road name: Culduthel type: Road locality: town: name: Inverness metadata: address_info: number_of_households: '4' identifier: umrrn: '52787313' udprn: '11761432' dps: 1L enrichment: result: gbr_mosaic: household: version: '7' type_code: '60' type: Ageing Access group_code: N group: Urban Cohesion postal_code: version: '7' type_code: '51' type: Retirement Communities group_code: L group: Vintage Value metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: gbr_mosaic: household: code: S200 message: Match value: '[complex type]' postal_code: code: S200 message: Match value: '[complex type]' United Kingdom With Location Grid: value: result: global_address_key: aWQ9RmxhdCAxLCAxMCBDdWxkdXRoZWwgUm9hZCwgSW52ZXJuZXNzLCBJVjIgNEFHLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTExNzYxNDMyfmRhdGFzZXQ9R0JSX01SRn5mb3JtYXRfa2V5PUdCUiRnYi1hZGRpdGlvbmFsLW11bHRpcGxlcmVzaWRlbmNlJGRlNmU0MGNiLWVjYjAtNDhjMS1hZDA5LTQ0ZjQ2ZmFkMjYxOSQkJCR-cG9zPTZ-Z2FrX3R5cGU9YXV0b2NvbXBsZXRlfmxvY2FsaXR5PX5wb3N0YWxfY29kZT0 confidence: Verified match address: address_line_1: Flat 1 address_line_2: 10 Culduthel Road address_line_3: '' locality: INVERNESS region: '' postal_code: IV2 4AG country: UNITED KINGDOM components: language: en-GB country_name: United Kingdom country_iso_3: GBR country_iso_2: GB postal_code: full_name: IV2 4AG primary: IV2 4AG sub_building: door: full_name: Flat 1 building: building_number: '10' street: full_name: Culduthel Road name: Culduthel type: Road locality: town: name: Inverness metadata: address_info: number_of_households: '4' identifier: umrrn: '52787313' udprn: '11761432' dps: 1L enrichment: result: gbr_location_grid: postzon: x_coordinate: 2667.0 y_coordinate: 8446.0 os_x_coordinate: 2667.0 os_y_coordinate: 8446.0 latitude: 57.472173 longitude: -4.224351 os_landranger: NH667446 codepoint: x_coordinate: 266748.0 y_coordinate: 844637.0 pqi: '10' is_delivery_service: N ndp: '31' ndp_pqi: '31' ndp_domestic: '28' ndp_commercial: '3' ndp_delivery_service: '0' ndp_matched: '31' ndp_unmatched: '0' metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: gbr_location_grid: postzon: code: S200 message: Match value: '[complex type]' codepoint: code: S200 message: Match value: '[complex type]' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressFormatV1ByGlobalAddressKey x-operation-id-source: derived /address/layouts/v1: post: tags: - Address Validation summary: Get the available layouts for the supplied country parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV1Request' examples: Australia: value: country_iso: AUS datasets: - au-address-gnaf United Kingdom: value: country_iso: GBR datasets: - gb-additional-multipleresidence United States: value: country_iso: USA datasets: - us-address required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV1Response' examples: Australia: value: result: - name: Default country_iso_3: AUS datasets: - au-address-gnaf - name: JB Hifi country_iso_3: AUS datasets: - au-address-gnaf - name: JB Hifi_all country_iso_3: AUS datasets: - au-address-gnaf United Kingdom: value: result: - name: Default country_iso_3: GBR datasets: - gb-additional-multipleresidence - name: Selfridges country_iso_3: GBR datasets: - gb-additional-multipleresidence - name: Selfridges_2 country_iso_3: GBR datasets: - gb-additional-multipleresidence United States: value: result: - name: Default country_iso_3: USA datasets: - us-address - name: AMEX_1 country_iso_3: USA datasets: - us-address - name: AMEX_alternate country_iso_3: USA datasets: - us-address '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressLayoutsV1 x-operation-id-source: derived /address/layouts/v2: post: tags: - Address Validation summary: Creates an address layout parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV2CreateRequest' examples: United Kingdom with DataPlus: value: layout: name: United Kingdom with DataPlus comment: United Kingdom with DataPlus applies_to: - country_iso: GBR datasets: - gb-address options: variation: 1 flatten_diacritics: false enable_enhanced_layout: false display_enhanced_info_on_picklist: false enable_intelligent_layout: false capitalise_unused: false separate_elements: true element_separator: default: ', ' configuration_by_element: buildingNumber: ', ^ ' subBuildingNumber: ', ^ ' postcode: ' ^ ' deliveryPointSuffix: ' ^ ' country: ' ^ ' pafAddressKey: ^ pafOrganisationKey: ^ terminate_lines: false line_terminator: default: ', ' configuration_by_element: postcode: ^ deliveryPointSuffix: ^ country: .^. pad_lines: false multiple_dataplus_delimiter: '|' abbreviate_item: - thoroughfareName - county capitalise_item: - postcode - country lines: - line_name: Line 1 max_width: 255 - line_name: Line 2 max_width: 255 - line_name: Line 3 max_width: 255 - line_name: Locality max_width: 255 elements: - element_name: town - line_name: Region max_width: 255 - line_name: Postal Code max_width: 255 elements: - element_name: postcode - line_name: Country max_width: 255 elements: - element_name: country - line_name: MOSAIC Household Type Code max_width: 255 elements: - element_name: mosaicHouseholdTypeCode - line_name: UDPRN max_width: 255 elements: - element_name: udprnKey United Kingdom without DataPlus: value: layout: name: United Kingdom without DataPlus comment: United Kingdom without DataPlus applies_to: - country_iso: GBR datasets: - gb-address options: variation: 1 flatten_diacritics: false enable_enhanced_layout: false display_enhanced_info_on_picklist: false enable_intelligent_layout: false capitalise_unused: false separate_elements: true element_separator: default: ', ' configuration_by_element: buildingNumber: ', ^ ' subBuildingNumber: ', ^ ' postcode: ' ^ ' deliveryPointSuffix: ' ^ ' country: ' ^ ' pafAddressKey: ^ pafOrganisationKey: ^ terminate_lines: false line_terminator: default: ', ' configuration_by_element: postcode: ^ deliveryPointSuffix: ^ country: .^. pad_lines: false multiple_dataplus_delimiter: '|' abbreviate_item: - thoroughfareName - county capitalise_item: - postcode - country lines: - line_name: Line 1 max_width: 255 - line_name: Line 2 max_width: 255 - line_name: Line 3 max_width: 255 - line_name: Locality max_width: 255 elements: - element_name: town - line_name: Region max_width: 255 - line_name: Postal Code max_width: 255 elements: - element_name: postcode - line_name: Country max_width: 255 elements: - element_name: country required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV2CreateResponse' example: result: id: 00000000-0000-0000-0000-000000000000 '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressLayoutsV2 x-operation-id-source: derived get: tags: - Address Validation summary: Gets a list of the address layouts parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: country_iso in: query description: Filters by Country ISO3 schema: type: string - name: datasets in: query description: Filters by Datasets schema: type: array items: type: string - name: name_contains in: query description: Filters by layout name contains text schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV2ListResponse' examples: Sample: value: result: - id: 00000000-0000-0000-0000-000000000000 name: Sample Layout 1 applies_to: - country_iso: GBR datasets: - gb-address status: CreationInProgress - id: 00000000-0000-0000-0000-000000000000 name: Sample Layout 2 applies_to: - country_iso: AUS datasets: - au-address - country_iso: NZL datasets: - nz-address status: Completed '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: getAddressLayoutsV2 x-operation-id-source: derived /address/layouts/v2/{name}: delete: tags: - Address Validation summary: Delete an address layout parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: name in: path description: Layout name to be deleted. required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '408': description: Request Timeout '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: deleteAddressLayoutsV2ByName x-operation-id-source: derived get: tags: - Address Validation summary: Gets an address layout parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: name in: path description: Layout name required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV2GetResponse' examples: United Kingdom: value: result: layout: id: 00000000-0000-0000-0000-000000000000 name: SampleLayout comment: Sample Layout applies_to: - country_iso: GBR datasets: - gb-address options: variation: 1 flatten_diacritics: false enable_enhanced_layout: false display_enhanced_info_on_picklist: false enable_intelligent_layout: false capitalise_unused: false separate_elements: true element_separator: default: ', ' configuration_by_element: buildingNumber: ', ^ ' subBuildingNumber: ', ^ ' postcode: ' ^ ' deliveryPointSuffix: ' ^ ' country: ' ^ ' pafAddressKey: ^ pafOrganisationKey: ^ terminate_lines: false line_terminator: default: ', ' configuration_by_element: postcode: ^ deliveryPointSuffix: ^ country: .^. pad_lines: false multiple_dataplus_delimiter: '|' abbreviate_item: - thoroughfareName - county capitalise_item: - postcode - country lines: - line_name: Line 1 max_width: 255 - line_name: Line 2 max_width: 255 - line_name: Line 3 max_width: 255 - line_name: Locality max_width: 255 elements: - element_name: town - line_name: Region max_width: 255 - line_name: Postal Code max_width: 255 elements: - element_name: postcode - line_name: Country max_width: 255 elements: - element_name: country - line_name: MOSAIC Household Type Code max_width: 255 elements: - element_name: mosaicHouseholdTypeCode - line_name: UDPRN max_width: 255 elements: - element_name: udprnKey status: Completed license_id: SampleLicenseId '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: getAddressLayoutsV2ByName x-operation-id-source: derived put: tags: - Address Validation summary: Updates an address layout parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: name in: path description: Layout name to be updated. required: true schema: type: string requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressLayoutsV2UpdateRequest' examples: United Kingdom with DataPlus: value: layout: id: 11111111-1111-1111-1111-111111111111 name: United Kingdom with DataPlus comment: Updated United Kingdom with DataPlus applies_to: - country_iso: GBR datasets: - gb-address options: variation: 1 flatten_diacritics: false enable_enhanced_layout: false display_enhanced_info_on_picklist: false enable_intelligent_layout: false capitalise_unused: false separate_elements: true element_separator: default: ', ' configuration_by_element: buildingNumber: ', ^ ' subBuildingNumber: ', ^ ' postcode: ' ^ ' deliveryPointSuffix: ' ^ ' country: ' ^ ' pafAddressKey: ^ pafOrganisationKey: ^ terminate_lines: false line_terminator: default: ', ' configuration_by_element: postcode: ^ deliveryPointSuffix: ^ country: .^. pad_lines: false multiple_dataplus_delimiter: '|' abbreviate_item: - thoroughfareName - county capitalise_item: - postcode - country lines: - line_name: Line 1 max_width: 255 - line_name: Line 2 max_width: 255 - line_name: Line 3 max_width: 255 - line_name: Locality max_width: 255 elements: - element_name: town - line_name: Region max_width: 255 - line_name: Postal Code max_width: 255 elements: - element_name: postcode - line_name: Country max_width: 255 elements: - element_name: country - line_name: MOSAIC Household Type Code max_width: 255 elements: - element_name: mosaicHouseholdTypeCode - line_name: UDPRN max_width: 255 elements: - element_name: udprnKey United Kingdom without DataPlus: value: layout: id: 11111111-1111-1111-1111-111111111111 name: United Kingdom without DataPlus comment: Updated United Kingdom without DataPlus applies_to: - country_iso: GBR datasets: - gb-address options: variation: 1 flatten_diacritics: false enable_enhanced_layout: false display_enhanced_info_on_picklist: false enable_intelligent_layout: false capitalise_unused: false separate_elements: true element_separator: default: ', ' configuration_by_element: buildingNumber: ', ^ ' subBuildingNumber: ', ^ ' postcode: ' ^ ' deliveryPointSuffix: ' ^ ' country: ' ^ ' pafAddressKey: ^ pafOrganisationKey: ^ terminate_lines: false line_terminator: default: ', ' configuration_by_element: postcode: ^ deliveryPointSuffix: ^ country: .^. pad_lines: false multiple_dataplus_delimiter: '|' abbreviate_item: - thoroughfareName - county capitalise_item: - postcode - country lines: - line_name: Line 1 max_width: 255 - line_name: Line 2 max_width: 255 - line_name: Line 3 max_width: 255 - line_name: Locality max_width: 255 elements: - element_name: town - line_name: Region max_width: 255 - line_name: Postal Code max_width: 255 elements: - element_name: postcode - line_name: Country max_width: 255 elements: - element_name: country required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: putAddressLayoutsV2ByName x-operation-id-source: derived /address/lookup/v1: post: tags: - Address Validation summary: Lookup an address based on a key parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressLookupV1Request' examples: United Kingdom: value: country_iso: GBR datasets: - gb-address-addressbase key: type: default value: '11606279' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressSearchV1Response' examples: United Kingdom: value: result: more_results_available: false confidence: Verified match suggestions_key: QVBSfjcuNzMwME1BUFJCZ0huQndBQUFBQUZBUUVBQVFBQUFBaEtwYU5ZQUNHUUJnQUFBQUFBQUFBQUFQLi5BQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBLX44fjc suggestions_prompt: Enter selection suggestions: - global_address_key: QVBSfjcuNzMwUk9BUFJCZ0huQndBQUFBQUZBd0VBQUFBSVNxV2pXQUFoa0FZQUFBQUFBQUFBQUFELi53QUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFeE5qQTJNamM1QUFBQUFBQS1-OH43 text: 3 Orford Road, Bromeswell IP12 2PP format: https://api.experianaperture.io/address/format/v1/QVBSfjcuNzMwUk9BUFJCZ0huQndBQUFBQUZBd0VBQUFBSVNxV2pXQUFoa0FZQUFBQUFBQUFBQUFELi53QUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFeE5qQTJNamM1QUFBQUFBQS1-OH43 additional_attributes: - name: picklist_display value: 3 Orford Road, Bromeswell - name: postcode value: IP12 2PP '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressLookupV1 x-operation-id-source: derived /address/lookup/v2: post: tags: - Address Validation summary: Lookup an address based on a key parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: Add-Addresses in: header description: If true an `addresses` field will be populated with concrete addresses in response. schema: type: string - name: Add-FinalAddress in: header description: If true an `addresses_formatted` field will be populated with concrete custom formatted addresses in response. schema: type: boolean default: false requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressLookupV2Request' examples: Australia - postal code: value: country_iso: AUS datasets: - au-address key: type: postal_code value: '3071' Australia G-NAF - partial locality: value: country_iso: AUS datasets: - au-address-gnaf max_addresses: 2 key: type: locality value: thornb United Kingdom - partial postal code: value: country_iso: GBR datasets: - gb-address key: type: postal_code value: nn14 United Kingdom - locality: value: country_iso: GBR datasets: - gb-address max_addresses: 2 key: type: locality value: Birmingham United Kingdom - Unique Delivery Point Reference Number (UDPRN): value: country_iso: GBR datasets: - gb-address key: type: udprn value: '27453340' United Kingdom - Electricity Meter Point Administration Number (MPAN): value: country_iso: GBR datasets: - gb-additional-electricity key: type: mpan value: '1234567890123' layouts: - ElectricityUtilityLookup United Kingdom - Gas Meter Point Reference Number (MPRN): value: country_iso: GBR datasets: - gb-additional-gas key: type: mprn value: '1234567890' layouts: - GasUtilityLookup United States - postal code: value: country_iso: USA datasets: - us-address key: type: postal_code value: '10024' United States - partial locality: value: country_iso: USA datasets: - us-address max_addresses: 2 key: type: locality value: bosto United States - city/state combination: value: country_iso: USA datasets: - us-address key: type: locality value: boston, va United Kingdom - what3words search: value: country_iso: GBR datasets: - gb-address key: type: what3words value: ///pretty.needed.chill United Kingdom - what3words AutoSuggest search: value: country_iso: GBR datasets: - gb-address key: type: what3words value: pretty.needed.chill Japan - postal code latin script: value: country_iso: JPN datasets: - jp-address key: type: postal_code value: 194-0212 preferred_language: - ja preferred_script: - latin Japan - postal code kanji script: value: country_iso: JPN datasets: - jp-address key: type: postal_code value: 194-0212 preferred_language: - ja preferred_script: - kanji Japan - postal code kana script: value: country_iso: JPN datasets: - jp-address key: type: postal_code value: 194-0212 preferred_language: - ja preferred_script: - kana Japan - locality latin script: value: country_iso: JPN datasets: - jp-address key: type: locality value: Machida-Shi preferred_language: - ja preferred_script: - latin Japan - locality kanji script: value: country_iso: JPN datasets: - jp-address key: type: locality value: 町田市 preferred_language: - ja preferred_script: - kanji Japan - partial city: value: country_iso: JPN datasets: - jp-address key: type: locality value: Aomo Japan - city district combination: value: country_iso: JPN datasets: - jp-address key: type: locality value: Aomori-Shi Japan - Kanji script: value: country_iso: JPN datasets: - jp-address-ea key: type: postal_code value: '1320024' preferred_language: - ja preferred_script: - kanji required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressLookupV2Result' examples: Australia - postal code: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: VICTORIA code: VIC town: name: Thornbury postal_code: full_name: '3071' Australia G-NAF - partial locality: value: result: more_results_available: false confidence: Multiple matches suggestions: - locality: region: name: VICTORIA code: VIC town: name: Thornbury postal_code: full_name: '3071' - locality: region: name: QUEENSLAND code: QLD town: name: Thornborough postal_code: full_name: '4871' addresses: - text: 19 Alexandra Street, THORNBURY VIC 3071 matched: - - 21 - 27 global_address_key: aWQ9MTkgQWxleGFuZHJhIFN0cmVldCwgVEhPUk5CVVJZIFZJQyAzMDcxLCBBdXN0cmFsaWF-YWx0X2tleT1HYXZpYzQyMDUwNDMwNX5kYXRhc2V0PUFVU19HTkFGfmZvcm1hdF9rZXk9QVVTJGF1LWFkZHJlc3MtZ25hZi1iZXRhJEdBVklDNDIwNTA0MzA1JCQk format: https://api.experianaperture.io/address/format/v1/aWQ9MTkgQWxleGFuZHJhIFN0cmVldCwgVEhPUk5CVVJZIFZJQyAzMDcxLCBBdXN0cmFsaWF-YWx0X2tleT1HYXZpYzQyMDUwNDMwNX5kYXRhc2V0PUFVU19HTkFGfmZvcm1hdF9rZXk9QVVTJGF1LWFkZHJlc3MtZ25hZi1iZXRhJEdBVklDNDIwNTA0MzA1JCQkflFMPTY - text: 16 Alexandra Street, THORNBURY VIC 3071 matched: - - 21 - 27 global_address_key: aWQ9MTYgQWxleGFuZHJhIFN0cmVldCwgVEhPUk5CVVJZIFZJQyAzMDcxLCBBdXN0cmFsaWF-YWx0X2tleT1HYXZpYzQyMDE3Mjk2OH5kYXRhc2V0PUFVU19HTkFGfmZvcm1hdF9rZXk9QVVTJGF1LWFkZHJlc3MtZ25hZi1iZXRhJEdBVklDNDIwMTcyOTY4JCQk format: https://api.experianaperture.io/address/format/v1/aWQ9MTYgQWxleGFuZHJhIFN0cmVldCwgVEhPUk5CVVJZIFZJQyAzMDcxLCBBdXN0cmFsaWF-YWx0X2tleT1HYXZpYzQyMDE3Mjk2OH5kYXRhc2V0PUFVU19HTkFGfmZvcm1hdF9rZXk9QVVTJGF1LWFkZHJlc3MtZ25hZi1iZXRhJEdBVklDNDIwMTcyOTY4JCQkflFMPTY United Kingdom - partial postal code: value: result: more_results_available: false confidence: No matches suggestions: - locality: town: name: Kettering district: name: Desborough postal_code: full_name: NN14 2JE - locality: town: name: Kettering district: name: Desborough postal_code: full_name: NN14 2JJ - locality: town: name: Kettering district: name: Mawsley postal_code: full_name: NN14 1TR United Kingdom - locality: value: result: more_results_available: false confidence: Multiple matches suggestions: - locality: town: name: Birmingham district: name: Erdington postal_code: full_name: B24 9QR - locality: town: name: Birmingham postal_code: full_name: B31 2JW - locality: town: name: Birmingham district: name: Yardley Wood postal_code: full_name: B14 4DU addresses: - text: Apartment 1903, Beetham Tower, 10 Holloway Circus Queensway, Birmingham, B1 1BA matched: - - 61 - 71 global_address_key: aWQ9QXBhcnRtZW50IDE5MDMsIEJlZXRoYW0gVG93ZXIsIDEwIEhvbGxvd2F5IENpcmN1cyBRdWVlbnN3YXksIEJpcm1pbmdoYW0sIEIxIDFCQSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT01MDMxODkwN35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQ1ZmZlMTUyYS1kM2M2LTRkYTYtOTE1ZS1hODhlZTBhNWUyYzAkJCQ format: https://api.experianaperture.io/address/format/v1/aWQ9QXBhcnRtZW50IDE5MDMsIEJlZXRoYW0gVG93ZXIsIDEwIEhvbGxvd2F5IENpcmN1cyBRdWVlbnN3YXksIEJpcm1pbmdoYW0sIEIxIDFCQSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT01MDMxODkwN35kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQ1ZmZlMTUyYS1kM2M2LTRkYTYtOTE1ZS1hODhlZTBhNWUyYzAkJCR-UUw9MTA - text: Apartment 2107, Beetham Tower, 10 Holloway Circus Queensway, Birmingham, B1 1BA matched: - - 61 - 71 global_address_key: aWQ9QXBhcnRtZW50IDIxMDcsIEJlZXRoYW0gVG93ZXIsIDEwIEhvbGxvd2F5IENpcmN1cyBRdWVlbnN3YXksIEJpcm1pbmdoYW0sIEIxIDFCQSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT01MDMxODkzMH5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQ4MTA0NTMyOC1iZmZjLTQwZDgtOTM0ZS0yMzQ2ZDIzMzA1OWYkJCQ format: https://api.experianaperture.io/address/format/v1/aWQ9QXBhcnRtZW50IDIxMDcsIEJlZXRoYW0gVG93ZXIsIDEwIEhvbGxvd2F5IENpcmN1cyBRdWVlbnN3YXksIEJpcm1pbmdoYW0sIEIxIDFCQSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT01MDMxODkzMH5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQ4MTA0NTMyOC1iZmZjLTQwZDgtOTM0ZS0yMzQ2ZDIzMzA1OWYkJCR-UUw9MTA United Kingdom - Unique Delivery Point Reference Number (UDPRN): value: result: more_results_available: false confidence: No matches suggestions: - locality: town: name: York district: name: Terrington postal_code: full_name: YO60 6PH United Kingdom - Electricity Meter Point Administration Number (MPAN): value: result: more_results_available: false confidence: Verified match suggestions: - locality: sub_region: name: FIFE town: name: KELTY postal_code: full_name: KY4 0BL postal_code_key: aWQ9S1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT1-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkJCQk locality_key: aWQ9S0VMVFksIEZJRkUsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9fmRhdGFzZXQ9R0JSX1BBRn5mb3JtYXRfa2V5PUdCUiRnYi1hZGRyZXNzJCQkJA addresses: - text: 77, STATION ROAD, KELTY, FIFE, KY4 0BL global_address_key: R0JFfn4xM34wfmVsZWM9dHJ1ZX5tcGFuPTE4MDAwMjA5ODIwNzh-aWQ9NzcsIFNUQVRJT04gUk9BRCwgS0VMVFksIEZJRkUsIEtZNCAwQkw format: https://api.experianaperture.io/address/format/v1/R0JFfn4xM34wfmVsZWM9dHJ1ZX5tcGFuPTE4MDAwMjA5ODIwNzh-aWQ9NzcsIFNUQVRJT04gUk9BRCwgS0VMVFksIEZJRkUsIEtZNCAwQkw addresses_formatted: - layout_name: ElectricityUtilityLookup address: electricity_meters: - mpan: '1234567890' address_line_1: '' address_line_2: '' address_line_3: '77' address_line_4: '' address_line_5: STATION ROAD address_line_6: '' address_line_7: '' address_line_8: KELTY address_line_9: FIFE address_postal_code: KY4 0BL trading_status: T trading_status_efd: '19960101' profile_class: '01' profile_class_efd: '20200101' meter_timeswitch_class: '801' meter_timeswitch_class_efd: '20200101' line_loss_factor: '100' line_loss_factor_efd: '20200101' standard_settlement_configuration: 0393 standard_settlement_configuration_efd: '20200101' energisation_status: E energisation_status_efd: '20200101' gsp_group_id: _N gsp_group_efd: '19960101' data_aggregator_mpid: UDMS data_aggregator_efd: '20200101' data_collector_mpid: UDMS data_collector_efd: '20200101' supplier_mpid: TULP supplier_efd: '20200101' meter_operator_mpid: EMSL meter_operator_efd: '20200101' measurement_class: A measurement_class_efd: '20200101' green_deal_in_effect: '0' smso_mpid: '' smso_efd: '' dcc_service_flag: A dcc_service_flag_efd: '20200101' ihd_status: '' ihd_status_efd: '' smets_version: SMETS2 distributor_mpid: SPOW metered_indicator: T metered_indicator_efd: '20170101' metered_indicator_etd: '' consumer_type: Domestic relationship_status_indicator: None rmp_state: O rmp_efd: '19960101' domestic_consumer_indicator: T css_supplier_mpid: '' css_supply_start_date: '' meter_serial_number: '1234567890' meter_install_date: '20200101' meter_type: S2A map_mpid: MLBB map_mpid_efd: '20200101' installing_supplier_mpid: BGAS energy_direction: '' energy_direction_efd: '' energy_direction_etd: '' connection_type: '' connection_type_efd: '' connection_type_etd: '' esme_id: '' meter_location: '' register_digits: '' United Kingdom - Gas Meter Point Reference Number (MPRN): value: result: more_results_available: false confidence: Verified match suggestions: - locality: sub_region: name: FIFE town: name: KELTY postal_code: full_name: KY4 0BL postal_code_key: aWQ9S1k0IDBCTCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT1-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkJCQk locality_key: aWQ9S0VMVFksIEZJRkUsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9fmRhdGFzZXQ9R0JSX1BBRn5mb3JtYXRfa2V5PUdCUiRnYi1hZGRyZXNzJCQkJA addresses: - text: 77, STATION ROAD, KELTY, FIFE, KY4 0BL global_address_key: R0JHfn4xMH4wfmdhcz10cnVlfm1wcm49MTEzNTUxNzAwN35pZD03NywgU1RBVElPTiBST0FELCBLRUxUWSwgS1k0IDBCTA format: https://api.experianaperture.io/address/format/v1/R0JHfn4xMH4wfmdhcz10cnVlfm1wcm49MTEzNTUxNzAwN35pZD03NywgU1RBVElPTiBST0FELCBLRUxUWSwgS1k0IDBCTA addresses_formatted: - layout_name: GasUtilityLookup address: gas_meters: - mprn: '1234567890' uprn: '123456789' rel_address_primary_name: '77' rel_address_secondary_name: '' rel_address_street1: STATION ROAD rel_address_street2: '' rel_address_locality1: '' rel_address_locality2: '' rel_address_town: KELTY rel_address_postcode: KY4 0BL rel_address_logical_status: '1' rel_address_language: ENG rel_address_organisation: '' rel_address_address_type: DPA rel_address_confidence_score: '100' rel_address_classification: RD06 rel_address_latitude: '56.133556' rel_address_longitude: '-3.376114' meter_serial: '12345678901234' offtake_quantity_annual: '5699' meter_point_status: LI installer_id: BGT network_name: Scotland Gas Networks Plc. supplier_name: EDF Energy Customers Limited last_meter_read_date: '20230101' last_meter_read_type: R last_meter_read_value: 03285 United States - postal code: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: code: NY sub_region: name: New York town: name: New York postal_code: primary: '10024' United States - partial locality: value: result: more_results_available: false confidence: Multiple matches suggestions: - locality: region: code: MA sub_region: name: Suffolk town: name: Boston postal_code: primary: 02118 - locality: region: code: MA sub_region: name: Suffolk town: name: Boston postal_code: primary: '02241' addresses: - text: 100 S Salem St, Boston IN 47324 matched: - - 16 - 21 global_address_key: aWQ9MTAwIFMgU2FsZW0gU3QsIEJvc3RvbiBJTiA0NzMyNCwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDEwMCBTIFNhbGVtIFN0fHxCb3N0b24sSU4sNDczMjQtNzcwM35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQ0ZTlhODEyNy1lOTlhLTRkMGUtOGU5Yy0yZmRjYTZiNjAxYjckMTAwJCQ format: https://api.experianaperture.io/address/format/v1/aWQ9MTAwIFMgU2FsZW0gU3QsIEJvc3RvbiBJTiA0NzMyNCwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDEwMCBTIFNhbGVtIFN0fHxCb3N0b24sSU4sNDczMjQtNzcwM35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQ0ZTlhODEyNy1lOTlhLTRkMGUtOGU5Yy0yZmRjYTZiNjAxYjckMTAwJCR-UUw9NQ - text: 101 S Salem St, Boston IN 47324 matched: - - 16 - 21 global_address_key: aWQ9MTAxIFMgU2FsZW0gU3QsIEJvc3RvbiBJTiA0NzMyNCwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDEwMSBTIFNhbGVtIFN0fHxCb3N0b24sSU4sNDczMjQtNzcwM35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQ0ZTlhODEyNy1lOTlhLTRkMGUtOGU5Yy0yZmRjYTZiNjAxYjckMTAxJCQ format: https://api.experianaperture.io/address/format/v1/aWQ9MTAxIFMgU2FsZW0gU3QsIEJvc3RvbiBJTiA0NzMyNCwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDEwMSBTIFNhbGVtIFN0fHxCb3N0b24sSU4sNDczMjQtNzcwM35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQ0ZTlhODEyNy1lOTlhLTRkMGUtOGU5Yy0yZmRjYTZiNjAxYjckMTAxJCR-UUw9NQ United States - city/state combination: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: code: VA sub_region: name: Culpeper town: name: Boston postal_code: primary: Boston - locality: region: code: VA sub_region: name: Rappahannock town: name: Boston postal_code: primary: '22713' United Kingdom - what3words search: value: result: more_results_available: false confidence: Multiple matches addresses: - text: University Of Oxford, Botanic Gardens, High Street, Oxford, OX1 4AZ matched: - [] global_address_key: aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZTNkMDE5NC1mOGYyLTRmYzQtYTEwZC1kZTVkZDZjYTA2OGEkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw format: https://api.experianaperture.io/address/format/v1/aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZTNkMDE5NC1mOGYyLTRmYzQtYTEwZC1kZTVkZDZjYTA2OGEkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGx-UUw9MjI - text: Magdalen College, High Street, Oxford, OX1 4AU matched: - [] global_address_key: aWQ9TWFnZGFsZW4gQ29sbGVnZSwgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBVSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjEzMH5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQyZGQyNWRlMS1kZGIzLTQxMDctOTUxZS1jMjc4NGJmZjc2MmMkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw format: https://api.experianaperture.io/address/format/v1/aWQ9TWFnZGFsZW4gQ29sbGVnZSwgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBVSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjEzMH5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQyZGQyNWRlMS1kZGIzLTQxMDctOTUxZS1jMjc4NGJmZjc2MmMkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGx-UUw9MjI United Kingdom - what3words AutoSuggest search: value: result: more_results_available: false confidence: No matches suggestions: - what3words: name: pretty.needed.chill description: near Oxford, Oxfordshire - what3words: name: pretty.needed.still description: near Plympton, Devon - what3words: name: pretty.needed.skill description: near Calverton, Nottinghamshire Japan - postal code latin script: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: Tokyo sub_region: name: Machida-Shi district: name: Oyamamachi postal_code: full_name: 194-0212 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 Japan - postal code kanji script: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: 東京都 sub_region: name: 町田市 district: name: 小山町 postal_code: full_name: 194-0212 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 Japan - postal code kana script: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: トウキョウト sub_region: name: マチダシ district: name: オヤママチ postal_code: full_name: 194-0212 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 Japan - locality latin script: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: Tokyo sub_region: name: Machida-Shi district: name: Oyamamachi postal_code: full_name: 194-0212 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 Japan - locality kanji script: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: 東京都 sub_region: name: 町田市 district: name: 小山町 postal_code: full_name: 194-0212 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 Japan - partial city: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: Aomori sub_region: name: Aomori-Shi district: name: Oaza Shinjo sub_district: name: Aza Hiraoka postal_code: full_name: 038-0042 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 - locality: region: name: Aomori sub_region: name: Aomori-Shi district: name: Oaza Tsutsui sub_district: name: Aza Yatsuhashi postal_code: full_name: 030-0944 postal_code_key: base64-encoded-postal-code-key-2 locality_key: base64-encoded-locality-key-2 Japan - city district combination: value: result: more_results_available: false confidence: Multiple matches suggestions: - locality: region: name: Aomori sub_region: name: Aomori-Shi district: name: Oaza Shinjo sub_district: name: Aza Hiraoka postal_code: full_name: 038-0042 postal_code_key: base64-encoded-postal-code-key-1 locality_key: base64-encoded-locality-key-1 Japan - Kanji script: value: result: more_results_available: false confidence: No matches suggestions: - locality: region: name: 東京都 sub_region: name: 江戸川区 district: name: 一之江 sub_district: name: 1丁目 postal_code: primary: 132-0024 '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressLookupV2 x-operation-id-source: derived /address/promptsets/v1: post: tags: - Address Validation summary: Get the available prompt sets parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressPromptSetsV1Request' examples: Australia: value: country_iso: AUS datasets: - au-address-datafusion search_type: singleline prompt_set: generic United Kingdom: value: country_iso: GBR datasets: - gb-additional-business search_type: singleline prompt_set: alternate United States: value: country_iso: USA datasets: - us-address search_type: typedown prompt_set: default required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressPromptSetsV1Response' examples: Australia: value: result: lines: - prompt: Building Number or Name suggested_input_length: 40 example: 125v - prompt: Street suggested_input_length: 40 example: Summer St - prompt: Town or City suggested_input_length: 40 example: Boston - prompt: Postal code suggested_input_length: 10 example: 02110-1615 United Kingdom: value: result: lines: - prompt: Building number or name suggested_input_length: 40 example: '12' - prompt: Street suggested_input_length: 40 example: Redacre - prompt: Town suggested_input_length: 40 example: Bristol United States: value: result: lines: - prompt: Enter ZIP code, city name, county name or state code suggested_input_length: 120 example: 02110-1615 '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressPromptsetsV1 x-operation-id-source: derived /address/search/v1: post: tags: - Address Validation summary: Search for an address parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: Transliterate in: header description: Specify if transliteration is expected. schema: type: boolean default: false - name: Add-Retention in: header description: Specify if retention is expected. schema: type: boolean default: true requestBody: description: The request body. content: application/json: schema: $ref: '#/components/schemas/AddressSearchV1Request' examples: Australia - Autocomplete: value: country_iso: AUS datasets: - au-address max_suggestions: 3 components: unspecified: - 56 Queens R Australia DataFusion - Singleline: value: country_iso: AUS datasets: - au-address-datafusion components: unspecified: - 55/49 Queens Road, five dock options: - name: search_type value: singleline - name: prompt_set value: optimal Australia G-NAF - Typedown: value: country_iso: AUS datasets: - au-address-gnaf max_suggestions: 2 components: unspecified: - melbourne options: - name: search_type value: typedown Australia with locality constraints - Autocomplete: value: country_iso: AUS datasets: - au-address max_suggestions: 2 components: unspecified: - 56 Queens R locality: region: exists: true must_be: - NSW must_not_be: - SA United Kingdom - Autocomplete: value: country_iso: GBR datasets: - gb-address max_suggestions: 3 components: unspecified: - 160 bla United Kingdom with Utilities and Business Names - Autocomplete: value: country_iso: GBR datasets: - gb-additional-electricity - gb-additional-gas - gb-additional-business max_suggestions: 3 components: unspecified: - 160 bla United Kingdom with Business Names - Singleline: value: country_iso: GBR datasets: - gb-additional-business components: unspecified: - 160, SE1 8EZ options: - name: search_type value: singleline - name: prompt_set value: optimal United Kingdom with Electricity, Multiple Residence and Not Yet Built - Singleline: value: country_iso: GBR datasets: - gb-additional-electricity - gb-additional-multipleresidence - gb-additional-notyetbuilt components: unspecified: - 160, SE1 8EZ options: - name: search_type value: singleline - name: prompt_set value: optimal - name: flatten value: 'true' United Kingdom with Multiple Residence - Typedown: value: country_iso: GBR datasets: - gb-additional-multipleresidence max_suggestions: 4 components: unspecified: - London options: - name: search_type value: typedown United Kingdom with Names: value: country_iso: GBR datasets: - gb-address-addressbasenames max_suggestions: 3 components: unspecified: - 160 bla names: - forename: John middlename: James surname: Doe United Kingdom with Names - Autocomplete with uprn/premise number: value: country_iso: GBR datasets: - gb-address-addressbasenames max_suggestions: 2 components: unspecified: - '1234' United Kingdom with Names - Autocomplete with w3w: value: country_iso: GBR datasets: - gb-address-addressbasenames max_suggestions: 3 components: unspecified: - ///dog.cat.dog United States - Autocomplete: value: country_iso: USA datasets: - us-address max_suggestions: 2 components: unspecified: - 20 main United States - Autocomplete with location biasing enabled: value: country_iso: USA datasets: - us-address max_suggestions: 2 components: unspecified: - 20 main location: 34.036352, -118.209649 United States with locality constraints - Autocomplete: value: country_iso: USA datasets: - us-address max_suggestions: 2 components: unspecified: - 20 main locality: region: exists: true must_be: - NY must_not_be: - WA United States - Singleline: value: country_iso: USA datasets: - us-address components: unspecified: - 20 Main St, Ste 125, Vista options: - name: search_type value: singleline - name: prompt_set value: optimal United States - Typedown: value: country_iso: USA datasets: - us-address max_suggestions: 2 components: unspecified: - Miami options: - name: search_type value: typedown Japan - Autocomplete, Latin script: value: country_iso: JPN datasets: - jp-address max_suggestions: 5 components: unspecified: - 1-1, Daikan-yamacho, Shibuya-Ku, Tokyo, 150-0034 preferred_language: - ja preferred_script: - latin Japan - Autocomplete, Kanji script: value: country_iso: JPN datasets: - jp-address max_suggestions: 5 components: unspecified: - 1-1, Daikan-yamacho, Shibuya-Ku, Tokyo, 150-0034 preferred_language: - ja preferred_script: - kanji Japan - Autocomplete, Kana script: value: country_iso: JPN datasets: - jp-address max_suggestions: 5 components: unspecified: - 1-1, Daikan-yamacho, Shibuya-Ku, Tokyo, 150-0034 preferred_language: - ja preferred_script: - kana Japan with locality constraints - Autocomplete: value: country_iso: JPN datasets: - jp-address components: unspecified: - Araya Shibuyamachi locality: region: exists: true must_be: - Shibuya must_not_be: - Aomori Japan - Singleline, Preserve input option: value: country_iso: JPN datasets: - jp-address-ed components: unspecified: - '|〒1320024' options: - name: search_type value: singleline - name: prompt_set value: optimal preferred_language: - ja preferred_script: - preserve_input Japan - Singleline, Transliterate: value: country_iso: JPN datasets: - jp-address components: unspecified: - 1-1-23, 虎ノ門東宝ビル 〒105-0001 required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressSearchV1Response' examples: Australia - Autocomplete: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9NTYgUXVlZW5zIFJvYWQsIEFTUVVJVEggIE5TVyAyMDc3LCBBdXN0cmFsaWF-YWx0X2tleT0zNzgyMjk0Nn5kYXRhc2V0PUFVU19QQUZ-Zm9ybWF0X2tleT1BVVMkYXUtYWRkcmVzcyQ3LjczMDFPQVVTSEFybUJ3QUFBQUFJQWdFQUFBQUFDZkQ1Z0FBQUFBQUFBRFUyQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURVMklGRjFaV1Z1Y3lCU0FBQUFBQUEtJCQk text: 56 Queens Road, ASQUITH NSW 2077 matched: - - 3 - 11 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9NTYgUXVlZW5zIFJvYWQsIEFTUVVJVEggIE5TVyAyMDc3LCBBdXN0cmFsaWF-YWx0X2tleT0zNzgyMjk0Nn5kYXRhc2V0PUFVU19QQUZ-Zm9ybWF0X2tleT1BVVMkYXUtYWRkcmVzcyQ3LjczMDFPQVVTSEFybUJ3QUFBQUFJQWdFQUFBQUFDZkQ1Z0FBQUFBQUFBRFUyQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURVMklGRjFaV1Z1Y3lCU0FBQUFBQUEtJCQkflFMPTExfm1heF9zdWdnZXN0aW9ucz03 - global_address_key: aWQ9NTYgUXVlZW5zIFJvYWQsIENPTk5FTExTIFBPSU5UICBOU1cgMjIyMSwgQXVzdHJhbGlhfmFsdF9rZXk9NTk0NTg4MTJ-ZGF0YXNldD1BVVNfUEFGfmZvcm1hdF9rZXk9QVVTJGF1LWFkZHJlc3MkNy43MzBMT0FVU0hBcm1Cd0FBQUFBSUFnRUFBQUFBSVdZN3dBQUFBQUFBQURVMkFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFEVTJJRkYxWldWdWN5QlNBQUFBQUFBLSQkJA text: 56 Queens Road, CONNELLS POINT NSW 2221 matched: - - 3 - 11 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9NTYgUXVlZW5zIFJvYWQsIENPTk5FTExTIFBPSU5UICBOU1cgMjIyMSwgQXVzdHJhbGlhfmFsdF9rZXk9NTk0NTg4MTJ-ZGF0YXNldD1BVVNfUEFGfmZvcm1hdF9rZXk9QVVTJGF1LWFkZHJlc3MkNy43MzBMT0FVU0hBcm1Cd0FBQUFBSUFnRUFBQUFBSVdZN3dBQUFBQUFBQURVMkFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFEVTJJRkYxWldWdWN5QlNBQUFBQUFBLSQkJH5RTD0xMX5tYXhfc3VnZ2VzdGlvbnM9Nw - global_address_key: aWQ9NTYgUXVlZW5zIFJvYWQsIEZJVkUgRE9DSyAgTlNXIDIwNDYsIEF1c3RyYWxpYX5hbHRfa2V5PTkyNDM2MzA0fmRhdGFzZXQ9QVVTX1BBRn5mb3JtYXRfa2V5PUFVUyRhdS1hZGRyZXNzJDcuNzMwYU9BVVNIQXJtQndBQUFBQUlBZ0VBQUFBQUx3QVJ3QUFBQUFBQUFEVTJBQUQuLjJRQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRFUySUZGMVpXVnVjeUJTQUFBQUFBQS0kJCQ text: 56 Queens Road, FIVE DOCK NSW 2046 matched: - - 3 - 11 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9NTYgUXVlZW5zIFJvYWQsIEZJVkUgRE9DSyAgTlNXIDIwNDYsIEF1c3RyYWxpYX5hbHRfa2V5PTkyNDM2MzA0fmRhdGFzZXQ9QVVTX1BBRn5mb3JtYXRfa2V5PUFVUyRhdS1hZGRyZXNzJDcuNzMwYU9BVVNIQXJtQndBQUFBQUlBZ0VBQUFBQUx3QVJ3QUFBQUFBQUFEVTJBQUQuLjJRQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRFUySUZGMVpXVnVjeUJTQUFBQUFBQS0kJCR-UUw9MTF-bWF4X3N1Z2dlc3Rpb25zPTc Australia DataFusion - Singleline: value: result: more_results_available: false confidence: Verified match suggestions_key: QVVFfjcuNzMwbk1BVUVIQWptQndBQUFBQUJBUUVBQVFBQUFBQldzNFdSZ0NFd2doQVlJUUdLRUJBaEFJSVFBQ0VBRGdBQUFBQUFBQUFBQVAuLldnQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUEtfjI4fjc suggestions_prompt: Enter selection suggestions: - global_address_key: QVVFfjcuNzMwSU9BVUVIQWptQndBQUFBQUJBd0VBQUFBQVZyT0ZrWUFoTUlJUUdDRUJpaEFRSVFDQ0VBQWhBQTRBQUFBQUFBQUFBQUQuLjFvQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRFUxTHpRNUlGRjFaV1Z1Y3lCU2IyRmtMQ0JtYVhabElHUnZZMnNBQUFBQUFBLS1-Mjh-Nw text: Unit 55 49-51 Queens Road, FIVE DOCK NSW 2046 format: https://api.experianaperture.io/address/format/v1/QVVFfjcuNzMwSU9BVUVIQWptQndBQUFBQUJBd0VBQUFBQVZyT0ZrWUFoTUlJUUdDRUJpaEFRSVFDQ0VBQWhBQTRBQUFBQUFBQUFBQUQuLjFvQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRFUxTHpRNUlGRjFaV1Z1Y3lCU2IyRmtMQ0JtYVhabElHUnZZMnNBQUFBQUFBLS1-Mjh-Nw additional_attributes: - name: picklist_display value: Unit 55 49-51 Queens Road, FIVE DOCK NSW - name: score value: '90' - name: postcode value: '2046' - name: full_address value: 'true' Australia G-NAF - Typedown: value: result: more_results_available: true confidence: Multiple matches suggestions_prompt: Enter place or postcode suggestions: - global_address_key: QVVHfjcuNzMwNVRBVUdIQWptQndBQUFBQUNBUUFBWUFBQUFBRUFBQUJKMUFZQUFnQUFBRzFsYkdKdmRYSnVaUUEtfjl-Nw text: Melbourne additional_attributes: - name: picklist_display value: Melbourne - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' - global_address_key: QVVHfjcuNzMwMVRBVUdIQWptQndBQUFBQUNBUUFBWUFBQUFBRUFBQUFYMUFZQUFBQUFBRzFsYkdKdmRYSnVaUUEtfjl-Nw text: Melbourne Airport additional_attributes: - name: picklist_display value: Melbourne Airport - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' United Kingdom - Autocomplete: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQk text: 160 Blake Avenue, Barking, IG11 9SD matched: - - 18 - 20 - - 4 - 8 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQkflFMPTc - global_address_key: aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMzQyNmJiZTktZGUxMS00MWRiLTliY2EtNDY2ODQ2NDk1MGI1JCQk text: 160 Black Road, Macclesfield, SK11 7LF matched: - - 4 - 8 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMzQyNmJiZTktZGUxMS00MWRiLTliY2EtNDY2ODQ2NDk1MGI1JCQkflFMPTc - global_address_key: aWQ9MTYwIEJsYWtlcyBBdmVudWUsIFdpdG5leSwgT1gyOCAzVUQsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTgyNjU3NTN-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNmY5YzcxOTctNDE0Yi00ZDA2LTg5M2QtMTA4N2VhM2Y4ZWM1JCQk text: 160 Blakes Avenue, Witney, OX28 3UD matched: - - 4 - 8 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlcyBBdmVudWUsIFdpdG5leSwgT1gyOCAzVUQsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTgyNjU3NTN-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNmY5YzcxOTctNDE0Yi00ZDA2LTg5M2QtMTA4N2VhM2Y4ZWM1JCQkflFMPTc United Kingdom with Utilities and Business Names - Autocomplete: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNDk1YjczNmQtZjM5NS00ODY3LTg1NmItYjZlOWJkYWYxNmZhJCQkfmVsZWM9dHJ1ZX5nYXM9dHJ1ZX5wb3M9MX5nYWtfdHlwZT1hdXRvY29tcGxldGU text: 160 Blake Avenue, Barking, IG11 9SD matched: - - 4 - 7 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkNDk1YjczNmQtZjM5NS00ODY3LTg1NmItYjZlOWJkYWYxNmZhJCQkfnBvcz0xfmdha190eXBlPWF1dG9jb21wbGV0ZX5RTD03fm1heF9zdWdnZXN0aW9ucz0z - global_address_key: aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkZGIyMjFmNDgtZTFiNS00YjQ5LTk1MmUtYmE0MzcyYzdiMzcxJCQkfmVsZWM9dHJ1ZX5nYXM9dHJ1ZX5wb3M9Mn5nYWtfdHlwZT1hdXRvY29tcGxldGU text: 160 Black Road, Macclesfield, SK11 7LF matched: - - 4 - 7 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkZGIyMjFmNDgtZTFiNS00YjQ5LTk1MmUtYmE0MzcyYzdiMzcxJCQkfnBvcz0yfmdha190eXBlPWF1dG9jb21wbGV0ZX5RTD03fm1heF9zdWdnZXN0aW9ucz0z - global_address_key: aWQ9MTYwIEJsYWtlcyBBdmVudWUsIFdpdG5leSwgT1gyOCAzVUQsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTgyNjU3NTN-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkM2UyNWI5MTUtY2EyOC00ZDJiLTkyNTctZGExYmQwYjJmNDYyJCQkfmVsZWM9dHJ1ZX5nYXM9dHJ1ZX5wb3M9M35nYWtfdHlwZT1hdXRvY29tcGxldGU text: 160 Blakes Avenue, Witney, OX28 3UD matched: - - 4 - 7 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlcyBBdmVudWUsIFdpdG5leSwgT1gyOCAzVUQsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTgyNjU3NTN-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkM2UyNWI5MTUtY2EyOC00ZDJiLTkyNTctZGExYmQwYjJmNDYyJCQkfnBvcz0zfmdha190eXBlPWF1dG9jb21wbGV0ZX5RTD03fm1heF9zdWdnZXN0aW9ucz0z United Kingdom with Business Names - Singleline: value: result: more_results_available: true confidence: Multiple matches suggestions_key: R0JCfjcuNzMwY1NHQkJGUXJtQndBQUFBQUJBVEUyTUN3Z1UwVXhJRGhGV2dBcUF3QUF-MTJ-Nw suggestions_prompt: Enter selection suggestions: - global_address_key: R0JCfjcuNzMwTk9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjEwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc text: Axon Communications, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwTk9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjEwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc additional_attributes: - name: picklist_display value: Axon Communications, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: R0JCfjcuNzMwa09HQkJGUXJtQndBQUFBQUJBd0VBQUFBQ1pnZ3gwZ0FoRUFZUkFLQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU1UWXdMQ0JUUlRFZ09FVmFBQUFBQUFBLX4xMn43 text: Azzurri Communications Ltd, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwa09HQkJGUXJtQndBQUFBQUJBd0VBQUFBQ1pnZ3gwZ0FoRUFZUkFLQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU1UWXdMQ0JUUlRFZ09FVmFBQUFBQUFBLX4xMn43 additional_attributes: - name: picklist_display value: Azzurri Communications Ltd, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: R0JCfjcuNzMwbk9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjUwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc text: Clarivate Analytics, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwbk9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjUwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc additional_attributes: - name: picklist_display value: Clarivate Analytics, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: R0JCfjcuNzMwaE9HQkJGUXJtQndBQUFBQUJBd0lBQUFBQm43RjN3REdWc2NTQUNFUUJoRUFvUkFDQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc text: Cqg, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwaE9HQkJGUXJtQndBQUFBQUJBd0lBQUFBQm43RjN3REdWc2NTQUNFUUJoRUFvUkFDQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc additional_attributes: - name: picklist_display value: Cqg, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: R0JCfjcuNzMwU09HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjcwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc text: Experian Data Quality, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwU09HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjcwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc additional_attributes: - name: picklist_display value: Experian Data Quality, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: R0JCfjcuNzMwdU9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQ1pnZzFFZ0FoRUFZUkFLQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU1UWXdMQ0JUUlRFZ09FVmFBQUFBQUFBLX4xMn43 text: Intrinsic Technology Ltd, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwdU9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQ1pnZzFFZ0FoRUFZUkFLQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU1UWXdMQ0JUUlRFZ09FVmFBQUFBQUFBLX4xMn43 additional_attributes: - name: picklist_display value: Intrinsic Technology Ltd, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: R0JCfjcuNzMwWU9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjkwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc text: Madano Partnership, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/R0JCfjcuNzMwWU9HQkJGUXJtQndBQUFBQUJBd0VBQUFBQm43RjkwZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjc additional_attributes: - name: picklist_display value: Madano Partnership, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' United Kingdom with Electricity, Multiple Residence and Not Yet Built - Singleline: value: result: more_results_available: true confidence: Multiple matches suggestions_key: aWQ9fmFsdF9rZXk9fmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMEpNR1g4RX suggestions_prompt: Enter selection suggestions: - global_address_key: aWQ9QXhvbiBDb21tdW5pY2F0aW9ucywgMTYwIEJsYWNrZnJpYXJzIFJvYWQsIExPTkRPTiBTRTEgOEVaLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTUzOTQxMDQzfmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMDVPR1g4RXdmb0J3QUFBQUFCQXdFQUFBQUJqcUMyVWdBaEVBSUFBQUFBQUFBQUFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERTJNQ3dnVTBVeElEaEZXZ0FBQUFBQX5lbGVjPXRydWV-cG9zPTF-Z2FrX3R5cGU9c2luZ2xlbGluZX5RTD0xMn5tYXhfc3VnZ2VzdGlvbnM9Nw text: Axon Communications, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9QXhvbiBDb21tdW5pY2F0aW9ucywgMTYwIEJsYWNrZnJpYXJzIFJvYWQsIExPTkRPTiBTRTEgOEVaLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTUzOTQxMDQzfmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMDVPR1g4RXdmb0J3QUFBQUFCQXdFQUFBQUJqcUMyVWdBaEVBSUFBQUFBQUFBQUFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERTJNQ3dnVTBVeElEaEZXZ0FBQUFBQX5wb3M9MX5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 additional_attributes: - name: picklist_display value: Axon Communications, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: aWQ9QyBRIEcgVUsgTHRkLCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQwMjg4MDF-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwbU9HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxQzRVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfmVsZWM9dHJ1ZX5wb3M9Mn5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 text: C Q G UK Ltd, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9QyBRIEcgVUsgTHRkLCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQwMjg4MDF-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwbU9HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxQzRVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfnBvcz0yfmdha190eXBlPXNpbmdsZWxpbmV-UUw9MTJ-bWF4X3N1Z2dlc3Rpb25zPTc additional_attributes: - name: picklist_display value: C Q G UK Ltd, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: aWQ9Q2xhcml2YXRlIEFuYWx5dGljcywgMTYwIEJsYWNrZnJpYXJzIFJvYWQsIExPTkRPTiBTRTEgOEVaLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTUzNTU5ODY2fmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMFRPR1g4RXdmb0J3QUFBQUFCQXdFQUFBQUJqcUM2VWdBaEVBSUFBQUFBQUFBQUFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERTJNQ3dnVTBVeElEaEZXZ0FBQUFBQX5lbGVjPXRydWV-cG9zPTN-Z2FrX3R5cGU9c2luZ2xlbGluZX5RTD0xMn5tYXhfc3VnZ2VzdGlvbnM9Nw text: Clarivate Analytics, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9Q2xhcml2YXRlIEFuYWx5dGljcywgMTYwIEJsYWNrZnJpYXJzIFJvYWQsIExPTkRPTiBTRTEgOEVaLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTUzNTU5ODY2fmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMFRPR1g4RXdmb0J3QUFBQUFCQXdFQUFBQUJqcUM2VWdBaEVBSUFBQUFBQUFBQUFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERTJNQ3dnVTBVeElEaEZXZ0FBQUFBQX5wb3M9M35nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 additional_attributes: - name: picklist_display value: Clarivate Analytics, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: aWQ9RXhwZXJpYW4gRGF0YSBRdWFsaXR5LCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTUyNDQyNTZ-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwWk9HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxQzhVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfmVsZWM9dHJ1ZX5wb3M9NH5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 text: Experian Data Quality, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9RXhwZXJpYW4gRGF0YSBRdWFsaXR5LCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTUyNDQyNTZ-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwWk9HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxQzhVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfnBvcz00fmdha190eXBlPXNpbmdsZWxpbmV-UUw9MTJ-bWF4X3N1Z2dlc3Rpb25zPTc additional_attributes: - name: picklist_display value: Experian Data Quality, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: aWQ9TWFkYW5vIFBhcnRuZXJzaGlwLCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTM5MzI1MTh-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwa09HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxQ19VZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfmVsZWM9dHJ1ZX5wb3M9NX5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 text: Madano Partnership, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9TWFkYW5vIFBhcnRuZXJzaGlwLCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTM5MzI1MTh-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwa09HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxQ19VZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfnBvcz01fmdha190eXBlPXNpbmdsZWxpbmV-UUw9MTJ-bWF4X3N1Z2dlc3Rpb25zPTc additional_attributes: - name: picklist_display value: Madano Partnership, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: aWQ9TWFpbnRlbCBFdXJvcGUgTHRkLCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQxNzI5MTd-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwOU9HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxREFVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfmVsZWM9dHJ1ZX5wb3M9Nn5nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 text: Maintel Europe Ltd, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9TWFpbnRlbCBFdXJvcGUgTHRkLCAxNjAgQmxhY2tmcmlhcnMgUm9hZCwgTE9ORE9OIFNFMSA4RVosIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9NTQxNzI5MTd-ZGF0YXNldD1HWDh-Zm9ybWF0X2tleT1HQlIkR1g4JDcuNzMwOU9HWDhFd2ZvQndBQUFBQUJBd0VBQUFBQmpxREFVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfnBvcz02fmdha190eXBlPXNpbmdsZWxpbmV-UUw9MTJ-bWF4X3N1Z2dlc3Rpb25zPTc additional_attributes: - name: picklist_display value: Maintel Europe Ltd, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' - global_address_key: aWQ9VGhlIExhYm91ciBQYXJ0eSwgMTYwIEJsYWNrZnJpYXJzIFJvYWQsIExPTkRPTiBTRTEgOEVaLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTU3MjU2NzU4fmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMElPR1g4RXdmb0J3QUFBQUFCQXdFQUFBQUJqcURDVWdBaEVBSUFBQUFBQUFBQUFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERTJNQ3dnVTBVeElEaEZXZ0FBQUFBQX5lbGVjPXRydWV-cG9zPTd-Z2FrX3R5cGU9c2luZ2xlbGluZX5RTD0xMn5tYXhfc3VnZ2VzdGlvbnM9Nw text: The Labour Party, 160 Blackfriars Road, LONDON SE1 8EZ format: https://api.experianaperture.io/address/format/v1/aWQ9VGhlIExhYm91ciBQYXJ0eSwgMTYwIEJsYWNrZnJpYXJzIFJvYWQsIExPTkRPTiBTRTEgOEVaLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PTU3MjU2NzU4fmRhdGFzZXQ9R1g4fmZvcm1hdF9rZXk9R0JSJEdYOCQ3LjczMElPR1g4RXdmb0J3QUFBQUFCQXdFQUFBQUJqcURDVWdBaEVBSUFBQUFBQUFBQUFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERTJNQ3dnVTBVeElEaEZXZ0FBQUFBQX5wb3M9N35nYWtfdHlwZT1zaW5nbGVsaW5lflFMPTEyfm1heF9zdWdnZXN0aW9ucz03 additional_attributes: - name: picklist_display value: The Labour Party, 160 Blackfriars Road, LONDON - name: score value: '100' - name: postcode value: SE1 8EZ - name: full_address value: 'true' United Kingdom with Multiple Residence - Typedown: value: result: more_results_available: true confidence: Multiple matches suggestions_prompt: Enter postcode or place suggestions: - global_address_key: TVJGfjcuNzMwY1RNUkZGUXJtQndBQUFBQUNBUUFBQUFBQUFBSUFBQUJzSHk0QkFBQUFBQUVBZno0QUFBQUFBQUJNYjI1a2IyNEF-Nn40 text: LONDON additional_attributes: - name: picklist_display value: London - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' - global_address_key: TVJGfjcuNzMwSlRNUkZGUXJtQndBQUFBQUNBUUFBUUFBQUFBRUFBQURpSGk0QkFBQUFBRXh2Ym1SdmJnQS1-Nn40 text: London Apprentice additional_attributes: - name: picklist_display value: London Apprentice - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' - global_address_key: TVJGfjcuNzMwOFRNUkZGUXJtQndBQUFBQUNBUUFBQUFBQUFBRUFBQUN3SGk0QkFBQUFBRXh2Ym1SdmJnQS1-Nn40 text: London Colney additional_attributes: - name: picklist_display value: London Colney - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' - global_address_key: TVJGfjcuNzMwclRNUkZGUXJtQndBQUFBQUNBUUFBQUFBUUFBRUFBQUE0SGk0QkFBQUFBRXh2Ym1SdmJnQS1-Nn40 text: London Fields additional_attributes: - name: picklist_display value: London Fields - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' United Kingdom with Names: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQk text: 160 Blake Avenue, Barking, IG11 9SD matched: - - 18 - 20 - - 4 - 8 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQkflFMPTc names: - John James Dow - global_address_key: aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMzQyNmJiZTktZGUxMS00MWRiLTliY2EtNDY2ODQ2NDk1MGI1JCQk text: 160 Black Road, Macclesfield, SK11 7LF matched: - - 4 - 8 - - 0 - 3 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMzQyNmJiZTktZGUxMS00MWRiLTliY2EtNDY2ODQ2NDk1MGI1JCQkflFMPTc names: - John Harow Dow United Kingdom with Names - Autocomplete with uprn/premise number: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQk text: 39 Slymbridge Avenue, Bristol, BS10 7JQ matched: [] format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQkflFMPTc names: - John Dow uprn: '1234' - global_address_key: aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMzQyNmJiZTktZGUxMS00MWRiLTliY2EtNDY2ODQ2NDk1MGI1JCQk text: 1234 Warwick Road, Acocks Green, Birmingham, B27 6PL matched: - - 0 - 4 format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWNrIFJvYWQsIE1hY2NsZXNmaWVsZCwgU0sxMSA3TEYsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MjIxOTc2Njh-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMzQyNmJiZTktZGUxMS00MWRiLTliY2EtNDY2ODQ2NDk1MGI1JCQkflFMPTc names: - Ms Jane Dow uprn: '100070480088' United Kingdom with Names - Autocomplete with w3w: value: result: more_results_available: false confidence: Verified match suggestions: - global_address_key: aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQk text: Dogs At Donyatt, Donyatt, Ilminster, TA19 0RG matched: [] format: https://api.experianaperture.io/address/format/v1/aWQ9MTYwIEJsYWtlIEF2ZW51ZSwgQmFya2luZywgSUcxMSA5U0QsIFVuaXRlZCBLaW5nZG9tfmFsdF9rZXk9MTE0NTE1NzJ-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkMWJhZWFhNjAtNTMyNC00NGQ3LWE3YWItMDBmYjY0ZTNlZjI0JCQkflFMPTc uprn: '30309052' United States - Autocomplete: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MjAgTWFpbiwgQ2FybWVsIE5ZIDEwNTEyLCBVbml0ZWQgU3RhdGVzIE9mIEFtZXJpY2F-YWx0X2tleT18MjAgTWFpbnx8Q2FybWVsLE5ZLDEwNTEyLTE3MTV-ZGF0YXNldD1VU0FfUEFGfmZvcm1hdF9rZXk9VVNBJHVzLWFkZHJlc3MkZjBmMTc4ZGQtMDYzYy00NjMxLTlhZjgtZDVjN2Y2NThhOTg4JDIwJCQ text: 20 Main, Carmel NY 10512 matched: - - 3 - 7 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9MjAgTWFpbiwgQ2FybWVsIE5ZIDEwNTEyLCBVbml0ZWQgU3RhdGVzIE9mIEFtZXJpY2F-YWx0X2tleT18MjAgTWFpbnx8Q2FybWVsLE5ZLDEwNTEyLTE3MTV-ZGF0YXNldD1VU0FfUEFGfmZvcm1hdF9rZXk9VVNBJHVzLWFkZHJlc3MkZjBmMTc4ZGQtMDYzYy00NjMxLTlhZjgtZDVjN2Y2NThhOTg4JDIwJCR-UUw9Nw - global_address_key: aWQ9MjAgTWFpbiBTdGUgMzEwLCBDYXJtZWwgTlkgMTA1MTIsIFVuaXRlZCBTdGF0ZXMgT2YgQW1lcmljYX5hbHRfa2V5PXwyMCBNYWluIFN0ZSAzMTB8fENhcm1lbCxOWSwxMDUxMi0xNzkxfmRhdGFzZXQ9VVNBX1BBRn5mb3JtYXRfa2V5PVVTQSR1cy1hZGRyZXNzJDVkNmRlMzk0LTNkNGItNDkwZC1hY2UxLTQ5N2Y0Yjg4NzhhNSQyMCQzMTAk text: 20 Main Ste 310, Carmel NY 10512 matched: - - 3 - 7 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9MjAgTWFpbiBTdGUgMzEwLCBDYXJtZWwgTlkgMTA1MTIsIFVuaXRlZCBTdGF0ZXMgT2YgQW1lcmljYX5hbHRfa2V5PXwyMCBNYWluIFN0ZSAzMTB8fENhcm1lbCxOWSwxMDUxMi0xNzkxfmRhdGFzZXQ9VVNBX1BBRn5mb3JtYXRfa2V5PVVTQSR1cy1hZGRyZXNzJDVkNmRlMzk0LTNkNGItNDkwZC1hY2UxLTQ5N2Y0Yjg4NzhhNSQyMCQzMTAkflFMPTc United States - Autocomplete with location biasing enabled: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MjAgVyBNYWluIFN0LCBBbGhhbWJyYSBDQSA5MTgwMSwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDIwIFcgTWFpbiBTdHx8QWxoYW1icmEsQ0EsOTE4MDEtMzU1Mn5kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQyODRhODZiZi1lMDlhLTQ1ODItODFjOS1jNDRlNWY3M2FlN2IkMjAkJA text: 20 W Main St, Alhambra CA 91801 matched: - - 5 - 9 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9MjAgVyBNYWluIFN0LCBBbGhhbWJyYSBDQSA5MTgwMSwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDIwIFcgTWFpbiBTdHx8QWxoYW1icmEsQ0EsOTE4MDEtMzU1Mn5kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQyODRhODZiZi1lMDlhLTQ1ODItODFjOS1jNDRlNWY3M2FlN2IkMjAkJH5RTD03fmdlbz1UcnVl - global_address_key: aWQ9MjAgTWFpbiBTdCwgSHVudGluZ3RvbiBCZWFjaCBDQSA5MjY0OCwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDIwIE1haW4gU3R8fEh1bnRpbmd0b24gQmVhY2gsQ0EsOTI2NDgtODE5M35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQ1OTE0YjcxYS1mZTY0LTQ0YWYtYjljYy0zYmM4YmZiMjEzMmIkMjAkJA text: 20 Main St, Huntington Beach CA 92648 matched: - - 3 - 7 - - 0 - 2 format: https://api.experianaperture.io/address/format/v1/aWQ9MjAgTWFpbiBTdCwgSHVudGluZ3RvbiBCZWFjaCBDQSA5MjY0OCwgVW5pdGVkIFN0YXRlcyBPZiBBbWVyaWNhfmFsdF9rZXk9fDIwIE1haW4gU3R8fEh1bnRpbmd0b24gQmVhY2gsQ0EsOTI2NDgtODE5M35kYXRhc2V0PVVTQV9QQUZ-Zm9ybWF0X2tleT1VU0EkdXMtYWRkcmVzcyQ1OTE0YjcxYS1mZTY0LTQ0YWYtYjljYy0zYmM4YmZiMjEzMmIkMjAkJH5RTD03fmdlbz1UcnVl United States - Singleline: value: result: more_results_available: false confidence: Verified match suggestions_key: VVNBfjcuNzMwME1VU0FEd3ZtQndBQUFBQUJBUUVBQVFBQUFBRVptcXBRQ0NFWUFoTVFJQUFBQUFBQUFBQUEuLjlrQUFBQUFQLi4uLjhBQUFBQUFBQUFBQUFBQUFBQUFBLS1-MjZ-Nw suggestions_prompt: Enter selection suggestions: - global_address_key: VVNBfjcuNzMwN09VU0FEd3ZtQndBQUFBQUJBd0VBQUFBQkdacXFVQWdoR0FJVEVDQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU1qQWdUV0ZwYmlCVGRDd2dVM1JsSURFeU5Td2dWbWx6ZEdFQUFBQUFBQS0tfjI2fjc text: 20 Main St Ste 125, Vista CA 92083-5847 format: https://api.experianaperture.io/address/format/v1/VVNBfjcuNzMwN09VU0FEd3ZtQndBQUFBQUJBd0VBQUFBQkdacXFVQWdoR0FJVEVDQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU1qQWdUV0ZwYmlCVGRDd2dVM1JsSURFeU5Td2dWbWx6ZEdFQUFBQUFBQS0tfjI2fjc additional_attributes: - name: picklist_display value: 20 Main St Ste 125, Vista CA - name: score value: '100' - name: postcode value: 92083-5847 - name: full_address value: 'true' United States - Typedown: value: result: more_results_available: true confidence: Multiple matches suggestions_prompt: Enter ZIP code, city name, county name or state code suggestions: - global_address_key: VVNBfjcuNzMwMlRVU0FEd3ZtQndBQUFBQUNBUUFBQUFBQUFBRUFBQUExbWhrQUF3QUFBRTFwWVcxcEFBLS1-NX4y text: Miami additional_attributes: - name: picklist_display value: Miami - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' - global_address_key: VVNBfjcuNzMwV1RVU0FEd3ZtQndBQUFBQUNBUUFBQUFBQUFBRUFBQUFmbVJrQUFnQUFBRTFwWVcxcEFBLS1-NX4y text: Miami Beach additional_attributes: - name: picklist_display value: Miami Beach - name: score value: '0' - name: can_step_in value: 'true' - name: multiples value: 'true' Japan - Autocomplete, Latin script: value: result: more_results_available: false confidence: Verified match suggestions: - global_address_key: base64-encoded-global-address-key-1 text: 1-1, Daikan-yamacho, Shibuya-Ku, Tokyo, 150-0034 matched: [] format: https://api.experianaperture.io/address/format/v1/{global_address_key_1} Japan - Autocomplete, Kanji script: value: result: more_results_available: false confidence: Verified match suggestions: - global_address_key: base64-encoded-global-address-key-1 text: 〒150-0034 東京都渋谷区代官山町1-1 matched: [] format: https://api.experianaperture.io/address/format/v1/{global_address_key_1} Japan - Autocomplete, Kana script: value: result: more_results_available: false confidence: Verified match suggestions: - global_address_key: base64-encoded-global-address-key-1 text: 〒150-0034 トウキョウト シブヤク ダイカンヤマチョウ 1-1 matched: [] format: https://api.experianaperture.io/address/format/v1/{global_address_key_1} Japan with locality constraints - Autocomplete: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: base64-encoded-global-address-key-1 text: 1-11-5, Araya Shibuyamachi, Akita-Shi, Akita, 010-1642 matched: - - 14 - 26 - - 8 - 13 format: https://api.experianaperture.io/address/format/v1/{global_address_key_1} Japan - Singleline, Preserve input option: value: result: more_results_available: true confidence: Multiple matches suggestions_key: aWQ9fmFsdF9rZXk9fmRhdGFzZXQ9SlBOfmZvcm1hdF9rZXk9SlBOJEpQTiRBRFJKUE4vSU1BQUFNQUFJTUFBSU1BQUFNQUFJTUFBSU1BQWFNQUF9SUFBQU1BQX1JQUF9UUFBQV1BQVFdQUFlWUFBdVlBQUVZQUFxWUFBfUlBQX1JQUF1SUFBRU1BQX1JQUFxXUFBSUVBTUVNQUFNTUFBSU1BQUFNQUFBTUFBSU1BQVFNQUF-UUw9OX5tYXhfc3VnZ2VzdGlvbnM9Nw suggestions_prompt: Select an address suggestions: - global_address_key: aWQ944CSMTMyLTAwMjTmnbHkuqzpg73msZ_miLjlt53ljLrkuIDkuYvmsZ_vvJHkuIHnm67vvJHvvJYsIEphcGFufmFsdF9rZXk9fmRhdGFzZXQ9SlBOfmZvcm1hdF9rZXk9SlBOJEpQTiRBRFJKUE4vSU1BQUFNQUFJTUFBSU1BQUFNQUFJTUFBSU1BQWFNQUF9SUFBQU1BQX1JQUF9UUFBQV1BQVFdQUFlWUFBdVlBQUVZQUFxWUFBfUlBQX1JQUFBTUFBfUlBQXFdQUFJRUFNRU1BQU1NQUFJTUFBQU1BQUFNQUFJTUFBUU1BQX5RTD05fm1heF9zdWdnZXN0aW9ucz03 text: 〒132-0024東京都江戸川区一之江１丁目１６ format: https://api.experianaperture.io/address/format/v1/aWQ944CSMTMyLTAwMjTmnbHkuqzpg73msZ_miLjlt53ljLrkuIDkuYvmsZ_vvJHkuIHnm67vvJHvvJYsIEphcGFufmFsdF9rZXk9fmRhdGFzZXQ9SlBOfmZvcm1hdF9rZXk9SlBOJEpQTiRBRFJKUE4vSU1BQUFNQUFJTUFBSU1BQUFNQUFJTUFBSU1BQWFNQUF9SUFBQU1BQX1JQUF9UUFBQV1BQVFdQUFlWUFBdVlBQUVZQUFxWUFBfUlBQX1JQUFBTUFBfUlBQXFdQUFJRUFNRU1BQU1NQUFJTUFBQU1BQUFNQUFJTUFBUU1BQX5RTD05fm1heF9zdWdnZXN0aW9ucz03 additional_attributes: - name: picklist_display value: 〒132-0024東京都江戸川区一之江１丁目１６ - name: score value: '100' - name: full_address value: 'true' Japan - Singleline, Transliterate: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MS0xLTIzLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQyOWU3ODJiZS03NDI4LTQzYzgtOTlhNC0xOThhMDk0ODNkYzgkMS0xLTIzJCR-cG9zPTF-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-23, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTIzLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQyOWU3ODJiZS03NDI4LTQzYzgtOTlhNC0xOThhMDk0ODNkYzgkMS0xLTIzJCR-cG9zPTF-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl - global_address_key: aWQ9MS0xLTEwLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQ0NWY5NGY4OC1jZmU3LTRiZDMtYjU3ZC01YzQ3NzEwODRkZTAkMS0xLTEwJCR-cG9zPTJ-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-10, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTEwLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQ0NWY5NGY4OC1jZmU3LTRiZDMtYjU3ZC01YzQ3NzEwODRkZTAkMS0xLTEwJCR-cG9zPTJ-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl - global_address_key: aWQ9MS0xLTExLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQ2MWQ3ZjE5OS0wMzJhLTQ4MzktOTUzNi0wYTE4NjhiOWQ5YWUkMS0xLTExJCR-cG9zPTN-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-11, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTExLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQ2MWQ3ZjE5OS0wMzJhLTQ4MzktOTUzNi0wYTE4NjhiOWQ5YWUkMS0xLTExJCR-cG9zPTN-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl - global_address_key: aWQ9MS0xLTEyLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQ4MDkwNDg2OC0zMTlmLTQ5ZDQtYjI1OS0yOTA4NGNiOWRkNWMkMS0xLTEyJCR-cG9zPTR-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-12, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTEyLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQ4MDkwNDg2OC0zMTlmLTQ5ZDQtYjI1OS0yOTA4NGNiOWRkNWMkMS0xLTEyJCR-cG9zPTR-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl - global_address_key: aWQ9MS0xLTEzLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQwMjYyZTk4Yi04MzBmLTQ1NGYtODIwNC0xMGZlMjYzYzBiZTkkMS0xLTEzJCR-cG9zPTV-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-13, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTEzLCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQwMjYyZTk4Yi04MzBmLTQ1NGYtODIwNC0xMGZlMjYzYzBiZTkkMS0xLTEzJCR-cG9zPTV-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl - global_address_key: aWQ9MS0xLTE1LCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQxODhhN2JmMC0zNGQ4LTRmYjUtYjc3Ni1jZmM0YjY0NGQ5N2MkMS0xLTE1JCR-cG9zPTZ-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-15, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTE1LCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyQxODhhN2JmMC0zNGQ4LTRmYjUtYjc3Ni1jZmM0YjY0NGQ5N2MkMS0xLTE1JCR-cG9zPTZ-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl - global_address_key: aWQ9MS0xLTE2LCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyRjODg4MGVjMy1mOWI5LTQ2NTYtOWNiZi0xNGQ2NmVjMGFiYzckMS0xLTE2JCR-cG9zPTd-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl text: 1-1-16, Toranomon, Minato-Ku, Tokyo, 105-0001 format: https://api.experianaperture.io/address/format/v1/aWQ9MS0xLTE2LCBUb3Jhbm9tb24sIE1pbmF0by1LdSwgVG9reW8sIDEwNS0wMDAxLCBKQVBBTn5hbHRfa2V5PX5kYXRhc2V0PUpQTl9LT0tVU0FJS09HWU9-Zm9ybWF0X2tleT1KUE4kanAtYWRkcmVzcyRjODg4MGVjMy1mOWI5LTQ2NTYtOWNiZi0xNGQ2NmVjMGFiYzckMS0xLTE2JCR-cG9zPTd-Z2FrX3R5cGU9YXV0b2NvbXBsZXRl '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressSearchV1 x-operation-id-source: derived /address/suggestions/stepin/v1/{global_address_key}: get: tags: - Address Validation summary: Step into a suggestion parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: global_address_key in: path description: Global address key. required: true schema: maxLength: 4000 minLength: 0 pattern: ^(?:[A-Za-z0-9_-]*)$ type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionsV1Response' examples: United Kingdom: value: result: more_results_available: false confidence: Verified match suggestions_key: R0JSfjcuNzMwUk1HQlJGQWpsQndBQUFBQUJBUUVBQVFBQUFBQ0ltWHVSZ0NFd2doTUFJQUFBQUFBQkFFRndZWEowYldWdWRDQXhOUUEzT1FBQS4uOVFBQUFBQVAuLi4uOEFBQUFBQUFBQUFBQUFBQUFBQUEtLX40Mg suggestions_prompt: Enter selection suggestions: - global_address_key: R0JSfjcuNzMwVU9HQlJGQWpsQndBQUFBQUJBd0VBQUFBQWlKbDdrWUFoTUlJVEFDQUFBQUFBQVFCQmNHRnlkRzFsYm5RZ01UVUFOemtBQVAuLlVBQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUFBUVhCaGNuUnRaVzUwSURFMUxDQTNPU0JUZEdGMGFXOXVJRkp2WVdRc0lFdEZURlJaTENCR2FXWmxBQUFBQUFBLX40Mg text: Apartment 15, 79 Station Road, KELTY, Fife KY4 0BL format: https://api.experianaperture.io/address/format/v1/R0JSfjcuNzMwVU9HQlJGQWpsQndBQUFBQUJBd0VBQUFBQWlKbDdrWUFoTUlJVEFDQUFBQUFBQVFCQmNHRnlkRzFsYm5RZ01UVUFOemtBQVAuLlVBQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUFBUVhCaGNuUnRaVzUwSURFMUxDQTNPU0JUZEdGMGFXOXVJRkp2WVdRc0lFdEZURlJaTENCR2FXWmxBQUFBQUFBLX40Mg additional_attributes: - name: picklist_display value: Apartment 15, 79 Station Road, KELTY, Fife - name: score value: '100' - name: postcode value: KY4 0BL USA with address clustering: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MSBNYWluIFN0IFN0ZSAxMDEsIEFuZG92ZXIgTUEgMDE4M text: 1 Main St Ste 101, Andover MA 01810 matched: - - 30 - 35 - - 27 - 29 - - 19 - 26 format: https://api.experianaperture.io/address/format/v1/aWQ9MSBNYWluIFN0IFN0ZSAxMDEsIEFuZG92ZXIgTUEgMDE4M - global_address_key: aWQ9MSBNYWluIFN0IFN0ZSAxMDIsIEFuZG92ZXIgTUEgMDE4MTAs text: 1 Main St Ste 102, Andover MA 01810 matched: - - 30 - 35 - - 27 - 29 - - 19 - 26 format: https://api.experianaperture.io/address/format/v1/aWQ9MSBNYWluIFN0IFN0ZSAxMDIsIEFuZG92ZXIgTUEgMDE4MTAs - global_address_key: aWQ9MSBNYWluIFN0IFN0ZSAxMDMsIEFuZG92ZXIgTUEgMDE4MTAsIFVua text: 1 Main St Ste 103, Andover MA 01810 matched: - - 30 - 35 - - 27 - 29 - - 19 - 26 format: https://api.experianaperture.io/address/format/v1/aWQ9MSBNYWluIFN0IFN0ZSAxMDMsIEFuZG92ZXIgTUEgMDE4MTAsIFVua '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: getAddressSuggestionsStepinV1ByGlobalAddressKey x-operation-id-source: derived /address/suggestions/refine/v1/{key}: post: tags: - Address Validation summary: Refine a suggestion parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: key in: path description: Global_address_key or suggestions_key. required: true schema: maxLength: 4000 minLength: 0 pattern: ^(?:[A-Za-z0-9_-]*)$ type: string requestBody: description: Request body. content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionsV1Request' example: refinement: Apartment 15 required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionsV1Response' examples: United Kingdom: value: result: more_results_available: false confidence: Verified match suggestions_key: R0JSfjcuNzMwUk1HQlJGQWpsQndBQUFBQUJBUUVBQVFBQUFBQ0ltWHVSZ0NFd2doTUFJQUFBQUFBQkFFRndZWEowYldWdWRDQXhOUUEzT1FBQS4uOVFBQUFBQVAuLi4uOEFBQUFBQUFBQUFBQUFBQUFBQUEtLX40Mg suggestions_prompt: Enter selection suggestions: - global_address_key: R0JSfjcuNzMwVU9HQlJGQWpsQndBQUFBQUJBd0VBQUFBQWlKbDdrWUFoTUlJVEFDQUFBQUFBQVFCQmNHRnlkRzFsYm5RZ01UVUFOemtBQVAuLlVBQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUFBUVhCaGNuUnRaVzUwSURFMUxDQTNPU0JUZEdGMGFXOXVJRkp2WVdRc0lFdEZURlJaTENCR2FXWmxBQUFBQUFBLX40Mg text: Apartment 15, 79 Station Road, KELTY, Fife KY4 0BL format: https://api.experianaperture.io/address/format/v1/R0JSfjcuNzMwVU9HQlJGQWpsQndBQUFBQUJBd0VBQUFBQWlKbDdrWUFoTUlJVEFDQUFBQUFBQVFCQmNHRnlkRzFsYm5RZ01UVUFOemtBQVAuLlVBQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUFBUVhCaGNuUnRaVzUwSURFMUxDQTNPU0JUZEdGMGFXOXVJRkp2WVdRc0lFdEZURlJaTENCR2FXWmxBQUFBQUFBLX40Mg additional_attributes: - name: picklist_display value: Apartment 15, 79 Station Road, KELTY, Fife - name: score value: '100' - name: postcode value: KY4 0BL USA with address clustering: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: aWQ9MSBNYWluIFN0IFN0ZSAxMDEsIEFuZG92ZXIgTUEgMDE4M text: 1 Main St Ste 101, Andover MA 01810 matched: - - 30 - 35 - - 27 - 29 - - 19 - 26 format: https://api.experianaperture.io/address/format/v1/aWQ9MSBNYWluIFN0IFN0ZSAxMDEsIEFuZG92ZXIgTUEgMDE4M - global_address_key: aWQ9MSBNYWluIFN0IFN0ZSAxMDIsIEFuZG92ZXIgTUEgMDE4MTAs text: 1 Main St Ste 102, Andover MA 01810 matched: - - 30 - 35 - - 27 - 29 - - 19 - 26 format: https://api.experianaperture.io/address/format/v1/aWQ9MSBNYWluIFN0IFN0ZSAxMDIsIEFuZG92ZXIgTUEgMDE4MTAs - global_address_key: aWQ9MSBNYWluIFN0IFN0ZSAxMDMsIEFuZG92ZXIgTUEgMDE4MTAsIFVua text: 1 Main St Ste 103, Andover MA 01810 matched: - - 30 - 35 - - 27 - 29 - - 19 - 26 format: https://api.experianaperture.io/address/format/v1/aWQ9MSBNYWluIFN0IFN0ZSAxMDMsIEFuZG92ZXIgTUEgMDE4MTAsIFVua '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressSuggestionsRefineV1ByKey x-operation-id-source: derived /address/suggestions/format/v1: post: tags: - Address Validation summary: Search and format a list of suggestions parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: Add-Components in: header description: Specifies if the response should contain the address broken down into its components. schema: type: boolean default: false - name: Add-Metadata in: header description: Specify whether the response should return all fields and values, in addition to the main core information. schema: type: boolean default: false requestBody: description: The request body. content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionsFormatV1Request' examples: Postcode and one additional item 1: value: country_iso: GBR datasets: - gb-address max_suggestions: 2 components: unspecified: - 160, SE1 8EZ layouts: - default_classic Postcode and one additional item 2: value: country_iso: GBR datasets: - gb-address max_suggestions: 2 components: unspecified: - Blackfriars Road, SE1 9GD layouts: - default_classic Address elements 1: value: country_iso: GBR datasets: - gb-address max_suggestions: 2 components: unspecified: - 1 Bedmond Road,abbots langley layouts: - default_classic Address elements 2: value: country_iso: GBR datasets: - gb-address max_suggestions: 2 components: unspecified: - Beck Cottage, Fox Road layouts: - default_classic required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionsFormatV1Response' examples: Postcode and one additional item 1: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: R0JSfjcuNzMwLk9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQm5JZVpVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjI addresses_formatted: - layout_name: default_classic address: LINE_1: Axon Communications LINE_2: 160 Blackfriars Road Town: LONDON County: '' Postcode: SE1 8EZ - global_address_key: R0JSfjcuNzMwV09HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQm5JZWJVZ0FoRUFJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFMk1Dd2dVMFV4SURoRldnQUFBQUFBfjEyfjI addresses_formatted: - layout_name: default_classic address: LINE_1: C Q G UK Ltd LINE_2: 160 Blackfriars Road Town: LONDON County: '' Postcode: SE1 8EZ Postcode and one additional item 2: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: R0JSfjcuNzMwVU9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQm5LQ0hVZ0FoR0FJUkFDQUFBQUFBQUFBQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQVFteGhZMnRtY21saGNuTWdVbTloWkN3Z1UwVXhJRGxIUkFBQUFBQUF-MjV-Mg addresses_formatted: - layout_name: default_classic address: LINE_1: One Blackfriars LINE_2: 1 Blackfriars Road Town: LONDON County: '' Postcode: SE1 9GD - global_address_key: R0JSfjcuNzMwa09HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQm5LQ0pVZ0FoR0FJQUFBQUFBQUFBTVFBQS4uOWtBQUFBQVAuLi4uOEFBQUFBQUFBQUFBQUFBQUFBQUFCQ2JHRmphMlp5YVdGeWN5QlNiMkZrTENCVFJURWdPVWRFQUFBQUFBQS1-MjV-Mg addresses_formatted: - layout_name: default_classic address: LINE_1: Apartment 1 LINE_2: 1 Blackfriars Road Town: LONDON County: '' Postcode: SE1 9GD Address elements 1: value: result: more_results_available: true confidence: Multiple matches suggestions: - global_address_key: R0JSfjcuNzMwUE9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQW96N0NFWUFoTUlJUUFHQUFBQUFBQUFBeEFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERWdRbVZrYlc5dVpDQlNiMkZrTEdGaVltOTBjeUJzWVc1bmJHVjVBQUFBQUFBLX4yOX4y addresses_formatted: - layout_name: default_classic address: LINE_1: 1 Cecil Lodge Cottages LINE_2: Bedmond Road Town: ABBOTS LANGLEY County: Hertfordshire Postcode: WD5 0QB - global_address_key: R0JSfjcuNzMwSk9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQW96N0dVWUFoTUlJUUFHQUFBQUFBQUFBeEFBRC4uMlFBQUFBQS4uLi4ud0FBQUFBQUFBQUFBQUFBQUFBQUFERWdRbVZrYlc5dVpDQlNiMkZrTEdGaVltOTBjeUJzWVc1bmJHVjVBQUFBQUFBLX4yOX4y addresses_formatted: - layout_name: default_classic address: LINE_1: 1 Mansion House Farm LINE_2: Bedmond Road Town: ABBOTS LANGLEY County: Hertfordshire Postcode: WD5 0QB Address elements 2: value: result: more_results_available: false confidence: Verified match suggestions: - global_address_key: R0JSfjcuNzMwcE9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQkJrSFVFQUJoR0FJQUFBQUFBQUFBQUFELi4yUUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQUVKbFkyc2dRMjkwZEdGblpTd2dSbTk0SUZKdllXUUFBQUFBQUEtLX4yMn4xMA addresses_formatted: - layout_name: default_classic address: LINE_1: Beck Cottage, Fox Road LINE_2: Framingham Pigot Town: NORWICH County: '' Postcode: NR14 7PZ '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressSuggestionsFormatV1 x-operation-id-source: derived /address/validate/v1: post: tags: - Address Validation summary: Validate an address parameters: - name: Reference-Id in: header description: Optional identifier that will be returned in the response to help you track the request. schema: maxLength: 256 minLength: 0 pattern: ^[\w\-\/\:\.\,\(\) ]+$ type: string - name: Timeout-Seconds in: header description: 'Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.' schema: maximum: 15 minimum: 2 type: integer format: int32 - name: Add-Components in: header description: Specifies if the response should contain the address broken down into its components. schema: type: boolean default: false - name: Add-Metadata in: header description: Specify whether the response should return all fields and values, in addition to the main core information. schema: type: boolean default: false - name: Add-Enrichment in: header description: Specify whether to call Enrichment service after successful validation. schema: type: boolean default: false - name: Add-ExtraMatchInfo in: header description: Specify whther to include validation match info details. schema: type: boolean default: false requestBody: description: The request body. content: application/json: schema: $ref: '#/components/schemas/AddressValidateV1Request' examples: Australia: value: country_iso: AUS datasets: - au-address components: unspecified: - Unit 1, 8 Main Ave, Lidcombe, 2141 options: - name: prompt_set value: default - name: flatten value: 'true' - name: intensity value: exact layouts: - default layout_format: default Australia With Enrichment - Geocodes: value: country_iso: AUS datasets: - au-address components: unspecified: - Unit 1, 8 Main Ave, Lidcombe, 2141 attributes: geocodes: - latitude - longitude - match_level layout_format: default France: value: country_iso: FRA datasets: - fr-address components: unspecified: - 1 l Experience, 35610 ROZ SUR COUESNON options: - name: prompt_set value: OneLine - name: flatten value: 'true' - name: intensity value: close layouts: - default layout_format: default Netherlands: value: country_iso: NLD datasets: - nl-address components: unspecified: - Esperantolaan 10-1, 6824 LW ARNHEM options: - name: prompt_set value: OneLine - name: flatten value: 'true' - name: intensity value: close layouts: - default layout_format: default New Zealand: value: country_iso: NZL datasets: - nz-address components: unspecified: - 70 Shortland Street,Auckland Central, Auckland 1010 options: - name: prompt_set value: OneLine - name: flatten value: 'true' - name: intensity value: close layouts: - default layout_format: default Singapore: value: country_iso: SGP datasets: - sg-address components: unspecified: - 70 Shortland Street,Auckland Central, Auckland 1010 options: - name: prompt_set value: OneLine - name: flatten value: 'true' - name: intensity value: close layouts: - default layout_format: default United Kingdom: value: country_iso: GBR datasets: - gb-additional-multipleresidence components: unspecified: - 79 Station road, kelty options: - name: prompt_set value: default - name: flatten value: 'true' - name: intensity value: close layouts: - default layout_format: default United Kingdom With Enrichment: value: country_iso: GBR datasets: - gb-additional-multipleresidence components: unspecified: - 79 Station road, kelty attributes: geocodes: - latitude - longitude - match_level layout_format: default United States: value: country_iso: USA datasets: - us-address components: unspecified: - 77 Massachusetts Ave, Cambridgea, MA 02139-4307 options: - name: prompt_set value: default - name: flatten value: 'true' - name: intensity value: exact layouts: - default layout_format: default United Kingdom With Mosaic: value: country_iso: GBR datasets: - gb-address components: unspecified: - Flat A, Falcon Buildings, 2 Dunbar Street, ABERDEEN AB24 3UD options: - name: prompt_set value: default - name: flatten value: 'true' - name: intensity value: exact attributes: gbr_mosaic: - household - postal_code layouts: - default layout_format: default United Kingdom With Location Grid: value: country_iso: GBR datasets: - gb-address components: unspecified: - Flat A, Falcon Buildings, 2 Dunbar Street, ABERDEEN AB24 3UD options: - name: prompt_set value: default - name: flatten value: 'true' - name: intensity value: exact attributes: gbr_location_grid: - postzon - codepoint layouts: - default layout_format: default required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AddressValidateV1Response' examples: Australia: value: result: confidence: Verified match address: address_line_1: U 1 8 Main Ave address_line_2: '' address_line_3: '' locality: LIDCOMBE region: NSW postal_code: '2141' country: AUSTRALIA Australia with ExtraMatchInfo: value: result: confidence: Verified match address: address_line_1: U 1 8 Main Ave address_line_2: '' address_line_3: '' locality: LIDCOMBE region: NSW postal_code: '2141' country: AUSTRALIA match_type: full_with_post_code match_confidence: high match_info: postcode_action: ok address_action: corrected generic_info: - address_cleaned - verified_correct aus_info: - bsp_state_nsw Australia With Enrichment - Geocodes: value: result: confidence: Verified match address: address_line_1: U 1 8 Main Ave address_line_2: '' address_line_3: '' locality: LIDCOMBE region: NSW postal_code: '2141' country: AUSTRALIA enrichment: transaction_id: 3744bdf6-34ae-42ae-8bc3-522db47a4fc5 result: geocodes: latitude: -33.88247 longitude: 151.04478 match_level: building metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. France with Extra Match Info: value: result: confidence: Verified match address: address_line_1: 1 L EXPERIENCE address_line_2: '' address_line_3: '' locality: ROZ SUR COUESNON region: Ille-et-Vilaine postal_code: '35610' country: France match_type: full_with_post_code match_confidence: high match_info: postcode_action: ok address_action: corrected generic_info: - address_cleaned - verified_correct fra_info: - corrected Netherlands with Extra Match Info: value: result: confidence: Verified match address: address_line_1: '' address_line_2: '' address_line_3: Esperantolaan 10-1 locality: ARNHEM region: Gelderland postal_code: 6824 LW country: NETHERLANDS match_type: full_with_post_code match_confidence: high match_info: postcode_action: ok address_action: corrected generic_info: - address_cleaned - verified_correct nld_info: - nen_street_matched - nen_town_matched New Zealand with Extra Match Info: value: result: confidence: Verified match address: address_line_1: 70 Shortland Street address_line_2: '' address_line_3: '' locality: Auckland Central region: AUCKLAND postal_code: '1010' country: NEW ZEALAND match_type: full_with_post_code match_confidence: high match_info: postcode_action: ok address_action: corrected generic_info: - address_cleaned - verified_correct nld_info: - sendright_valid_match Singapore with Extra Match Info: value: result: confidence: Verified match address: address_line_1: 331 North Bridge Road address_line_2: '#05-04/06 Odeon 331' address_line_3: '' locality: Singapore region: '' postal_code: '188720' country: SINGAPORE match_type: full_with_post_code match_confidence: high match_info: postcode_action: ok address_action: corrected generic_info: - address_cleaned - verified_correct sgp_info: - add_unit_retained United Kingdom: value: result: confidence: Verified match address: address_line_1: 79 Station Road address_line_2: '' address_line_3: '' locality: KELTY region: '' postal_code: KY4 0BL country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: KY4 0BL primary: KY4 0BL building: building_number: '79' street: full_name: Station Road name: Station type: Road locality: region: name: Fife town: name: KELTY metadata: address_info: identifier: udprn: '12353232' paf_address_key: 2304084100000000S barcode: delivery_point_barcode: (KY40BL2Z2) United Kingdom with Extra Match Info: value: result: confidence: Verified match address: address_line_1: 79 Station Road address_line_2: '' address_line_3: '' locality: KELTY region: '' postal_code: KY4 0BL country: UNITED KINGDOM match_type: full_with_post_code match_confidence: high match_info: postcode_action: added address_action: corrected generic_info: - address_cleaned gbr_info: - county_changed United Kingdom - suggestions: value: result: more_results_available: false confidence: Street partial suggestions_key: R0JSfjcuNzMwMlNHQlJGQWpsQndBQUFBQUVBVk4wWVhScGIyNGdVbTloWkN3Z1MwVk1WRmtzSUVacFptVWdTMWswSURCQ1RnQXFBd0FBfjMz suggestions_prompt: Enter selection suggestions: - global_address_key: R0JSfjcuNzMwRU9HQlJGQWpsQndBQUFBQUVBd0VBQUFBQWlKbUhVUUFnQUFBQUFBQUFBQUQuLjJRQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRk4wWVhScGIyNGdVbTloWkN3Z1MwVk1WRmtzSUVacFptVWdTMWswSURCQ1RnQUFBQUFBfjMz text: Kelty Parish Church, Station Road, KELTY, Fife KY4 0BN format: https://api.experianaperture.io/address/format/v1/R0JSfjcuNzMwRU9HQlJGQWpsQndBQUFBQUVBd0VBQUFBQWlKbUhVUUFnQUFBQUFBQUFBQUQuLjJRQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRk4wWVhScGIyNGdVbTloWkN3Z1MwVk1WRmtzSUVacFptVWdTMWswSURCQ1RnQUFBQUFBfjMz additional_attributes: - name: picklist_display value: Kelty Parish Church, Station Road, KELTY, Fife - name: score value: '100' - name: postcode value: KY4 0BN - global_address_key: R0JSfjcuNzMwU09HQlJGQWpsQndBQUFBQUVBd0VBQUFBQWlKbUpVQUFnQUFBQUFBQUFBQUQuLjJRQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRk4wWVhScGIyNGdVbTloWkN3Z1MwVk1WRmtzSUVacFptVWdTMWswSURCQ1RnQUFBQUFBfjMz text: 5 Station Road, KELTY, Fife KY4 0BL format: https://api.experianaperture.io/address/format/v1/R0JSfjcuNzMwU09HQlJGQWpsQndBQUFBQUVBd0VBQUFBQWlKbUpVQUFnQUFBQUFBQUFBQUQuLjJRQUFBQUEuLi4uLndBQUFBQUFBQUFBQUFBQUFBQUFBRk4wWVhScGIyNGdVbTloWkN3Z1MwVk1WRmtzSUVacFptVWdTMWswSURCQ1RnQUFBQUFBfjMz additional_attributes: - name: picklist_display value: 5 Station Road, KELTY, Fife - name: score value: '100' - name: postcode value: KY4 0BL United Kingdom With Enrichment: value: result: confidence: Verified match address: address_line_1: 79 Station Road address_line_2: '' address_line_3: '' locality: KELTY region: '' postal_code: KY4 0BL country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: KY4 0BL primary: KY4 0BL building: building_number: '79' street: full_name: Station Road name: Station type: Road locality: region: name: Fife town: name: KELTY metadata: address_info: identifier: udprn: '12353232' paf_address_key: 2304084100000000S barcode: delivery_point_barcode: (KY40BL2Z2) enrichment: transaction_id: 0e1fa486-9ce5-438d-8111-6cff23ad5396 result: geocodes: latitude: 56.13344 longitude: -3.37654 match_level: building metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. United States: value: result: validation_detail: city_name_corrected: true confidence: Verified match address: address_line_1: 77 Massachusetts Ave address_line_2: '' address_line_3: '' locality: Cambridge region: MA postal_code: 02139-4301 country: UNITED STATES OF AMERICA components: country_name: UNITED STATES OF AMERICA country_iso_3: USA country_iso_2: US postal_code: full_name: 02139-4301 primary: 02139 secondary: '4301' building: building_number: '77' street: full_name: Massachusetts Ave name: Massachusetts type: Ave locality: region: code: MA sub_region: name: Middlesex town: name: Cambridge metadata: barcode: delivery_point_barcode: 02139430177 check_digit: '3' route_classification: carrier_route: C077 address_classification: address_type: code: S description: Street delivery_type: Business United Kingdom With Mosaic: value: result: confidence: Verified match address: address_line_1: Flat A, Falcon Buildings address_line_2: 2 Dunbar Street address_line_3: '' locality: ABERDEEN region: '' postal_code: AB24 3UD country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: AB24 3UD primary: AB24 3UD sub_building: name: Flat A building: building_name: RAF Aldegrove building_number: '2' street: full_name: Dunbar Street name: Dunbar type: Street locality: town: name: ABERDEEN match_type: full_with_post_code match_confidence: high metadata: address_info: identifier: udprn: 00097601 paf_address_key: 2763861600000000S barcode: delivery_point_barcode: (AB243UD1TL) enrichment: result: gbr_mosaic: household: version: '7' type_code: '65' type: Learners & Earners group_code: O group: Rental Hubs postal_code: version: '7' type_code: '65' type: Learners & Earners group_code: O group: Rental Hubs metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: gbr_mosaic: household: code: S200 message: Match value: '[complex type]' postal_code: code: S200 message: Match value: '[complex type]' United Kingdom With Location Grid: value: result: confidence: Verified match address: address_line_1: Flat A, Falcon Buildings address_line_2: 2 Dunbar Street address_line_3: '' locality: ABERDEEN region: '' postal_code: AB24 3UD country: UNITED KINGDOM components: country_name: UNITED KINGDOM country_iso_3: GBR country_iso_2: GB postal_code: full_name: AB24 3UD primary: AB24 3UD sub_building: name: Flat A building: building_name: RAF Aldegrove building_number: '2' street: full_name: Dunbar Street name: Dunbar type: Street locality: town: name: ABERDEEN match_type: full_with_post_code match_confidence: high metadata: address_info: identifier: udprn: 00097601 paf_address_key: 2763861600000000S barcode: delivery_point_barcode: (AB243UD1TL) enrichment: result: gbr_location_grid: postzon: x_coordinate: 3939.0 y_coordinate: 8083.0 os_x_coordinate: 3939.0 os_y_coordinate: 8083.0 latitude: 57.165674 longitude: -2.102497 os_landranger: NJ939083 codepoint: x_coordinate: 393967.0 y_coordinate: 808358.0 pqi: '10' is_delivery_service: N ndp: '17' ndp_pqi: '17' ndp_domestic: '16' ndp_commercial: '1' ndp_delivery_service: '0' ndp_matched: '17' ndp_unmatched: '0' metadata: code: S200 message: Success detail: All requested attribute(s) retrieved. datasets: gbr_location_grid: postzon: code: S200 message: Match value: '[complex type]' codepoint: code: S200 message: Match value: '[complex type]' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '406': description: Not Acceptable '408': description: Request Timeout '415': description: Unsupported Media Type '429': description: Too Many Requests '500': description: Internal Server Error '503': description: Service Unavailable security: - OAuth2: [] - Auth-Token: [] - x-app-key: [] operationId: postAddressValidateV1 x-operation-id-source: derived components: schemas: AddressMetadataAddressType: type: object properties: code: type: - string - 'null' description: The code of the address type (applicable to USA, AUS and NZL addresses). example: S description: type: - string - 'null' description: The description of the address type (applicable to USA, AUS and NZL addresses). example: Street additionalProperties: false description: The address type. AddressLayoutV2AppliesTo: required: - country_iso - datasets type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code. example: GBR datasets: minItems: 1 type: array items: type: string description: The datasets. example: - au-address language: type: - string - 'null' description: The language. script: type: - string - 'null' description: The script. additionalProperties: false description: Address Layout V2 Applies To. EnrichmentV2AttributesGbrGovernment: enum: - eer_code - eer_code_pre_2011 - eer_name - gor_code - gor_code_pre_2011 - gor_name - lea_code - lea_name - la_code - la_code_pre_2011 - la_name - ward_code - ward_code_pre_2011 - ward_name - cens_out_area type: string description: The dataset named GBR Government and its associated attributes. PremiumLocationInsightTimeTransition: type: object properties: tag: type: - string - 'null' description: Time zone applicable based on a specified UTC start time and end time. example: EET standard_offset: type: - string - 'null' description: Standard offset returned based on a specified UTC start time and end time. example: 02:00:00 daylight_savings: type: - string - 'null' description: Daylight savings returned based on a specified UTC start time and end time. example: 00:00:00 utc_start: type: - string - 'null' description: Starting time of this UTC offset and DST. example: '2014-09-25T21:00:00Z' utc_end: type: - string - 'null' description: Ending time of this UTC offset and DST. example: '2023-04-27T22:00:00Z' additionalProperties: false description: Daylight savings time (DST) transitions information returned based on a specified address. EnrichmentV2GbrMosaicFinancial: enum: - postal_code - household type: string description: The dataset named GBR Mosaic Financial and its associated attributes. PremiumLocationInsightGeocodes: type: object properties: latitude: type: - number - 'null' description: The latitude of the property. format: double example: 52.9413 longitude: type: - number - 'null' description: The longitude of the property. format: double example: 1.16312 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: Building additionalProperties: false description: Geocode attributes for the specified address. AddressComponentBusinessOrganization: type: object properties: company_name: type: - string - 'null' description: The company name from an additional business dataset. additionalProperties: false description: The business component. EnrichmentV2AprStreet: enum: - grid - record - usrn type: string description: The dataset named Addressbase Street and its associated attributes. AddressLayoutV2Options: type: object properties: variation: type: integer description: Variation format: int32 flatten_diacritics: type: boolean description: Flatten Diacritics use_secondary_postcode: type: - string - 'null' description: Use Secondary Postcode enable_enhanced_layout: type: boolean description: Enable Enhanced Layout display_enhanced_info_on_picklist: type: boolean description: Display Enhanced Info On Picklist enable_intelligent_layout: type: boolean description: Enable Intelligent Layout capitalise_unused: type: boolean description: Capitalise Unused separate_elements: type: boolean description: Separate Elements element_separator: $ref: '#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault' retention_element_separator: $ref: '#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault' prepend_element_separator: $ref: '#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault' separate_element_separator: $ref: '#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault' terminate_lines: type: boolean description: Terminate Lines line_terminator: $ref: '#/components/schemas/AddressLayoutV2ElementConfigurationWithDefault' conditional_format: type: - string - 'null' description: Conditional Format pad_lines: type: boolean description: Pad Lines padding_character: type: - string - 'null' description: Padding Character multiple_dataplus_delimiter: type: - string - 'null' description: Multiple DataPlus Delimiter abbreviate_item: type: - array - 'null' items: type: string description: Indicating the elements that are abbreviated. capitalise_item: type: - array - 'null' items: type: string description: Indicating the elements that are capitalised. exclude_item: type: - array - 'null' items: type: string description: Indicating the elements that are excluded. element_extras: type: - object - 'null' additionalProperties: type: - string - 'null' description: Indicating the elements with extra characters. additionalProperties: false description: Address Layout V2 Options EnrichmentV2AttributesUkLocationEssential: enum: - latitude - longitude - match_level - udprn - uprn - x_coordinate - y_coordinate type: string description: The dataset named UK Location Essential its associated attributes. AddressMetadata: type: object properties: address_info: $ref: '#/components/schemas/AddressMetadataInfo' barcode: $ref: '#/components/schemas/AddressMetadataBarcode' route_classification: $ref: '#/components/schemas/AddressMetadataRouteClassification' address_classification: $ref: '#/components/schemas/AddressMetadataAddressClassification' dpv: $ref: '#/components/schemas/AddressMetadataDpv' additionalProperties: false description: The address metadata. AddressLayoutsV2UpdateLayout: required: - applies_to - id - lines - name type: object properties: id: minLength: 1 type: string description: The layout ID. name: maxLength: 100 minLength: 1 pattern: ^([A-Za-z0-9_\-]{1}[A-Za-z0-9_\-\ ]*[A-Za-z0-9_\-]{1}|[A-Za-z0-9_\-]{1})$ type: string description: The layout name. comment: type: - string - 'null' description: The layout comment. applies_to: minItems: 1 type: array items: $ref: '#/components/schemas/AddressLayoutV2AppliesTo' description: The layout applies to. options: $ref: '#/components/schemas/AddressLayoutV2Options' lines: minItems: 1 type: array items: $ref: '#/components/schemas/AddressLayoutV2Line' description: The layout lines. additionalProperties: false description: Address Layout V2 Update Layout. EnrichmentV2AprTopographyTopographicIdsResult: type: object properties: addresslayer_2: type: - string - 'null' description: TOID of the nearest feature in OS MasterMap Address Layer 2, typically for buildings. topography_layer: type: - string - 'null' description: TOID of the nearest topographical feature in OS MasterMap Topographic Layer. integrated_transport_network: type: - string - 'null' description: TOID of the nearest transport feature, usually the road providing access to the object. additionalProperties: false description: Response for Addressbase Topography TopographicIds. EnrichmentV2ResultAddressValidateMetadataDatasets: type: object properties: geocodes: $ref: '#/components/schemas/EnrichmentV2GeocodesMetadata' usa_regional_geocodes: $ref: '#/components/schemas/EnrichmentV2UsaRegionalGeocodesMetadata' aus_regional_geocodes: $ref: '#/components/schemas/EnrichmentV2AusRegionalGeocodesMetadata' nzl_regional_geocodes: $ref: '#/components/schemas/EnrichmentV2NzlRegionalGeocodesMetadata' uk_location_complete: $ref: '#/components/schemas/EnrichmentV2UkLocationCompleteMetadata' uk_location_essential: $ref: '#/components/schemas/EnrichmentV2UkLocationEssentialMetadata' gbr_government: $ref: '#/components/schemas/EnrichmentV2GbrGovernmentMetadata' gbr_health: $ref: '#/components/schemas/EnrichmentV2GbrHealthMetadata' premium_location_insight: $ref: '#/components/schemas/EnrichmentV2PremiumLocationInsightMetadata' what3words: $ref: '#/components/schemas/EnrichmentV2What3WordsMetadata' gbr_location_grid: $ref: '#/components/schemas/EnrichmentV2GbrLocationGridMetadata' gbr_parliament: $ref: '#/components/schemas/EnrichmentV2GbrParliamentMetadata' gbr_mosaic: $ref: '#/components/schemas/EnrichmentV2GbrMosaicMetadata' gbr_mosaic_financial: $ref: '#/components/schemas/EnrichmentV2GbrMosaicFinancialMetadata' gbr_alias: $ref: '#/components/schemas/EnrichmentV2GbrAliasMetadata' gbr_quality: $ref: '#/components/schemas/EnrichmentV2GbrQualityMetadata' addressbase_classification: $ref: '#/components/schemas/EnrichmentV2AprClassificationMetadata' addressbase_cross_reference: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceMetadata' addressbase_government: $ref: '#/components/schemas/EnrichmentV2AprGovernmentMetadata' addressbase_health: $ref: '#/components/schemas/EnrichmentV2AprHealthMetadata' addressbase_location_grid: $ref: '#/components/schemas/EnrichmentV2AprLocationGridMetadata' addressbase_parliament: $ref: '#/components/schemas/EnrichmentV2AprParliamentMetadata' addressbase_quality: $ref: '#/components/schemas/EnrichmentV2AprQualityMetadata' addressbase_street: $ref: '#/components/schemas/EnrichmentV2AprStreetMetadata' addressbase_topography: $ref: '#/components/schemas/EnrichmentV2AprTopographyMetadata' addressbase_voa: $ref: '#/components/schemas/EnrichmentV2AprVoaMetadata' irl_mosaic: $ref: '#/components/schemas/EnrichmentV2IrlMosaicMetadata' nzl_household: $ref: '#/components/schemas/EnrichmentV2NzlHouseholdMetadata' nzl_mosaic: $ref: '#/components/schemas/EnrichmentV2NzlMosaicMetadata' nzl_property: $ref: '#/components/schemas/EnrichmentV2NzlPropertyMetadata' sgp_mosaic: $ref: '#/components/schemas/EnrichmentV2SgpMosaicMetadata' additionalProperties: false AddressValidateV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressValidateV1Result' metadata: $ref: '#/components/schemas/AddressMetadata' enrichment: $ref: '#/components/schemas/AddressFormatV1ResponseEnrichment' additionalProperties: false description: Response model for AddressValidateV1 endpoint. EnrichmentV2NzlPropertyMetadata: type: object properties: property_type: $ref: '#/components/schemas/DatasetMetadataV2' property_ownership: $ref: '#/components/schemas/DatasetMetadataV2' property_value: $ref: '#/components/schemas/DatasetMetadataV2' property_size: $ref: '#/components/schemas/DatasetMetadataV2' bedrooms: $ref: '#/components/schemas/DatasetMetadataV2' bathrooms: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2NzlHouseholdResult: type: object properties: head_of_household_age: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' children_at_address: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' household_composition: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' head_of_household_lifestage: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' adults_at_address: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' additionalProperties: false description: Response for NZL Household dataset. AddressSearchV1Result: type: object properties: more_results_available: type: boolean description: To indicate that there are more suggestions available than the results provided. confidence: type: - string - 'null' description: The outcome (confidence level) of the validation. example: Verified match suggestions_key: type: - string - 'null' description: The suggestions key for address suggestion refinement. suggestions_prompt: type: - string - 'null' description: The prompt to display to the user, indicating what information they should enter next. example: Enter selection suggestions: type: - array - 'null' items: $ref: '#/components/schemas/AddressSuggestion' description: The collection of the suggestions that match the address search input. additionalProperties: false description: Address search V1 result. EnrichmentV2What3WordsMetadata: type: object properties: latitude: $ref: '#/components/schemas/DatasetMetadata' longitude: $ref: '#/components/schemas/DatasetMetadata' name: $ref: '#/components/schemas/DatasetMetadata' description: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the what3words dataset. EnrichmentV2GbrAliasMetadata: type: object properties: aliases: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressComponentBuilding: type: object properties: building_name: type: - string - 'null' description: The building name. example: Sir John Peace Building secondary_name: type: - string - 'null' description: The secondary building name. building_number: type: - string - 'null' description: The building number. example: '549' secondary_number: type: - string - 'null' description: The secondary name of the building (if available). allotment_number: type: - string - 'null' description: The allotment name where a person or property resides. additionalProperties: false description: The building component. EnrichmentV2NzlPropertyResult: type: object properties: property_type: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' property_ownership: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' property_value: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' property_size: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' bedrooms: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' bathrooms: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' additionalProperties: false description: Response for NZL Property dataset. EnrichmentV2AprCrossReferenceAddressLayer2Result: type: object properties: primary_key: type: - string - 'null' description: Primary key of the record in external dataset. key: type: - string - 'null' description: Unique key for the cross reference record. version: type: - string - 'null' description: Version number of the source object. created_date: type: - string - 'null' description: Date the record was created. update_date: type: - string - 'null' description: Date the record was last changed. entry_date: type: - string - 'null' description: Date of data entry. additionalProperties: false description: Response for Addressbase Cross Reference Address Layer 2. AddressLayoutsV2CreateRequest: required: - layout type: object properties: layout: $ref: '#/components/schemas/AddressLayoutV2' additionalProperties: false description: Address Layouts V2 Create Request. AddressLookupKey: required: - value type: object properties: type: type: - string - 'null' description: The type of the lookup key. example: Default value: minLength: 1 type: string description: The value of the lookup key. example: '1234567890' additionalProperties: false description: The address lookup key. LocationElements: type: object properties: code: type: - string - 'null' description: The code of a business. description: type: - string - 'null' description: The description of a business. small_or_home_office: type: boolean description: Is a business small or home office one. additionalProperties: false description: The location elements of a business. EnrichmentV2GbrAlias: enum: - aliases type: string description: The dataset named GBR Alias and its associated attributes. AddressSuggestionsFormatV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressSuggestionsFormatV1Result' additionalProperties: false description: Response model for AddressSuggestionsFormatV1 endpoint. AddressSuggestionsV1Request: required: - refinement type: object properties: refinement: minLength: 1 type: string description: The refinement text. example: A123 additionalProperties: false description: Address suggestion V1 request. EnrichmentV2AprVoa: enum: - primary_description - special_category type: string description: The dataset named Addressbase Voa and its associated attributes. LocalityComponents: type: object properties: region: $ref: '#/components/schemas/LocalityItem' sub_region: $ref: '#/components/schemas/LocalityItem' town: $ref: '#/components/schemas/LocalityItem' district: $ref: '#/components/schemas/LocalityItem' sub_district: $ref: '#/components/schemas/LocalityItem' type: type: - string - 'null' description: Addresses type. Specific for Japan. additionalProperties: false description: The locality of the suggestion. AddressLine: type: object properties: label: type: - string - 'null' description: The label of address line. example: AmexStreet line: type: - string - 'null' description: The text of address line. example: 1 Main St has_overflown_to_other_line: type: boolean description: Indicating some address elements were lost from this line or not. is_truncated: type: boolean description: Indicating truncation occurred on this line or not. line_content: $ref: '#/components/schemas/AddressLineContent' additionalProperties: false description: The address line of customized layout. What3WordsComponent: type: object properties: name: type: - string - 'null' description: Gets or sets the name; description: type: - string - 'null' description: Gets or sets the description additionalProperties: false description: What3Words address suggestion. EnrichmentV2GbrAliasElementsResult: type: object properties: building_name: type: - string - 'null' description: PAF Building Name Delivery Point Alias. also_known_as: type: - string - 'null' description: PAF Also Known As Delivery Point Alias. department: type: - string - 'null' description: PAF Department Delivery Point Alias. organization_description: type: - string - 'null' description: PAF Organization Description Delivery Point Alias. organization_at_residential: type: - string - 'null' description: PAF Organization Residential Delivery Point Alias. trading_name: type: - string - 'null' description: PAF Trading Name Delivery Point Alias. misc: type: - string - 'null' description: PAF Miscellaneous Delivery Point Alias. welsh_alternative: type: - string - 'null' description: PAF Welsh Alternative Delivery Point Alias. additionalProperties: false description: Response for GBR PAF. EnrichmentV2AprClassificationMetadata: type: object properties: code: $ref: '#/components/schemas/DatasetMetadataV2' record: $ref: '#/components/schemas/DatasetMetadataV2' scheme: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressComponentAdditionalLocality: type: object properties: sub_region: $ref: '#/components/schemas/AddressComponentAdditionalSubRegion' additionalProperties: false description: The additional locality component. AddressFormattedAddressLines: type: object properties: layout_name: type: - string - 'null' description: The address layout name. example: QADefault not_enough_lines: type: boolean description: There are not enough address lines configured to display the whole address. has_truncated_lines: type: boolean description: Truncation has occurred on one or more address lines. address: type: - object - 'null' additionalProperties: {} description: The customized address layouts in default format. example: AmexStreet: 1 Main St AmexTown: Surbiton AmexCountry: United Kingdom gas_meters: - mprn: '52902306' - mprn: '52902307' has_missing_sub_premises: type: boolean description: 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: type: - array - 'null' items: $ref: '#/components/schemas/AddressLine' description: The customized address layouts in address-line format. additionalProperties: false description: Customized address layouts. AddressLayoutV2Line: type: object properties: line_name: type: - string - 'null' description: The line name. max_width: type: - integer - 'null' description: Max width. format: int32 elements: type: - array - 'null' items: $ref: '#/components/schemas/AddressLayoutV2LineElement' description: Elements. additionalProperties: false description: Address Layout V2 Line. EnrichmentV2GbrMosaic: enum: - household - postal_code type: string description: The dataset named GBR Mosaic and its associated attributes. AddressSuggestion: type: object properties: global_address_key: type: - string - 'null' description: The ID of the address received as part of a validation. text: type: - string - 'null' description: The suggestion that should be presented to the user as a possible match to their input. example: Level 6 549 St Kilda Road, MELBOURNE VIC 3004 matched: type: - array - 'null' items: type: array items: type: integer format: int32 description: A collection of the characters in the suggestion that have been matched. Integrators can use this information to highlight matched text. example: - - 17 - 22 - - 11 - 15 - - 3 - 10 - - 0 - 2 format: type: - string - 'null' description: The format URL of the suggested address. stepin: type: - string - 'null' description: The stepin URL of the cluster of addresses. number_of_addresses: type: integer description: The stepin URL of the cluster of addresses. format: int32 dataset: type: - string - 'null' description: The dataset of the suggestion. example: Multiple Residence additional_attributes: type: - array - 'null' items: $ref: '#/components/schemas/AddressNameValuePair' description: The additional attributes of the suggestion. names: type: - array - 'null' items: type: string description: The additional attributes of the suggestion. uprn: type: - string - 'null' description: The UPRN of the suggestion. additionalProperties: false description: The suggestions that match the address search input. EnrichmentV2AprCrossReferenceResult: type: object properties: addresslayer_2: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceAddressLayer2Result' council_tax: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceCouncilTaxResult' integrated_transport_network: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceIntegratedTransportNetworkResult' non_domestic_rates: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceNonDomesticRatesResult' topography_layer: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceTopographyLayerResult' additionalProperties: false description: Response for Addressbase Cross Reference dataset. EnrichmentV2AprGovernment: enum: - government type: string description: The dataset named Addressbase Government and its associated attributes. EnrichmentV2AprLocationGridResult: type: object properties: blpu: $ref: '#/components/schemas/EnrichmentV2AprLocationGridBlpuResult' building: $ref: '#/components/schemas/EnrichmentV2AprLocationGridBuildingResult' postal_code: $ref: '#/components/schemas/EnrichmentV2AprLocationGridPostalCodeResult' street: $ref: '#/components/schemas/EnrichmentV2AprLocationGridStreetResult' additionalProperties: false description: Response for Addressbase Location Grid dataset. EnrichmentV2AprCrossReferenceCouncilTaxResult: type: object properties: primary_key: type: - string - 'null' description: Primary key of the record in external dataset. key: type: - string - 'null' description: Unique key for the cross reference record. version: type: - string - 'null' description: Version number of the source object. created_date: type: - string - 'null' description: Date the record was created. update_date: type: - string - 'null' description: Date the record was last changed. entry_date: type: - string - 'null' description: Date of data entry. additionalProperties: false description: Response for Addressbase Cross Reference Council Tax. EnrichmentV2UkLocationEssentialMetadata: type: object properties: latitude: $ref: '#/components/schemas/DatasetMetadata' longitude: $ref: '#/components/schemas/DatasetMetadata' match_level: $ref: '#/components/schemas/DatasetMetadata' udprn: $ref: '#/components/schemas/DatasetMetadata' uprn: $ref: '#/components/schemas/DatasetMetadata' x_coordinate: $ref: '#/components/schemas/DatasetMetadata' y_coordinate: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the UK Location Essential dataset. AddressLookupV2ResultAddressFormatted: type: object properties: layout_name: type: - string - 'null' description: The address layout name. example: QADefault address: type: - object - 'null' additionalProperties: {} description: The customized address layouts in default format. example: AmexStreet: 1 Main St AmexTown: Surbiton AmexCountry: United Kingdom gas_meters: - mprn: '52902306' - mprn: '52902307' additionalProperties: false description: Customized address layouts. AddressFormatV1Result: type: object properties: global_address_key: type: - string - 'null' description: The ID of the address received as part of a validation. confidence: type: - string - 'null' description: The confidence of address validation result. example: Verified match address: $ref: '#/components/schemas/Address7Lines' addresses_formatted: type: - array - 'null' items: $ref: '#/components/schemas/AddressFormattedAddressLines' description: Customized address layouts. components: $ref: '#/components/schemas/AddressFormatV1Components' additionalProperties: false description: Information about the result. Includes the validated address and its confidence level. AddressLayoutsV2GetResult: type: object properties: layout: $ref: '#/components/schemas/AddressLayoutsV2GetResponseModel' additionalProperties: false description: Address Layouts V2 Get Result. EnrichmentV2AttributesGeocode: enum: - latitude - longitude - match_level type: string description: The dataset named Geocodes and its associated attributes. EnrichmentV2AprVoaSpecialCategoryResult: type: object properties: scheme: type: - string - 'null' description: Name of VOA special category scheme. version: type: - string - 'null' description: Version of VOA special category scheme. key: type: - string - 'null' description: Unique key of the classification record. code: type: - string - 'null' description: Code describing VOA special category. start_date: type: - string - 'null' description: Start date of classification record. end_date: type: - string - 'null' description: End date of classification record. update_date: type: - string - 'null' description: Last update date of classification record. entry_date: type: - string - 'null' description: Entry date of classification record. additionalProperties: false description: Response for Addressbase Voa Special Category. EnrichmentV2AprQualityResult: type: object properties: custodian: $ref: '#/components/schemas/EnrichmentV2AprQualityCustodianResult' metadata: $ref: '#/components/schemas/EnrichmentV2AprQualityMetadataResult' record: $ref: '#/components/schemas/EnrichmentV2AprQualityRecordResult' additionalProperties: false description: Response for Addressbase Quality dataset. AddressPromptSetType: enum: - oneline - default - generic - optimal - alternate - alternate2 - alternate3 type: string description: The available prompt sets. EnrichmentV2AprTopography: enum: - topographic_ids type: string description: The dataset named Addressbase Topography and its associated attributes. EnrichmentV2DatasetUkLocationEssential: type: object properties: latitude: type: - number - 'null' description: The latitude. format: double example: 51.50112 longitude: type: - number - 'null' description: The longitude. format: double example: -0.1041234 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: Building udprn: type: - string - 'null' description: The UDPRN. example: '55244256' uprn: type: - string - 'null' description: The UPRN. example: 010091977422 x_coordinate: type: - number - 'null' description: The x coordinate. format: double example: 531677.94 y_coordinate: type: - number - 'null' description: The y coordinate. format: double example: 179757.6 additionalProperties: false description: Enrichment attributes that can be returned, based on the UK Location Essential dataset. AddressLayoutsV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: type: - array - 'null' items: $ref: '#/components/schemas/AddressLayout' description: The address layout V1 result. additionalProperties: false description: Response model for AddressLayoutsV1 endpoint. DatasetMetadataV2: required: - code - message - value type: object properties: code: type: - string - 'null' message: type: - string - 'null' value: type: - string - 'null' additionalProperties: false EnrichmentV2GbrLocationGridResult: type: object properties: postzon: $ref: '#/components/schemas/EnrichmentV2GbrLocationGridPostzonResult' codepoint: $ref: '#/components/schemas/EnrichmentV2GbrLocationGridCodepointResult' additionalProperties: false description: Response for GBR Location Grid dataset. EnrichmentV2DatasetPremiumLocationInsight: type: object properties: geocodes: $ref: '#/components/schemas/PremiumLocationInsightGeocodes' geocodes_building_xy: $ref: '#/components/schemas/PremiumLocationInsightGeocodesBuildingXy' geocodes_access: type: - array - 'null' items: $ref: '#/components/schemas/PremiumLocationInsightGeocodesAccess' description: Access geocode for the specified address. xml: name: geocodes_access wrapped: true time: type: - array - 'null' items: $ref: '#/components/schemas/PremiumLocationInsightTime' description: Time zone information returned based on a specified address. (This attribute is excluded in Premium Location Insight Lite.) xml: name: time wrapped: true additionalProperties: false description: Enrichment attributes that can be returned, based on the Premium Location Insight dataset. EnrichmentV2AprVoaPrimaryDescriptionResult: type: object properties: scheme: type: - string - 'null' description: Name of VOA classification scheme. version: type: - string - 'null' description: Version of VOA classification scheme. key: type: - string - 'null' description: Unique key of the classification record. code: type: - string - 'null' description: Code describing VOA classification. start_date: type: - string - 'null' description: Start date of classification record. end_date: type: - string - 'null' description: End date of classification record. update_date: type: - string - 'null' description: Last update date of classification record. entry_date: type: - string - 'null' description: Entry date of classification record. additionalProperties: false description: Response for Addressbase Voa Primary Description. EnrichmentV2IrlMosaic: enum: - household type: string description: The dataset named IRL Mosaic and its associated attributes. EnrichmentV2AprLocationGridStreetResult: type: object properties: x_coordinate: type: - number - 'null' description: Easting coordinate of the street in metres (1 cm resolution). format: double y_coordinate: type: - number - 'null' description: Northing coordinate of the street in metres (1 cm resolution). format: double ap_x_coordinate: type: - number - 'null' description: Easting coordinate in 10 cm resolution, zero-padded to 8 digits. format: double ap_y_coordinate: type: - number - 'null' description: Northing coordinate in 10 cm resolution, zero-padded to 8 digits. format: double additionalProperties: false description: Response for Addressbase Location Grid Street. AddressComponent: type: object properties: language: type: - string - 'null' description: Address language. example: en-GB country_name: type: - string - 'null' description: The name of the country where the address is located. example: United Kingdom country_iso_3: type: - string - 'null' description: The 3-letter ISO country code. example: GBR country_iso_2: type: - string - 'null' description: The 2-letter ISO country code. example: GB country_iso_numeric: type: - string - 'null' description: The numeric ISO country code. example: '780' postal_code: $ref: '#/components/schemas/AddressComponentPostalCode' delivery_service: $ref: '#/components/schemas/AddressComponentDeliveryService' secondary_delivery_service: $ref: '#/components/schemas/AddressComponentDeliveryService' sub_building: $ref: '#/components/schemas/AddressComponentSubBuilding' building: $ref: '#/components/schemas/AddressComponentBuilding' organization: $ref: '#/components/schemas/AddressComponentOrganization' street: $ref: '#/components/schemas/AddressComponentStreet' secondary_street: $ref: '#/components/schemas/AddressComponentStreet' route_service: $ref: '#/components/schemas/AddressComponentRouteService' locality: $ref: '#/components/schemas/AddressComponentLocality' physical_locality: $ref: '#/components/schemas/AddressComponentLocality' additional_elements: $ref: '#/components/schemas/AddressComponentAdditionalElements' additionalProperties: false description: The components that differ by country and address type. Note that parameters with blank values will not be returned. EnrichmentV2DatasetUkLocationComplete: type: object properties: latitude: type: - number - 'null' description: The latitude. format: double example: 51.50112 longitude: type: - number - 'null' description: The longitude. format: double example: -0.1041234 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: Building udprn: type: - string - 'null' description: Specifies the UDPRN for the specified address. example: '55244256' uprn: type: - string - 'null' description: Specifies the UPRN for the specified address. example: 010091977422 x_coordinate: type: - number - 'null' description: The x coordinate. format: double example: 531677.94 y_coordinate: type: - number - 'null' description: The y coordinate. format: double example: 179757.6 additionalProperties: false description: Enrichment attributes that can be returned, based on the UK Location Complete dataset. EnrichmentV2NzlHousehold: enum: - head_of_household_age - children_at_address - household_composition - head_of_household_lifestage - adults_at_address type: string description: The dataset named NZL Household and its associated attributes. EnrichmentV2AttributesGbrHealth: enum: - authority_code - authority_code_2011 - authority_name - pclh_code - pclh_code_2011 - pclh_name - ward_code - ward_code_2011 - ward_name - ccg_code - ccg_name - doh_code type: string description: The dataset named GBR Health and its associated attributes. EnrichmentV2NzlProperty: enum: - property_type - property_ownership - property_value - property_size - bedrooms - bathrooms type: string description: The dataset named NZL Property and its associated attributes. EnrichmentV2GbrQualityMetadata: type: object properties: record: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressFormatV1Metadata: type: object properties: address_info: $ref: '#/components/schemas/AddressMetadataInfo' barcode: $ref: '#/components/schemas/AddressMetadataBarcode' route_classification: $ref: '#/components/schemas/AddressMetadataRouteClassification' address_classification: $ref: '#/components/schemas/AddressMetadataAddressClassification' dpv: $ref: '#/components/schemas/AddressMetadataDpv' additionalProperties: false description: The address metadata. ResponseError: type: object properties: type: type: - string - 'null' description: A link to documentation that provides more details about the error you’ve encountered. title: type: - string - 'null' description: The title of the error. example: Bad Request detail: type: - string - 'null' description: A description of the error. example: The request body was malformed. instance: type: - string - 'null' description: The endpoint that returned the error. additionalProperties: false description: Error model containing the error details. EnrichmentV2AprParliament: enum: - westminster type: string description: The dataset named Addressbase Parliament and its associated attributes. EnrichmentV2DatasetGeocodes: type: object properties: latitude: type: - number - 'null' description: The latitude. format: double example: 52.9413 longitude: type: - number - 'null' description: The longitude. format: double example: 1.16312 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: Premises additionalProperties: false description: Enrichment attributes that can be returned, based on the Geocodes dataset. EnrichmentV2AprParliamentResult: type: object properties: westminster: $ref: '#/components/schemas/EnrichmentV2AprParliamentWestminsterResult' additionalProperties: false description: Response for Addressbase Parliament dataset. AddressInputComponents: type: object properties: unspecified: minItems: 1 type: - array - 'null' items: type: string description: The input component collection. example: - 1 Main Street names: type: - array - 'null' items: $ref: '#/components/schemas/AddressInputComponentName' description: The names component. example: - 1 Main Street locality: $ref: '#/components/schemas/AddressLocalityConstrains' additionalProperties: false description: The address search input component. EnrichmentV2AprClassificationResult: type: object properties: code: $ref: '#/components/schemas/EnrichmentV2AprClassificationCodeResult' record: $ref: '#/components/schemas/EnrichmentV2AprClassificationRecordResult' scheme: $ref: '#/components/schemas/EnrichmentV2AprClassificationSchemeResult' additionalProperties: false description: Response for Addressbase Classification dataset. EnrichmentV2DatasetGbAdditionalBusinessAddressValidate: type: object properties: urn: type: - string - 'null' description: The latitude. example: '51.751172' commercial_mosaic: $ref: '#/components/schemas/CommercialMosaicElements' registration: type: - string - 'null' description: The longitude. example: '-1.24623' non_limited_company_key: type: - string - 'null' description: The longitude. example: '-1.24623' phone: type: - string - 'null' description: The longitude. example: '-1.24623' number_of_employees: type: - string - 'null' description: The longitude. example: '-1.24623' standard_industry_classification: $ref: '#/components/schemas/StandardIndustryClassificationElements' location: $ref: '#/components/schemas/LocationElements' additionalProperties: false description: Enrichment attributes that can be returned, based on the what3words dataset. EnrichmentV2AttributesUsaRegionalGeocodes: enum: - latitude - longitude - match_level - census_tract - census_block - core_based_statistical_area - congressional_district_code - county_code type: string description: The dataset named USA Regional Geocodes its associated attributes. AddressValidateV1Result: type: object properties: validation_detail: $ref: '#/components/schemas/AddressValidationDetail' global_address_key: type: - string - 'null' description: The ID of the address received as part of a validation. more_results_available: type: - boolean - 'null' description: To indicate that there are more suggestions available than the results provided. confidence: type: - string - 'null' description: The outcome (confidence level) of the validation. example: Multiple matches address: $ref: '#/components/schemas/Address7Lines' addresses_formatted: type: - array - 'null' items: $ref: '#/components/schemas/AddressFormattedAddressLines' description: Customized address layouts. components: $ref: '#/components/schemas/AddressComponent' suggestions_key: type: - string - 'null' description: The suggestions key for address suggestion refinement. suggestions_prompt: type: - string - 'null' description: The prompt to display to the user, indicating what information they should enter next. example: Enter selection suggestions: type: - array - 'null' items: $ref: '#/components/schemas/AddressSuggestion' description: The collection of the suggestions that match the address validate input. match_type: type: - string - 'null' description: Match type for verified address. match_confidence: type: - string - 'null' description: Match confidence for verified address. match_info: $ref: '#/components/schemas/MatchInfoFlags' additionalProperties: false description: Address validate V1 result. AddressSuggestionsFormatV1Request: required: - components - country_iso - datasets type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code of address. example: AUS datasets: minItems: 1 type: array items: type: string description: The datasets for address validation. example: - au-address max_suggestions: maximum: 100 minimum: 1 type: - integer - 'null' description: The maximum number of suggestions a search request should return (should be between 1 and 100). format: int32 example: 10 components: $ref: '#/components/schemas/AddressInputComponents' layouts: type: - array - 'null' items: type: string description: Custom layout name. example: - default additionalProperties: false description: The address suggestions format v1 request. EnrichmentV2NzlMosaic: enum: - mosaic - mosaic_segment - factor_a - factor_b - factor_c - factor_d - factor_e - factor_f type: string description: The dataset named NZL Mosaic and its associated attributes. EnrichmentV2GbrLocationGridCodepointResult: type: object properties: x_coordinate: type: - number - 'null' description: Native OS or OSNI grid-reference. format: double y_coordinate: type: - number - 'null' description: Native OS or OSNI grid-reference. format: double pqi: type: - string - 'null' description: Assesses the quality of the grid based on the quality of the AddressPoints used. is_delivery_service: type: - string - 'null' description: Value is always "Yes" or "No", depending on whether the postcode is a PO Box. ndp: type: - string - 'null' description: Indicates the number of delivery points on PAF for the current postcode. ndp_pqi: type: - string - 'null' description: '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: type: - string - 'null' description: Represents the number of non-PO Box delivery points with no PAF organization name. ndp_commercial: type: - string - 'null' description: Represents the number of non-PO Box delivery points which have a PAF organization name. ndp_delivery_service: type: - string - 'null' description: Represents the number of PO Box delivery points. ndp_matched: type: - string - 'null' description: Represents the number of good AddressPoints after de-duplication of AddressPoints with the same coordinates. ndp_unmatched: type: - string - 'null' description: Represents the number of Delivery Points on PAF unmatched to OS data. additionalProperties: false description: Response for GBR CodePoint Grid. AddressLayoutsV2GetResponse: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressLayoutsV2GetResult' additionalProperties: false description: Response model for Address Layouts V2 Get endpoint. EnrichmentV2AprQuality: enum: - custodian - metadata - record type: string description: The dataset named Addressbase Quality and its associated attributes. EnrichmentV2UsaRegionalGeocodesMetadata: type: object properties: latitude: $ref: '#/components/schemas/DatasetMetadata' longitude: $ref: '#/components/schemas/DatasetMetadata' match_level: $ref: '#/components/schemas/DatasetMetadata' census_tract: $ref: '#/components/schemas/DatasetMetadata' census_block: $ref: '#/components/schemas/DatasetMetadata' core_based_statistical_area: $ref: '#/components/schemas/DatasetMetadata' congressional_district_code: $ref: '#/components/schemas/DatasetMetadata' county_code: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the USA Regional Geocodes dataset. EnrichmentV2AprClassificationRecordResult: type: object properties: key: type: - string - 'null' description: Unique key of the classification record. start_date: type: - string - 'null' description: Start date of classification record. end_date: type: - string - 'null' description: End date of classification record. update_date: type: - string - 'null' description: Last update date of classification record. entry_date: type: - string - 'null' description: Entry date of classification record. additionalProperties: false description: Response for Addressbase Classification Record. AddressSearchV1Request: required: - components - country_iso - datasets type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code of address. example: GBR datasets: minItems: 1 type: - array - 'null' items: type: string description: The datasets for address validation. example: - au-address max_suggestions: type: - integer - 'null' description: 'The maximum number of suggestions a search request should return. Please refer to the documentation.' format: int32 example: 10 components: $ref: '#/components/schemas/AddressInputComponents' location: maxLength: 40 minLength: 0 type: - string - 'null' description: Geographical location (latitude,longitude) to use as the center point for the search (USA only). example: 42.3529, -71.0578 options: type: - array - 'null' items: $ref: '#/components/schemas/AddressNameValuePair' description: Additional options. example: - name: search_type value: singleline preferred_language: type: - array - 'null' items: type: string description: The datasets for address validation. example: - ja preferred_script: type: - array - 'null' items: type: string description: The datasets for address validation. example: - preserve_input street: maxLength: 3 minLength: 3 type: - string - 'null' description: The country ISO3 code of address. example: GBR town: maxLength: 3 minLength: 3 type: - string - 'null' description: The country ISO3 code of address. example: GBR region: maxLength: 3 minLength: 3 type: - string - 'null' description: The country ISO3 code of address. example: GBR postal_code: maxLength: 3 minLength: 3 type: - string - 'null' description: The country ISO3 code of address. example: GBR additionalProperties: false description: The address search v1 request. EnrichmentV2GbrCommonElementsWithVersionResult: type: object properties: version: type: - string - 'null' type_code: type: - string - 'null' description: Type Code. type: type: - string - 'null' description: Type Name. group_code: type: - string - 'null' description: Group Code. group: type: - string - 'null' description: Group Name. additionalProperties: false description: Response for dataset with versioning consisting of type code, type, group code and group elements. EnrichmentV2AprVoaMetadata: type: object properties: primary_description: $ref: '#/components/schemas/DatasetMetadataV2' special_category: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2AprGovernmentMetadata: type: object properties: government: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressPromptSetsV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressPromptSetsV1Result' additionalProperties: false description: Response model for AddressPromptSetsV1 endpoint. AddressLocalityConstrains: type: object properties: region: $ref: '#/components/schemas/AddressRestrictionRules' additionalProperties: false description: A class representing search locality constraints AddressLayoutsV2UpdateRequest: required: - layout type: object properties: layout: $ref: '#/components/schemas/AddressLayoutsV2UpdateLayout' additionalProperties: false description: Address Layouts V2 Update Request. EnrichmentV2AttributesPremiumLocationInsight: enum: - geocodes - geocodes_building_xy - geocodes_access - time type: string description: "The dataset named Premium Location Insight and its associated attributes.\n\n (The time attribute is excluded in Premium Location Insight Lite.)
" EnrichmentV2NzlRegionalGeocodesMetadata: type: object properties: front_of_property_nztm_x_coordinate: $ref: '#/components/schemas/DatasetMetadata' front_of_property_nztm_y_coordinate: $ref: '#/components/schemas/DatasetMetadata' centroid_of_property_nztm_x_coordinate: $ref: '#/components/schemas/DatasetMetadata' centroid_of_property_nztm_y_coordinate: $ref: '#/components/schemas/DatasetMetadata' linz_parcel_id: $ref: '#/components/schemas/DatasetMetadata' property_purpose_type: $ref: '#/components/schemas/DatasetMetadata' addressable: $ref: '#/components/schemas/DatasetMetadata' mesh_block_code: $ref: '#/components/schemas/DatasetMetadata' territorial_authority_code: $ref: '#/components/schemas/DatasetMetadata' territorial_authority_name: $ref: '#/components/schemas/DatasetMetadata' regional_council_code: $ref: '#/components/schemas/DatasetMetadata' regional_council_name: $ref: '#/components/schemas/DatasetMetadata' general_electorate_code: $ref: '#/components/schemas/DatasetMetadata' general_electorate_name: $ref: '#/components/schemas/DatasetMetadata' maori_electorate_code: $ref: '#/components/schemas/DatasetMetadata' maori_electorate_name: $ref: '#/components/schemas/DatasetMetadata' front_of_property_latitude: $ref: '#/components/schemas/DatasetMetadata' front_of_property_longitude: $ref: '#/components/schemas/DatasetMetadata' centroid_of_property_latitude: $ref: '#/components/schemas/DatasetMetadata' centroid_of_property_longitude: $ref: '#/components/schemas/DatasetMetadata' match_level: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the NZL Regional Geocodes dataset. AddressSuggestionsV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressSearchV1Result' additionalProperties: false description: Response model for AddressSuggestionsV1 endpoint. EnrichmentV2GbrMosaicFinancialMetadata: type: object properties: postal_code: $ref: '#/components/schemas/DatasetMetadataV2' household: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressFormatV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressFormatV1Result' metadata: $ref: '#/components/schemas/AddressFormatV1Metadata' enrichment: $ref: '#/components/schemas/AddressFormatV1ResponseEnrichment' additionalProperties: false description: Response model for AddressFormatV1 endpoint. AddressSuggestionsFormatV1Result: type: object properties: more_results_available: type: boolean description: To indicate that there are more suggestions available than the results provided. confidence: type: - string - 'null' description: The outcome (confidence level) of the validation. example: Multiple matches suggestions: type: - array - 'null' items: $ref: '#/components/schemas/AddressSuggestionsFormatV1' description: The collection of the suggestions that match the address search input. additionalProperties: false description: Address suggestions format result. AddressMetadataRouteClassification: type: object properties: carrier_route: type: - string - 'null' description: The carrier route value (applicable for USA addresses only). example: C077 id: type: - string - 'null' description: The street identifier (applicable for AUS addresses only). example: '38396' elot: type: - string - 'null' description: '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.' example: 0000A roudis_id: type: - string - 'null' description: This reference code provides an entry point into the ROUDIS2000 file provided by La Poste. additionalProperties: false description: Address deliverability and type indicators. AddressLayoutsV2GetResponseModel: required: - applies_to - lines - name type: object properties: id: type: - string - 'null' description: The layout ID. name: maxLength: 100 minLength: 1 pattern: ^([A-Za-z0-9_\-]{1}[A-Za-z0-9_\-\ ]*[A-Za-z0-9_\-]{1}|[A-Za-z0-9_\-]{1})$ type: string description: The layout name. comment: type: - string - 'null' description: The layout comment. applies_to: minItems: 1 type: array items: $ref: '#/components/schemas/AddressLayoutV2AppliesTo' description: The layout applies to. options: $ref: '#/components/schemas/AddressLayoutV2Options' lines: minItems: 1 type: array items: $ref: '#/components/schemas/AddressLayoutV2Line' description: The layout lines. status: $ref: '#/components/schemas/AddressLayoutV2Status' license_id: type: - string - 'null' description: The license ID selected during the layout creation (for internal purposes). additionalProperties: false description: Address Layout V2 Get Response Model. EnrichmentV2GbrParliamentResult: type: object properties: westminster: $ref: '#/components/schemas/EnrichmentV2GbrParliamentWestminsterResult' scotland: $ref: '#/components/schemas/EnrichmentV2GbrParliamentScotlandResult' additionalProperties: false description: Response for GBR Parliament dataset. EnrichmentV2DatasetGbrHealth: type: object properties: authority_code: type: - string - 'null' description: NHS Authority Code. example: Q36 authority_code_2011: type: - string - 'null' description: NHS Authority Code 2011. example: E18000007 authority_name: type: - string - 'null' description: NHS Authority Name. example: London pclh_code: type: - string - 'null' description: Primary Care/Local Health Code. example: 5LE pclh_code_2011: type: - string - 'null' description: Primary Care/Local Health Code 2011. example: E16000059 pclh_name: type: - string - 'null' description: Primary Care/Local Health Name. example: Southwark ward_code: type: - string - 'null' description: Local Authority Ward Code. example: E05011095 ward_code_2011: type: - string - 'null' description: Local Authority Ward Code 2011. example: E05011095 ward_name: type: - string - 'null' description: Local Authority Ward Name. example: Borough & Bankside ccg_code: type: - string - 'null' description: CCG Current Area Code. example: E38000244 ccg_name: type: - string - 'null' description: CCG Current Area Name. example: NHS South East London CCG doh_code: type: - string - 'null' description: CCG Former/DH Area Code. example: 72Q additionalProperties: false description: Enrichment attributes that can be returned, based on the GBR Health dataset. AddressDatasetElement: type: object properties: id: type: - string - 'null' description: The ID of the dataset. example: au-address-datafusion name: type: - string - 'null' description: The name of the dataset. example: Australia Enhanced Address additionalProperties: false description: Address dataset element. EnrichmentV2GbrAliasResult: type: object properties: aliases: $ref: '#/components/schemas/EnrichmentV2GbrAliasElementsResult' additionalProperties: false description: Response for GBR Alias dataset. EnrichmentV2IrlMosaicResult: type: object properties: household: $ref: '#/components/schemas/EnrichmentV2IrlMosaicHouseholdResult' additionalProperties: false description: Response for IRL Mosaic dataset. AddressLookupV2RequestAttributes: type: object properties: locality_lookup: type: - array - 'null' items: type: string description: AddressLookupV2RequestAttributes for locality lookup. postal_code_lookup: type: - array - 'null' items: type: string description: AddressLookupV2RequestAttributes for postal code lookup. additionalProperties: false description: AddressLookupV2RequestAttributes for locality search. AddressComponentOrganization: type: object properties: department_name: type: - string - 'null' description: The department name within an organization. secondary_department_name: type: - string - 'null' description: The secondary department name within an organization. company_name: type: - string - 'null' description: The company name. business: $ref: '#/components/schemas/AddressComponentBusinessOrganization' additionalProperties: false description: The organization component. EnrichmentV2GbrParliamentScotlandResult: type: object properties: constituency_code: type: - string - 'null' description: Official code given to the Scottish Parliamentary Constituency. constituency: type: - string - 'null' description: Official name given to the Scottish Parliamentary Constituency. region: type: - string - 'null' description: Official name given to the Scottish Parliament electoral region. region_code: type: - string - 'null' description: Official code given to the Scottish Parliament electoral region. mp: type: - string - 'null' description: Name of the MSP representing the constituency. mp_party: type: - string - 'null' description: Name of the party to which the MSP belongs. regional_msp1: type: - string - 'null' description: Name of the first MSP representing the electoral region. regional_msp1_party: type: - string - 'null' description: Name of the party to which the first regional MSP belongs. regional_msp2: type: - string - 'null' description: Name of the second MSP representing the electoral region. regional_msp2_party: type: - string - 'null' description: Name of the party to which the second regional MSP belongs. regional_msp3: type: - string - 'null' description: Name of the third MSP representing the electoral region. regional_msp3_party: type: - string - 'null' description: Name of the party to which the third regional MSP belongs. regional_msp4: type: - string - 'null' description: Name of the fourth MSP representing the electoral region. regional_msp4_party: type: - string - 'null' description: Name of the party to which the fourth regional MSP belongs. regional_msp5: type: - string - 'null' description: Name of the fifth MSP representing the electoral region. regional_msp5_party: type: - string - 'null' description: Name of the party to which the fifth regional MSP belongs. regional_msp6: type: - string - 'null' description: Name of the sixth MSP representing the electoral region. regional_msp6_party: type: - string - 'null' description: Name of the party to which the sixth regional MSP belongs. regional_msp7: type: - string - 'null' description: Name of the seventh MSP representing the electoral region. regional_msp7_party: type: - string - 'null' description: Name of the party to which the seventh regional MSP belongs. additionalProperties: false description: Response for GBR Scottish Parliament. Address7Lines: type: object properties: address_line_1: type: - string - 'null' description: The first line of address containing a number of specific components relating to the premises and street. example: 1 Main Street address_line_2: type: - string - 'null' description: The second line of address containing a number of specific components relating to the premises and street. address_line_3: type: - string - 'null' description: The third line of address containing a number of specific components relating to the premises and street. locality: type: - string - 'null' description: The town, locality or suburb. example: MELBOURNE region: type: - string - 'null' description: The city, state code or province. example: VIC postal_code: type: - string - 'null' description: The post/zip code. example: '3004' country: type: - string - 'null' description: The localised country name. example: AUSTRALIA additionalProperties: false description: Seven address lines representing a formatted address for the chosen country. EnrichmentV2AprHealthMetadata: type: object properties: health: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2AttributesAusRegionalGeocodes: enum: - latitude - longitude - match_level - sa1 - meshblock - lga_code - lga_name - street_pid - locality_pid - geocode_level_code - geocode_level_description - geocode_type_code - geocode_type_description - highest_level_longitude - highest_level_latitude - highest_level_elevation - highest_level_planimetric_accuracy - highest_level_boundary_extent - highest_level_geocode_reliability_code - highest_level_geocode_reliability_description - confidence_level_code - confidence_level_description - 2021_meshblock_id - 2021_meshblock_code - 2021_meshblock_match_code - 2021_meshblock_match_description - 2016_meshblock_id - 2016_meshblock_code - 2016_meshblock_match_code - 2016_meshblock_match_description - address_type_code - primary_address_pid - address_join_type - collector_district_id - collector_district_code - commonwealth_electoral_boundary_id - commonwealth_electoral_boundary_name - statistical_local_area_id - statistical_local_area_code - statistical_local_area_name - state_electoral_boundary_id - state_electoral_boundary_name - state_electoral_effective_start - state_electoral_effective_end - state_electoral_new_pid - state_electoral_new_name - state_electoral_new_effective_start - state_electoral_new_effective_end - address_level_longitude - address_level_latitude - address_level_elevation - address_level_planimetric_accuracy - address_level_boundary_extent - address_level_geocode_reliability_code - address_level_geocode_reliability_description - street_level_longitude - street_level_latitude - street_level_planimetric_accuracy - street_level_boundary_extent - street_level_geocode_reliability_code - street_level_geocode_reliability_description - locality_level_longitude - locality_level_latitude - locality_level_planimetric_accuracy - locality_level_geocode_reliability_code - locality_level_geocode_reliability_description - gnaf_legal_parcel_identifier - locality_class_code type: string description: The dataset named AUS Regional Geocodes its associated attributes. AddressComponentRouteService: type: object properties: full_name: type: - string - 'null' description: The full name of the route service. service_type: type: - string - 'null' description: The route service type. service_number: type: - string - 'null' description: The route service number. delivery_name: type: - string - 'null' description: The route service delivery name. qualifier: type: - string - 'null' description: The route service qualifier. additionalProperties: false description: The route service component. PremiumLocationInsightGeocodesAccess: type: object properties: latitude: type: - number - 'null' description: The latitude of access geocode. format: double example: 52.9413 longitude: type: - number - 'null' description: The longitude of access geocode. format: double example: 1.16312 additionalProperties: false description: Access geocode for the specified address. AddressPromptSetsV1Request: required: - country_iso - datasets - prompt_set type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code. example: AUS datasets: minItems: 1 type: array items: type: string description: The datasets of the promptset. example: - au-address search_type: $ref: '#/components/schemas/AddressSearchType' prompt_set: $ref: '#/components/schemas/AddressPromptSetType' additionalProperties: false description: Address prompt set request. AddressFormatV1ResponseEnrichment: type: object properties: transaction_id: type: - string - 'null' description: The transaction id of the request. result: $ref: '#/components/schemas/EnrichmentV2ResultAddressValidate' metadata: $ref: '#/components/schemas/EnrichmentV2ResultAddressValidateMetadata' error: $ref: '#/components/schemas/ResponseError' additionalProperties: false description: Enrichment response object, used for format and enrich requests. EnrichmentV2AprLocationGridBuildingResult: type: object properties: x_coordinate: type: - number - 'null' description: Easting coordinate of the building in metres (1 cm resolution). format: double y_coordinate: type: - number - 'null' description: Northing coordinate of the building in metres (1 cm resolution). format: double ap_x_coordinate: type: - number - 'null' description: Easting coordinate in 10 cm resolution, zero-padded to 8 digits. format: double ap_y_coordinate: type: - number - 'null' description: Northing coordinate in 10 cm resolution, zero-padded to 8 digits. format: double additionalProperties: false description: Response for Addressbase Location Grid Building. AddressSuggestionV2Hub: type: object properties: text: type: - string - 'null' description: Gets or sets the suggestion text matched: type: - array - 'null' items: type: array items: type: integer format: int32 description: Gets or sets the matched field global_address_key: type: - string - 'null' description: Gets or sets the global address key format: type: - string - 'null' description: Gets or sets the format field dataset: type: - string - 'null' description: Gets or sets the suggestion dataset names: type: - array - 'null' items: type: string description: The additional attributes of the suggestion. uprn: type: - string - 'null' description: The UPRN of the suggestion. additionalProperties: false description: The address suggestion for the hub v2 endpoint. EnrichmentV2DatasetGbrGovernment: type: object properties: eer_code: type: - string - 'null' description: European Electoral Region Code. example: E15000007 eer_code_pre_2011: type: - string - 'null' description: European Electoral Region Code Pre-2011. example: '07' eer_name: type: - string - 'null' description: European Electoral Region Name. example: London gor_code: type: - string - 'null' description: Government Office for Region Code. example: E12000007 gor_code_pre_2011: type: - string - 'null' description: Government Office for Region Code Pre-2011. example: H gor_name: type: - string - 'null' description: Government Office for Region Name. example: London lea_code: type: - string - 'null' description: Local Education Authority Code. example: '210' lea_name: type: - string - 'null' description: Local Education Authority Name. example: Southwark la_code: type: - string - 'null' description: Local Authority Code. example: E09000028 la_code_pre_2011: type: - string - 'null' description: Local Authority Code Pre-2011. example: 00BE la_name: type: - string - 'null' description: Local Authority Name. example: Southwark ward_code: type: - string - 'null' description: Local Authority Ward Code. example: E05011095 ward_code_pre_2011: type: - string - 'null' description: Local Authority Ward Code Pre-2011. example: 00AXGN ward_name: type: - string - 'null' description: Local Authority Ward Name. example: Borough & Bankside cens_out_area: type: - string - 'null' description: Census Output Area. example: E00019790 additionalProperties: false description: Enrichment attributes that can be returned, based on the GBR Government dataset. EnrichmentV2AprStreetRecordResult: type: object properties: type: type: - string - 'null' description: Indicates the street type represented by the record. authority: type: - string - 'null' description: Indicates the Street Naming and Numbering Authority or Local Highway Authority. classification: type: - string - 'null' description: Indicates the classification of the street record. surface_type: type: - string - 'null' description: Shows the type of surface on the street. state: type: - string - 'null' description: Shows the current state of the street. state_date: type: - string - 'null' description: The date on which the street entered its current state. version: type: - string - 'null' description: Version number of the street record. additionalProperties: false description: Response for Addressbase Street Record. EnrichmentV2AprLocationGrid: enum: - blpu - building - postal_code - street type: string description: The dataset named Addressbase Location Grid and its associated attributes. StandardIndustryClassificationElements: type: object properties: sic_2007_code: type: - string - 'null' description: The sic 2007 code. sic_2007_description: type: - string - 'null' description: The sic 2007 description. thomson_code: type: - string - 'null' description: The Thomson code. thomson_description: type: - string - 'null' description: The Thomson description. additionalProperties: false description: The standard industry classification elements of a business. AddressComponentSubBuilding: type: object properties: name: type: - string - 'null' description: The name of a building or property. entrance: $ref: '#/components/schemas/AddressComponentSubBuildingItem' floor: $ref: '#/components/schemas/AddressComponentSubBuildingItem' door: $ref: '#/components/schemas/AddressComponentSubBuildingItem' additionalProperties: false description: The sub building component. EnrichmentV2SgpMosaicMetadata: type: object properties: demographic_postal_code: $ref: '#/components/schemas/DatasetMetadataV2' residential_postal_code: $ref: '#/components/schemas/DatasetMetadataV2' affluence: $ref: '#/components/schemas/DatasetMetadataV2' life_stage: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2AprQualityMetadataResult: type: object properties: coordinate_system: type: - string - 'null' description: Name of the coordinate system used. coordinate_unit: type: - string - 'null' description: Unit of measurement used. postal_code_type: type: - string - 'null' description: Indicates small or large user postcode. gazetteer_name: type: - string - 'null' description: Name of the dataset. gazetteer_scope: type: - string - 'null' description: Description of dataset contents. linked_data: type: - string - 'null' description: External sources used to update dataset. gazetteer_owner: type: - string - 'null' description: Organization responsible for the dataset. metadata_date: type: - string - 'null' description: Date metadata was last updated. classification_scheme: type: - string - 'null' description: Classification scheme used in dataset. gazetteer_date: type: - string - 'null' description: Date dataset is considered current. additionalProperties: false description: Response for Addressbase Quality Metadata. EnrichmentV2IrlMosaicMetadata: type: object properties: household: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2SgpMosaicResult: type: object properties: demographic_postal_code: $ref: '#/components/schemas/EnrichmentV2SgpMosaicDemographicPostalCodeResult' residential_postal_code: $ref: '#/components/schemas/EnrichmentV2SgpMosaicResidentialPostalCodeResult' affluence: $ref: '#/components/schemas/EnrichmentV2SgpMosaicFactorResult' life_stage: $ref: '#/components/schemas/EnrichmentV2SgpMosaicFactorResult' additionalProperties: false description: Response for SGP Mosaic dataset. EnrichmentV2AprCrossReferenceMetadata: type: object properties: addresslayer_2: $ref: '#/components/schemas/DatasetMetadataV2' council_tax: $ref: '#/components/schemas/DatasetMetadataV2' integrated_transport_network: $ref: '#/components/schemas/DatasetMetadataV2' non_domestic_rates: $ref: '#/components/schemas/DatasetMetadataV2' topography_layer: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2AprParliamentMetadata: type: object properties: westminster: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2GbrLocationGrid: enum: - postzon - codepoint type: string description: The dataset named GBR Location Grid and its associated attributes. AddressLayoutsV2CreateResult: type: object properties: id: type: - string - 'null' description: Layout ID additionalProperties: false description: Address Layouts V2 Create Result EnrichmentV2AprHealth: enum: - health type: string description: The dataset named Addressbase Health and its associated attributes. EnrichmentV2SgpMosaicDemographicPostalCodeResult: type: object properties: type_code: type: - string - 'null' description: MOSAIC Type Code. type: type: - string - 'null' description: Name of MOSAIC Type. group_code: type: - string - 'null' description: MOSAIC Group Code. group: type: - string - 'null' description: Name of MOSAIC Group. additionalProperties: false description: Response for SGP Mosaic Demographic Postal Code. EnrichmentV2AprLocationGridMetadata: type: object properties: blpu: $ref: '#/components/schemas/DatasetMetadataV2' building: $ref: '#/components/schemas/DatasetMetadataV2' postal_code: $ref: '#/components/schemas/DatasetMetadataV2' street: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressLayoutV2: required: - applies_to - lines - name type: object properties: name: maxLength: 100 minLength: 1 pattern: ^([A-Za-z0-9_\-]{1}[A-Za-z0-9_\-\ ]*[A-Za-z0-9_\-]{1}|[A-Za-z0-9_\-]{1})$ type: string description: The layout name. comment: type: - string - 'null' description: The layout comment. applies_to: minItems: 1 type: array items: $ref: '#/components/schemas/AddressLayoutV2AppliesTo' description: The layout applies to. options: $ref: '#/components/schemas/AddressLayoutV2Options' lines: minItems: 1 type: array items: $ref: '#/components/schemas/AddressLayoutV2Line' description: The layout lines. additionalProperties: false description: Address Layout V2. AddressFormatV1RequestAttributes: type: object properties: geocodes: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesGeocode' description: The dataset named Geocodes and its associated attributes. usa_regional_geocodes: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesUsaRegionalGeocodes' description: The dataset named USA Regional Geocodes and its associated attributes. aus_regional_geocodes: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesAusRegionalGeocodes' description: The dataset named AUS Regional Geocodes and its associated attributes. nzl_regional_geocodes: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesNzlRegionalGeocodes' description: The dataset named NZL Regional Geocodes and its associated attributes. uk_location_complete: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesUkLocationComplete' description: The dataset named UK Location Complete and its associated attributes. uk_location_essential: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesUkLocationEssential' description: The dataset named UK Location Essential and its associated attributes. gbr_government: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesGbrGovernment' description: The dataset named GBR Government and its associated attributes. gbr_health: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesGbrHealth' description: The dataset named GBR Health and its associated attributes. gbr_business: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesGbAdditionalBusinessAddressValidate' description: The dataset named GBR Business and its associated attributes. premium_location_insight: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesPremiumLocationInsight' description: The dataset named Premium Location Insight and its associated attributes. what3words: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AttributesWhat3Words' description: The dataset named what3words and its associated attributes. gbr_location_grid: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2GbrLocationGrid' description: The dataset named GBR Location Grid and its associated attributes. gbr_parliament: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2GbrParliament' description: The dataset named GBR Parliament and its associated attributes. gbr_mosaic: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2GbrMosaic' description: The dataset named GBR Mosaic and its associated attributes. gbr_mosaic_financial: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2GbrMosaicFinancial' description: The dataset named GBR Mosaic Financial and its associated attributes. gbr_alias: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2GbrAlias' description: The dataset named GBR Alias and its associated attributes. gbr_quality: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2GbrQuality' description: The dataset named GBR Quality and its associated attributes. addressbase_classification: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprClassification' description: The dataset named Addressbase Classification and its associated attributes. addressbase_cross_reference: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprCrossReference' description: The dataset named Addressbase Cross Reference and its associated attributes. addressbase_government: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprGovernment' description: The dataset named Addressbase Government and its associated attributes. addressbase_health: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprHealth' description: The dataset named Addressbase Health and its associated attributes. addressbase_location_grid: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprLocationGrid' description: The dataset named Addressbase Location Grid and its associated attributes. addressbase_parliament: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprParliament' description: The dataset named Addressbase Parliament and its associated attributes. addressbase_quality: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprQuality' description: The dataset named Addressbase Quality and its associated attributes. addressbase_street: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprStreet' description: The dataset named Addressbase Street and its associated attributes. addressbase_topography: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprTopography' description: The dataset named Addressbase Topography and its associated attributes. addressbase_voa: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2AprVoa' description: The dataset named Addressbase Voa and its associated attributes. irl_mosaic: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2IrlMosaic' description: The dataset named IRL Mosaic and its associated attributes. nzl_household: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2NzlHousehold' description: The dataset named NZL Household and its associated attributes. nzl_mosaic: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2NzlMosaic' description: The dataset named NZL Mosaic and its associated attributes. nzl_property: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2NzlProperty' description: The dataset named NZL Property and its associated attributes. sgp_mosaic: type: - array - 'null' items: $ref: '#/components/schemas/EnrichmentV2SgpMosaic' description: The dataset named SGP Mosaic and its associated attributes. additionalProperties: false description: AddressFormatV1RequestAttributes used for format and enrich. AddressValidateV1Request: required: - components - country_iso - datasets type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code of address. example: AUS datasets: minItems: 1 type: array items: type: string description: The datasets for address validation. example: - au-address max_suggestions: maximum: 100 minimum: 1 type: - integer - 'null' description: The maximum number of suggestions a search request should return (should be between 1 and 100). format: int32 example: 10 components: $ref: '#/components/schemas/AddressInputComponents' options: type: - array - 'null' items: $ref: '#/components/schemas/AddressNameValuePair' description: Additional options. example: - name: intensity value: close attributes: $ref: '#/components/schemas/AddressFormatV1RequestAttributes' layouts: type: - array - 'null' items: type: string description: Custom layout name. example: - default layout_format: $ref: '#/components/schemas/AddressLayoutFormat' additionalProperties: false description: Used for combined Validate and Enrichment call EnrichmentV2AttributesUkLocationComplete: enum: - latitude - longitude - match_level - udprn - uprn - x_coordinate - y_coordinate type: string description: The dataset named UK Location Complete its associated attributes. EnrichmentV2SgpMosaicResidentialPostalCodeResult: type: object properties: households: type: - string - 'null' description: Residential Units. residents: type: - string - 'null' description: Population. additionalProperties: false description: Response for SGP Mosaic Residential Postal Code. EnrichmentV2AprClassification: enum: - code - record - scheme type: string description: The dataset named Addressbase Classification and its associated attributes. EnrichmentV2AprVoaResult: type: object properties: primary_description: $ref: '#/components/schemas/EnrichmentV2AprVoaPrimaryDescriptionResult' special_category: $ref: '#/components/schemas/EnrichmentV2AprVoaSpecialCategoryResult' additionalProperties: false description: Response for Addressbase Voa dataset. EnrichmentV2IrlMosaicHouseholdResult: type: object properties: type_code: type: - string - 'null' description: MOSAIC Type Code. type: type: - string - 'null' description: MOSAIC Type Name. group_code: type: - string - 'null' description: MOSAIC Group Code. group: type: - string - 'null' description: MOSAIC Group Name. area_code: type: - string - 'null' description: MOSAIC Area Code. additionalProperties: false description: Response for IRL Mosaic Household. EnrichmentV2AprTopographyResult: type: object properties: topographic_ids: $ref: '#/components/schemas/EnrichmentV2AprTopographyTopographicIdsResult' additionalProperties: false description: Response for Addressbase Topography dataset. AddressComponentStreet: type: object properties: full_name: type: - string - 'null' description: 'The combination of the other populated secondary street components: prefix, name, type, suffix.' example: Summer St prefix: type: - string - 'null' description: The street prefix only. name: type: - string - 'null' description: The street name only. example: Summer type: type: - string - 'null' description: The street type only. example: St suffix: type: - string - 'null' description: The street suffix only. additionalProperties: false description: The street component. EnrichmentV2GbrQualityRecordResult: type: object properties: address: type: - string - 'null' description: PAF Quality of Address postal_code: type: - string - 'null' description: PAF Quality of Postcode additionalProperties: false description: Response for GBR PAF Match Quality. PremiumLocationInsightTime: type: object properties: time_zone_id: type: - string - 'null' description: Time zone id. example: Africa/Cairo generic: type: - string - 'null' description: Generic time zone name. example: Eastern European Time standard: type: - string - 'null' description: Standard time zone name. example: Eastern European Standard Time daylight: type: - string - 'null' description: Daylight time zone name. example: Eastern European Summer Time reference_time: $ref: '#/components/schemas/PremiumLocationInsightReferenceTime' time_transition: type: - array - 'null' items: $ref: '#/components/schemas/PremiumLocationInsightTimeTransition' description: Daylight savings time (DST) transitions information returned based on a specified address. xml: name: time_transition wrapped: true additionalProperties: false description: Time zone information returned based on a specified address. EnrichmentV2AprQualityCustodianResult: type: object properties: custodian: type: - string - 'null' description: Name of the custodian organization. custodian_uprn: type: - string - 'null' description: UPRN of the custodian location. custodian_language: type: - string - 'null' description: Local language name of the custodian. custodian_code: type: - string - 'null' description: Four-digit code identifying the custodian. additionalProperties: false description: Response for Addressbase Quality Custodian. AddressLayoutV2LineElement: type: object properties: element_name: type: - string - 'null' description: The element name. additionalProperties: false description: Address Layout V2 Line Element. AddressPromptSetsV1Result: type: object properties: lines: type: - array - 'null' items: $ref: '#/components/schemas/AddressPromptSetsLine' description: Describes one line of the prompt set. additionalProperties: false description: Address prompt set result. EnrichmentV2GbrCommonElementsResult: type: object properties: type_code: type: - string - 'null' description: Type Code. type: type: - string - 'null' description: Type Name. group_code: type: - string - 'null' description: Group Code. group: type: - string - 'null' description: Group Name. additionalProperties: false description: Response for dataset consisting of type code, type, group code and group elements. EnrichmentV2GbrLocationGridPostzonResult: type: object properties: x_coordinate: type: - number - 'null' description: Native OS or OSNI grid-reference. format: double y_coordinate: type: - number - 'null' description: Native OS or OSNI grid-reference. format: double os_x_coordinate: type: - number - 'null' description: 100m OS Easting grid-reference. format: double os_y_coordinate: type: - number - 'null' description: 100m OS Northing grid-reference. format: double latitude: type: - number - 'null' description: WGS84 projection compatible with the GPS system and returned to six decimal places. format: double longitude: type: - number - 'null' description: WGS84 projection compatible with the GPS system and returned to six decimal places. format: double os_landranger: type: - string - 'null' description: OS Land-ranger format derived from OS East and OS North. additionalProperties: false description: Response for GBR 100m Postzon Grid. Suggestion: type: object properties: locality: $ref: '#/components/schemas/LocalityComponents' postal_code: $ref: '#/components/schemas/PostalCode' postal_code_key: type: - string - 'null' description: Gets or sets the suggestion postal code key (to do postal code enrichment requests) locality_key: type: - string - 'null' description: Gets or sets the suggestion locality key (to do centroid enrichment requests) what3words: $ref: '#/components/schemas/What3WordsComponent' additionalProperties: false description: The suggestions that match the address search input. AddressComponentPostalCode: type: object properties: full_name: type: - string - 'null' description: The full name of the postal code. example: 92626-7037 primary: type: - string - 'null' description: The primary name of the postal code. example: '92626' secondary: type: - string - 'null' description: The secondary name of the postal code. example: '7037' additionalProperties: false description: The post code component. AddressComponentLocalityItem: type: object properties: name: type: - string - 'null' description: The name for this subcomponent. example: NOTTINGHAM code: type: - string - 'null' description: The code of this subcomponent. description: type: - string - 'null' description: The description of this subcomponent. additionalProperties: false description: A single place name, code and a description of its type. EnrichmentV2AttributesNzlRegionalGeocodes: enum: - front_of_property_nztm_x_coordinate - front_of_property_nztm_y_coordinate - centroid_of_property_nztm_x_coordinate - centroid_of_property_nztm_y_coordinate - linz_parcel_id - property_purpose_type - addressable - mesh_block_code - territorial_authority_code - territorial_authority_name - regional_council_code - regional_council_name - general_electorate_code - general_electorate_name - maori_electorate_code - maori_electorate_name - front_of_property_latitude - front_of_property_longitude - centroid_of_property_latitude - centroid_of_property_longitude - match_level type: string description: The dataset named NZL Regional Geocodes its associated attributes. AddressLayoutsV1Request: required: - country_iso - datasets type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code of address. example: AUS datasets: minItems: 1 type: array items: type: string description: The datasets for address layout. example: - au-address additionalProperties: false description: The Address Layout V1 request. PremiumLocationInsightGeocodesBuildingXy: type: object properties: x_coordinate: type: - number - 'null' description: The Geocode 'X' coordinate for the centre of the property. format: double example: 152718.84 y_coordinate: type: - number - 'null' description: The Geocode 'Y' coordinate for the centre of the property. format: double example: 529726.56 additionalProperties: false description: Building XY coordinate for the specified address. AddressLayoutsV2CreateResponse: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressLayoutsV2CreateResult' additionalProperties: false description: Response model for Address Layouts V2 create endpoint. EnrichmentV2AprGovernmentElementsResult: type: object properties: eer_code: type: - string - 'null' description: Code for European Electoral Region. eer_name: type: - string - 'null' description: Name of European Electoral Region. gor_code: type: - string - 'null' description: Code for Government Office Region. gor_name: type: - string - 'null' description: Name of Government Office Region. lea_code: type: - string - 'null' description: Code for Local Education Authority. lea_name: type: - string - 'null' description: Name of Local Education Authority. la_code: type: - string - 'null' description: Code for Local Authority. la_name: type: - string - 'null' description: Name of Local Authority. ward_code: type: - string - 'null' description: Code for Local Authority Ward. ward_name: type: - string - 'null' description: Name of Local Authority Ward. cens_out_area: type: - string - 'null' description: Census Area output code. additionalProperties: false description: Response for Addressbase Government Elements. EnrichmentV2SgpMosaic: enum: - demographic_postal_code - residential_postal_code - affluence - life_stage type: string description: The dataset named SGP Mosaic and its associated attributes. EnrichmentV2ResultAddressValidate: type: object properties: geocodes: $ref: '#/components/schemas/EnrichmentV2DatasetGeocodes' usa_regional_geocodes: $ref: '#/components/schemas/EnrichmentV2DatasetUsaRegionalGeocodes' aus_regional_geocodes: $ref: '#/components/schemas/EnrichmentV2DatasetAusRegionalGeocodes' nzl_regional_geocodes: $ref: '#/components/schemas/EnrichmentV2DatasetNzlRegionalGeocodes' uk_location_complete: $ref: '#/components/schemas/EnrichmentV2DatasetUkLocationComplete' uk_location_essential: $ref: '#/components/schemas/EnrichmentV2DatasetUkLocationEssential' gbr_government: $ref: '#/components/schemas/EnrichmentV2DatasetGbrGovernment' gbr_business: $ref: '#/components/schemas/EnrichmentV2DatasetGbAdditionalBusinessAddressValidate' gbr_health: $ref: '#/components/schemas/EnrichmentV2DatasetGbrHealth' premium_location_insight: $ref: '#/components/schemas/EnrichmentV2DatasetPremiumLocationInsight' what3words: $ref: '#/components/schemas/EnrichmentV2DatasetWhat3Words' gbr_location_grid: $ref: '#/components/schemas/EnrichmentV2GbrLocationGridResult' gbr_parliament: $ref: '#/components/schemas/EnrichmentV2GbrParliamentResult' gbr_mosaic: $ref: '#/components/schemas/EnrichmentV2GbrMosaicResult' gbr_mosaic_financial: $ref: '#/components/schemas/EnrichmentV2GbrMosaicFinancialResult' gbr_alias: $ref: '#/components/schemas/EnrichmentV2GbrAliasResult' gbr_quality: $ref: '#/components/schemas/EnrichmentV2GbrQualityResult' addressbase_classification: $ref: '#/components/schemas/EnrichmentV2AprClassificationResult' addressbase_cross_reference: $ref: '#/components/schemas/EnrichmentV2AprCrossReferenceResult' addressbase_government: $ref: '#/components/schemas/EnrichmentV2AprGovernmentResult' addressbase_health: $ref: '#/components/schemas/EnrichmentV2AprHealthResult' addressbase_location_grid: $ref: '#/components/schemas/EnrichmentV2AprLocationGridResult' addressbase_parliament: $ref: '#/components/schemas/EnrichmentV2AprParliamentResult' addressbase_quality: $ref: '#/components/schemas/EnrichmentV2AprQualityResult' addressbase_street: $ref: '#/components/schemas/EnrichmentV2AprStreetResult' addressbase_topography: $ref: '#/components/schemas/EnrichmentV2AprTopographyResult' addressbase_voa: $ref: '#/components/schemas/EnrichmentV2AprVoaResult' irl_mosaic: $ref: '#/components/schemas/EnrichmentV2IrlMosaicResult' nzl_household: $ref: '#/components/schemas/EnrichmentV2NzlHouseholdResult' nzl_mosaic: $ref: '#/components/schemas/EnrichmentV2NzlMosaicResult' nzl_property: $ref: '#/components/schemas/EnrichmentV2NzlPropertyResult' sgp_mosaic: $ref: '#/components/schemas/EnrichmentV2SgpMosaicResult' additionalProperties: false description: Details about the result. Includes the enriched data. EnrichmentV2AprClassificationSchemeResult: type: object properties: scheme: type: - string - 'null' description: Name of the classification scheme. version: type: - string - 'null' description: Version of the classification scheme. additionalProperties: false description: Response for Addressbase Classification Scheme. EnrichmentV2AprStreetResult: type: object properties: grid: $ref: '#/components/schemas/EnrichmentV2AprStreetGridResult' record: $ref: '#/components/schemas/EnrichmentV2AprStreetRecordResult' usrn: $ref: '#/components/schemas/EnrichmentV2AprStreetUsrnResult' additionalProperties: false description: Response for Addressbase Street dataset. EnrichmentV2GbrParliament: enum: - westminster - scotland type: string description: The dataset named GBR Parliament and its associated attributes. AddressComponentAdditionalSubRegion: type: object properties: administrative_county: type: - string - 'null' description: The name of the administratve county. example: North Yorkshire former_postal_county: type: - string - 'null' description: The name of the former postal county. example: North Yorkshire traditional_county: type: - string - 'null' description: The name of the traditional county. example: Yorkshire additionalProperties: false description: The additional sub region component. AddressComponentAdditionalElements: type: object properties: locality: $ref: '#/components/schemas/AddressComponentAdditionalLocality' additionalProperties: false description: The additional elements component. AddressLayout: type: object properties: name: type: - string - 'null' description: The name of the address layout. example: QADefault country_iso_3: type: - string - 'null' description: The country ISO3 code. example: GBR datasets: type: - array - 'null' items: type: string description: The dataset for address validation. example: - gb-address additionalProperties: false description: The address layout. AddressLookupV2Result: type: object properties: more_results_available: type: boolean description: Gets or sets a value indicating whether property that there are more suggestions available than the results provided. confidence: type: - string - 'null' description: Gets or sets the outcome (confidence level) of the validation. example: Verified match suggestions_key: type: - string - 'null' description: Gets or sets the suggestions key for address suggestion refinement. suggestions_prompt: type: - string - 'null' description: Gets or sets the prompt to display to the user, indicating what information they should enter next. example: Enter selection suggestions: type: - array - 'null' items: $ref: '#/components/schemas/Suggestion' description: Gets or sets the possible postcode, locality or UDPRN (for GBR) addresses: type: - array - 'null' items: $ref: '#/components/schemas/AddressSuggestionV2Hub' description: Gets or sets the collection of suggested addresses addresses_formatted: type: - array - 'null' items: $ref: '#/components/schemas/AddressLookupV2ResultAddressFormatted' description: Gets or sets the collection of formatted addresses additionalProperties: false description: Address lookup V2 result. AddressMetadataInfo: type: object properties: sources: type: - array - 'null' items: type: string description: Source of address information. number_of_households: type: - string - 'null' description: Number of households for records in GBR Not Yet Built, or multi-occupancy count of the owning delivery point for GBR Multiple Residence. example: '1' just_built_date: type: - string - 'null' description: Construction date of the record, if it has been constructed in the last 6 months (GBR specific). example: '20210605' identifier: $ref: '#/components/schemas/AddressMetadataInfoId' additionalProperties: false description: Address information. EnrichmentV2AprClassificationCodeResult: type: object properties: code: type: - string - 'null' description: Code describing land use classification. primary: type: - string - 'null' description: Description of primary classification element. secondary: type: - string - 'null' description: Description of secondary classification element. tertiary: type: - string - 'null' description: Description of tertiary classification element. quaternary: type: - string - 'null' description: Description of quaternary classification element. additionalProperties: false description: Response for Addressbase Classification Code. EnrichmentV2GbrQualityResult: type: object properties: record: $ref: '#/components/schemas/EnrichmentV2GbrQualityRecordResult' additionalProperties: false description: Response for GBR Quality dataset. AddressLayoutFormat: enum: - default - address_lines type: string description: The format of the customized address layout. EnrichmentV2AprLocationGridPostalCodeResult: type: object properties: x_coordinate: type: - number - 'null' description: Easting coordinate of the postcode in metres (1 cm resolution). format: double y_coordinate: type: - number - 'null' description: Northing coordinate of the postcode in metres (1 cm resolution). format: double ap_x_coordinate: type: - number - 'null' description: Easting coordinate in 10 cm resolution, zero-padded to 8 digits. format: double ap_y_coordinate: type: - number - 'null' description: Northing coordinate in 10 cm resolution, zero-padded to 8 digits. format: double additionalProperties: false description: Response for Addressbase Location Grid Postal Code. EnrichmentV2PremiumLocationInsightMetadata: type: object properties: geocodes: $ref: '#/components/schemas/DatasetMetadata' geocodes_building_xy: $ref: '#/components/schemas/DatasetMetadata' geocodes_access: $ref: '#/components/schemas/DatasetMetadata' time: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: "Attribute-level metadata for the Premium Location Insight dataset.\n\n (The time attribute is excluded in Premium Location Insight Lite.)
" EnrichmentV2AprLocationGridBlpuResult: type: object properties: x_coordinate: type: - number - 'null' description: Easting coordinate of the BLPU in metres (1 cm resolution). format: double y_coordinate: type: - number - 'null' description: Northing coordinate of the BLPU in metres (1 cm resolution). format: double ap_x_coordinate: type: - number - 'null' description: Easting coordinate in 10 cm resolution, zero-padded to 8 digits. format: double ap_y_coordinate: type: - number - 'null' description: Northing coordinate in 10 cm resolution, zero-padded to 8 digits. format: double latitude: type: - number - 'null' description: Latitude of the BLPU using the ETRS89 coordinate system. format: double longitude: type: - number - 'null' description: Longitude of the BLPU using the ETRS89 coordinate system. format: double rpc: type: - string - 'null' description: Indicates the location type of the grid reference (e.g., visual centre, postcode-based). postal_code: type: - string - 'null' description: The postcode associated with the BLPU. additionalProperties: false description: Response for Addressbase Location Grid Blpu. EnrichmentV2AttributesGbAdditionalBusinessAddressValidate: enum: - urn - commercial_mosaic - registration - phone - number_of_employees - location - standard_industry_classification - non_limited_company_key type: string description: The dataset named what3words and its associated attributes. LocalityItem: type: object properties: name: type: - string - 'null' description: Gets or sets the locality name code: type: - string - 'null' description: Gets or sets the locality code description: type: - string - 'null' description: Gets or sets the locality description additionalProperties: false description: Initializes a new instance of the Experian.Hub.Feature.AddressValidate.GfoClients.GfoRest.Models.GfoRestSearchV2ResponseModel.LocalityItem class. EnrichmentV2NzlMosaicResult: type: object properties: mosaic: $ref: '#/components/schemas/EnrichmentV2NzlMosaicElementResult' mosaic_segment: $ref: '#/components/schemas/EnrichmentV2NzlElementCodeResult' factor_a: $ref: '#/components/schemas/EnrichmentV2NzlMosaicFactorResult' factor_b: $ref: '#/components/schemas/EnrichmentV2NzlMosaicFactorResult' factor_c: $ref: '#/components/schemas/EnrichmentV2NzlMosaicFactorResult' factor_d: $ref: '#/components/schemas/EnrichmentV2NzlMosaicFactorResult' factor_e: $ref: '#/components/schemas/EnrichmentV2NzlMosaicFactorResult' factor_f: $ref: '#/components/schemas/EnrichmentV2NzlMosaicFactorResult' additionalProperties: false description: Response for NZL Mosaic dataset. AddressLayoutsV2ListResponse: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: type: - array - 'null' items: $ref: '#/components/schemas/AddressLayoutsV2ListResponseModel' description: Address Layouts V2 List Result Collection additionalProperties: false description: Response model for Address Layouts V2 List endpoint. EnrichmentV2NzlMosaicElementResult: type: object properties: group_code: type: - string - 'null' description: Group Code. type_code: type: - string - 'null' description: Type Code. additionalProperties: false description: Response for NZL Mosaic's Elements. EnrichmentV2NzlElementCodeResult: type: object properties: code: type: - string - 'null' description: Code. additionalProperties: false description: Response for NZL Elements' Code. AddressValidationDetail: type: object properties: building_firm_name_corrected: type: boolean description: Building or Firm name has been added or changed. primary_number_corrected: type: boolean description: Primary Number has been added or changed. street_corrected: type: boolean description: Street has been (non-trivially) corrected. rural_route_highway_contract_matched: type: boolean description: Rural Route or Highway Contract has been matched. city_name_corrected: type: boolean description: City name has been added or changed. city_name_alias_matched: type: boolean description: City name has been alias matched. state_corrected: type: boolean description: State or Province has been added or changed. zip_code_corrected: type: boolean description: Post code has been added or corrected. secondary_num_retained: type: boolean description: Secondary number has been retained. iden_pre_st_info_retained: type: boolean description: Identifiable pre-street information has been retained. gen_pre_st_info_retained: type: boolean description: General pre-street information has been retained. post_st_info_retained: type: boolean description: Post-street information has been retained. additionalProperties: false description: Address validation details. EnrichmentV2NzlMosaicMetadata: type: object properties: mosaic: $ref: '#/components/schemas/DatasetMetadataV2' mosaic_segment: $ref: '#/components/schemas/DatasetMetadataV2' factor_a: $ref: '#/components/schemas/DatasetMetadataV2' factor_b: $ref: '#/components/schemas/DatasetMetadataV2' factor_c: $ref: '#/components/schemas/DatasetMetadataV2' factor_d: $ref: '#/components/schemas/DatasetMetadataV2' factor_e: $ref: '#/components/schemas/DatasetMetadataV2' factor_f: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2GbrMosaicMetadata: type: object properties: household: $ref: '#/components/schemas/DatasetMetadataV2' postal_code: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2AprCrossReferenceTopographyLayerResult: type: object properties: primary_key: type: - string - 'null' description: Primary key of the record in external dataset. key: type: - string - 'null' description: Unique key for the cross reference record. version: type: - string - 'null' description: Version number of the source object. created_date: type: - string - 'null' description: Date the record was created. update_date: type: - string - 'null' description: Date the record was last changed. entry_date: type: - string - 'null' description: Date of data entry. additionalProperties: false description: Response for Addressbase Cross Reference Topography Layer. AddressInputComponentName: type: object properties: forename: type: - string - 'null' description: The first name. middlename: type: - string - 'null' description: Middle initial. surname: type: - string - 'null' description: The surname. additionalProperties: false description: The address input component name. EnrichmentV2DatasetWhat3Words: type: object properties: latitude: type: - number - 'null' description: The latitude. format: double example: 51.75117 longitude: type: - number - 'null' description: The longitude. format: double example: -1.24623 name: type: - string - 'null' description: The what3words location. example: pretty.needed.chill description: type: - string - 'null' description: The nearest place example: near Oxford, Oxfordshire additionalProperties: false description: Enrichment attributes that can be returned, based on the what3words dataset. Key: type: object properties: type: type: - string - 'null' description: Gets or sets the key type example: postal_code value: type: - string - 'null' description: Gets or sets the key value example: NN14 4RX additionalProperties: false description: The key of the postal code. PremiumLocationInsightReferenceTime: type: object properties: tag: type: - string - 'null' description: Time zone applicable based on current timestamp. example: EET standard_offset: type: - string - 'null' description: Standard offset returned based on current timestamp. example: 02:00:00 daylight_savings: type: - string - 'null' description: Daylight savings returned based on current timestamp. example: 00:00:00 sunrise: type: - string - 'null' description: Sunrise time at the given time zone based on current timestamp. example: '2023-04-07T03:38:08.767292+00:00' sunset: type: - string - 'null' description: Sunset time at the given time zone based on current timestamp. example: '2023-04-07T16:16:40.8507771+00:00' additionalProperties: false description: Time zone information returned based on current timestamp. AddressNameValuePair: type: object properties: name: type: - string - 'null' description: The name of the pair. example: flatten value: type: - string - 'null' description: The value of the pair. example: 'true' additionalProperties: false description: The address name value pair. AddressMetadataInfoId: type: object properties: umrrn: type: - string - 'null' description: Royal Mail's Unique Multiple Residence Reference Number, an eight-digit code linked to UDPRNs in Royal Mail's Multiple Residence dataset. example: '50101642' udprn: type: - string - 'null' description: Royal Mail's Unique Delivery Point Reference Number, an eight-digit code assigned to every delivery point in the Postcode Address File (PAF). example: '12353232' uprn: type: - string - 'null' description: Unique Property Reference Number, a unique 12-digit identifier for each land and property unit (AddressBase and AddressBase with Names). example: '12353232' dpid: type: - string - 'null' description: 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. example: '62147712' gnafPid: type: - string - 'null' description: Geoscape Australia's Geocoded National Address File Persistent Identifier (G-NAF ID). example: GAVIC424477161 paf_address_key: type: - string - 'null' description: PAF Address key (GBR specific). example: 2304084100000000S hin: type: - string - 'null' description: Household Identification Number (applicable for AUS addresses). example: '203060068' organization_key: type: - string - 'null' description: Unique 14-character key for the organization record. lpi_key: type: - string - 'null' description: Unique 14-character key for the LPI record. dps: type: - string - 'null' description: A two character code uniquely identifying an individual delivery point within a postcode. parent_uprn: type: - string - 'null' description: The UPRN of the parent property associated with a record. building_id: type: - string - 'null' description: This is a unique number which identifies each building or premises. additionalProperties: false description: The ID metadata of formatted address. EnrichmentV2AprQualityMetadata: type: object properties: custodian: $ref: '#/components/schemas/DatasetMetadataV2' metadata: $ref: '#/components/schemas/DatasetMetadataV2' record: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressPromptSetsLine: type: object properties: prompt: type: - string - 'null' description: The prompt to display to the user. example: Building number or name. suggested_input_length: type: - integer - 'null' description: The suggested length of the input buffer. format: int32 example: 40 example: type: - string - 'null' description: An example of possible input. example: '12' additionalProperties: false description: PromptLine describes a line of a prompt set. AddressSuggestionsFormatV1: type: object properties: global_address_key: type: - string - 'null' description: The ID of the address received as part of a validation. address: $ref: '#/components/schemas/Address7Lines' addresses_formatted: type: - array - 'null' items: $ref: '#/components/schemas/AddressFormatted' description: Customized address layouts. components: $ref: '#/components/schemas/AddressComponent' metadata: $ref: '#/components/schemas/AddressMetadata' additionalProperties: false description: Address suggestions format V1. EnrichmentV2AprTopographyMetadata: type: object properties: topographic_ids: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressFormatted: type: object properties: layout_name: type: - string - 'null' description: The address layout name. example: QADefault not_enough_lines: type: boolean description: There are not enough address lines configured to display the whole address. has_truncated_lines: type: boolean description: Truncation has occurred on one or more address lines. address: type: - object - 'null' additionalProperties: {} description: The customized address layouts in default format. example: AmexStreet: 1 Main St AmexTown: Surbiton AmexCountry: United Kingdom gas_meters: - mprn: '52902306' - mprn: '52902307' additionalProperties: false description: Customized address layouts. AddressComponentLocality: type: object properties: region: $ref: '#/components/schemas/AddressComponentLocalityItem' sub_region: $ref: '#/components/schemas/AddressComponentLocalityItem' town: $ref: '#/components/schemas/AddressComponentLocalityItem' district: $ref: '#/components/schemas/AddressComponentLocalityItem' sub_district: $ref: '#/components/schemas/AddressComponentLocalityItem' additionalProperties: false description: The locality component. AddressLayoutV2Status: enum: - CreationInProgress - Completed type: string description: The status of the layout EnrichmentV2GbrQuality: enum: - record type: string description: The dataset named GBR Quality and its associated attributes. AddressDatasetsV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: type: - array - 'null' items: $ref: '#/components/schemas/AddressDatasetsCountryResult' description: The address datasets V1 result. additionalProperties: false description: Response model for AddressDatasetsV1 endpoint. EnrichmentV2AttributesWhat3Words: enum: - latitude - longitude - name - description type: string description: The dataset named what3words and its associated attributes. AddressFormatV1Components: type: object properties: language: type: - string - 'null' description: Address language. example: en-GB country_name: type: - string - 'null' description: The name of the country where the address is located. example: United Kingdom country_iso_3: type: - string - 'null' description: The 3-letter ISO country code. example: GBR country_iso_2: type: - string - 'null' description: The 2-letter ISO country code. example: GB country_iso_numeric: type: - string - 'null' description: The numeric ISO country code. example: '780' postal_code: $ref: '#/components/schemas/AddressComponentPostalCode' delivery_service: $ref: '#/components/schemas/AddressComponentDeliveryService' secondary_delivery_service: $ref: '#/components/schemas/AddressComponentDeliveryService' sub_building: $ref: '#/components/schemas/AddressComponentSubBuilding' building: $ref: '#/components/schemas/AddressComponentBuilding' organization: $ref: '#/components/schemas/AddressComponentOrganization' street: $ref: '#/components/schemas/AddressComponentStreet' secondary_street: $ref: '#/components/schemas/AddressComponentStreet' route_service: $ref: '#/components/schemas/AddressComponentRouteService' locality: $ref: '#/components/schemas/AddressComponentLocality' physical_locality: $ref: '#/components/schemas/AddressComponentLocality' additional_elements: $ref: '#/components/schemas/AddressComponentAdditionalElements' additionalProperties: false description: The components that differ by country and address type. Note that parameters with blank values will not be returned. PostalCode: type: object properties: full_name: type: - string - 'null' description: Gets or sets the full postal code primary: type: - string - 'null' description: Gets or sets the postal code primary secondary: type: - string - 'null' description: Gets or sets the postal code secondary additionalProperties: false description: The postal code of the suggestion. EnrichmentV2DatasetAusRegionalGeocodes: type: object properties: latitude: type: - number - 'null' description: Latitude of the address in degrees. format: double example: -31.067406 longitude: type: - number - 'null' description: Longitude of the address in degrees. format: double example: 152.83315 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: building sa1: type: - string - 'null' description: 7 digit SA1 code. example: '1115514' meshblock: type: - string - 'null' description: 11 digit meshblock code. example: '10402970000' lga_code: type: - string - 'null' description: 5-digit LGA code. example: '14350' lga_name: type: - string - 'null' description: The name of the Local Government Area. example: Kempsey (A) street_pid: type: - string - 'null' description: This is a unique street persistent identifier. example: NSW2838126 locality_pid: type: - string - 'null' description: This is a unique locality persistent identifier. example: NSW4281 geocode_level_code: type: - string - 'null' description: This is the geocode level code. The value is a number between 0 and 7. example: '7' geocode_level_description: type: - string - 'null' description: This is the geocode level description. example: Locality, street and parcel level geocodes geocode_type_code: type: - string - 'null' description: This is the geocode type code. The value is 2-4 alphabetic characters in uppercase. example: PC geocode_type_description: type: - string - 'null' description: This is the geocode type description. example: Property centroid highest_level_longitude: type: - number - 'null' description: The highest-level longitude in degrees. format: double example: 152.83315 highest_level_latitude: type: - number - 'null' description: The highest-level latitude in degrees. format: double example: -31.067406 highest_level_elevation: type: - string - 'null' description: The highest-level elevation. highest_level_planimetric_accuracy: type: - string - 'null' description: The highest-level planimetric accuracy. highest_level_boundary_extent: type: - string - 'null' description: The highest-level boundary extent. highest_level_geocode_reliability_code: type: - string - 'null' description: The highest-level geocode reliability code. example: '2' highest_level_geocode_reliability_description: type: - string - 'null' description: The highest-level geocode reliability description. example: Geocode accuracy sufficient to place centroid within address site boundary confidence_level_code: type: - string - 'null' description: This is the confidence level code. The value is numerical. example: '2' confidence_level_description: type: - string - 'null' description: This is the confidence level descriptor. The value is alphabetic. example: All three contributors have supplied an identical address 2021_meshblock_id: type: - string - 'null' description: 'The 2021 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.' example: MB2110402970000 2021_meshblock_code: type: - string - 'null' description: The 11-digit 2021 version of the Mesh Block Code. example: '10402970000' 2021_meshblock_match_code: type: - string - 'null' description: The code for the level of matching to 2021 Mesh Blocks. example: '1' 2021_meshblock_match_description: type: - string - 'null' description: The description of the 2021 Mesh Block match level. example: Parcel level match 2016_meshblock_id: type: - string - 'null' description: 'The 2016 version of the Mesh Block ID. This element consists of 15 alpha numeric characters: a 4 character descriptor, followed by the 11 digit Mesh Block Code.' example: MB1610402970000 2016_meshblock_code: type: - string - 'null' description: The 11-digit 2016 version of the Mesh Block Code. example: '10402970000' 2016_meshblock_match_code: type: - string - 'null' description: The code for the level of matching to 2016 Mesh Blocks. example: '1' 2016_meshblock_match_description: type: - string - 'null' description: The description of the 2016 Mesh Block match level. example: Parcel level match address_type_code: type: - string - 'null' description: 'Returns the Address Type, indicating if the address is a Primary or Secondary address. If the Primary/Secondary relationship does not exist, then this element would be blank, otherwise the possible values are P and S: P:PrimaryAddress; S:SecondaryAddress.' primary_address_pid: type: - string - 'null' description: This element will only be populated if the input address is a secondary address. In that case, this element would contain the PID of the primary address. address_join_type: type: - string - 'null' description: 'Returns the JoinType Code. The possible values are 1 or 2: 1:Both parent and child have the same root address; 2: Parent and child may or may not have the same root address.' collector_district_id: type: - string - 'null' description: This is a unique Collector District persistent identifier. example: NSW1081403 collector_district_code: type: - string - 'null' description: This is the Collector District Code. example: '1081403' commonwealth_electoral_boundary_id: type: - string - 'null' description: This is a unique Commonwealth Electoral Boundary persistent identifier. example: NSW32 commonwealth_electoral_boundary_name: type: - string - 'null' description: This is the Commonwealth Electoral Boundary name. example: COWPER statistical_local_area_id: type: - string - 'null' description: This is a Statistical Local Area persistent identifier. example: NSW125104350 statistical_local_area_code: type: - string - 'null' description: 9-digit SLA code. example: '125104350' statistical_local_area_name: type: - string - 'null' description: This is a Statistical Local Area name. example: KEMPSEY (A) state_electoral_boundary_id: type: - string - 'null' description: This is a State Electoral Boundary persistent identifier. example: NSW231 state_electoral_boundary_name: type: - string - 'null' description: This is a State Electoral Boundary name. example: OXLEY state_electoral_effective_start: type: - string - 'null' description: This is the date that the electorate becomes effective. example: 24/03/2007 00:00:00 state_electoral_effective_end: type: - string - 'null' description: This is the end date when electorate is no longer in effect. example: 28/03/2015 00:00:00 state_electoral_new_pid: type: - string - 'null' description: This is the State Electoral Boundary identifier for new electorate that will be in effect. example: NSW242 state_electoral_new_name: type: - string - 'null' description: This is the State Electoral Boundary name for new electorate that will be in effect. example: OXLEY state_electoral_new_effective_start: type: - string - 'null' description: This is the start date that the new electorate will become effective. example: 28/03/2015 00:00:00 state_electoral_new_effective_end: type: - string - 'null' description: This is the end date when the new electorate will no longer be in effect. address_level_longitude: type: - number - 'null' description: The address-level longitude in degrees. format: double example: 152.83315 address_level_latitude: type: - number - 'null' description: The address-level latitude in degrees. format: double example: -31.067406 address_level_elevation: type: - string - 'null' description: The address-level elevation. address_level_planimetric_accuracy: type: - string - 'null' description: The address-level planimetric accuracy. address_level_boundary_extent: type: - string - 'null' description: The address-level boundary extent. address_level_geocode_reliability_code: type: - string - 'null' description: The address-level geocode reliability code. example: '2' address_level_geocode_reliability_description: type: - string - 'null' description: The address-level geocode reliability description. example: Geocode accuracy sufficient to place centroid within address site boundary street_level_longitude: type: - number - 'null' description: The street-level longitude in degrees. format: double example: 152.8311 street_level_latitude: type: - number - 'null' description: The street-level latitude in degrees. format: double example: -31.062723 street_level_planimetric_accuracy: type: - string - 'null' description: The street-level planimetric accuracy. street_level_boundary_extent: type: - string - 'null' description: The street-level boundary extent. example: '651' street_level_geocode_reliability_code: type: - string - 'null' description: The street-level geocode reliability code. The value of this is either “4”, or blank. example: '4' street_level_geocode_reliability_description: type: - string - 'null' description: The street-level geocode reliability description. If the reliability code is “4”, this is “Geocode accuracy sufficient to associate address site with a unique road feature”. example: Geocode accuracy sufficient to associate address site with a unique road feature locality_level_longitude: type: - number - 'null' description: The locality-level longitude in degrees. format: double example: 152.82999 locality_level_latitude: type: - number - 'null' description: The locality-level latitude in degrees. format: double example: -31.059824 locality_level_planimetric_accuracy: type: - string - 'null' description: The locality-level planimetric accuracy. locality_level_geocode_reliability_code: type: - string - 'null' description: The locality-level geocode reliability code. The value of this is either “5”, “6”, or blank. example: '5' locality_level_geocode_reliability_description: type: - string - 'null' description: The locality-level geocode reliability description. example: Geocode accuracy sufficient to associate address site with a unique locality or neighbourhood gnaf_legal_parcel_identifier: type: - string - 'null' description: The Legal Parcel Id field is populated with the cadastral information using the same concatenations (where applicable) as adopted for the Jurisdiction Id used in the Cadastre theme (CAD table) of the CadLite product. example: B/366584 locality_class_code: type: - string - 'null' description: Describes the class of locality (e.g. Gazetted, topographic feature, indigenous location and etc.). example: G additionalProperties: false description: Enrichment attributes that can be returned, based on the AUS Regional Geocodes dataset. AddressComponentSubBuildingItem: type: object properties: full_name: type: - string - 'null' description: The full name of this subcomponent. example: L 6 type: type: - string - 'null' description: The type of this subcomponent. example: L value: type: - string - 'null' description: The value of this subcomponent. example: '6' additionalProperties: false description: An item of sub-building information, such as a floor or entrance number or name. EnrichmentV2ResultAddressValidateMetadata: type: object properties: code: type: - string - 'null' message: type: - string - 'null' detail: type: - string - 'null' datasets: $ref: '#/components/schemas/EnrichmentV2ResultAddressValidateMetadataDatasets' additionalProperties: false EnrichmentV2DatasetNzlRegionalGeocodes: type: object properties: front_of_property_nztm_x_coordinate: type: - number - 'null' description: The Geocode 'X' coordinate for the front of the building. format: double example: 1757352.8 front_of_property_nztm_y_coordinate: type: - number - 'null' description: The Geocode 'Y' coordinate for the front of the building. format: double example: 5920390.5 centroid_of_property_nztm_x_coordinate: type: - number - 'null' description: The Geocode 'X' coordinate for the centre of the property. format: double example: 1757328.4 centroid_of_property_nztm_y_coordinate: type: - number - 'null' description: The Geocode 'Y' coordinate for the centre of the property. format: double example: 5920400 linz_parcel_id: type: - string - 'null' description: This is a unique identifier of the address record. example: '5047052' property_purpose_type: type: - string - 'null' description: 'The type of property, the possible values are: Business, Farm, Holiday Home, Residential or Empty section.' example: Business addressable: type: - string - 'null' description: This defines whether the address is deliverable or not. The possible values are "Y" or "N". example: N mesh_block_code: type: - string - 'null' description: The unique identifier assigned to each Mesh Block. example: '434000' territorial_authority_code: type: - string - 'null' description: The unique identifier assigned to the Territorial Authority. example: '76' territorial_authority_name: type: - string - 'null' description: The name assigned to the Territorial Authority. example: Auckland regional_council_code: type: - string - 'null' description: The unique identifier assigned to the Regional Council. example: '2' regional_council_name: type: - string - 'null' description: The name assigned to the Regional Council. example: Auckland Region general_electorate_code: type: - string - 'null' description: The unique identifier assigned to the General Electorate. example: '001' general_electorate_name: type: - string - 'null' description: The name assigned to the General Electorate. example: Auckland Central maori_electorate_code: type: - string - 'null' description: The unique identifier assigned to the Maori Electorate. example: '3' maori_electorate_name: type: - string - 'null' description: The name assigned to the Maori Electorate. example: Tamaki Makaurau front_of_property_latitude: type: - number - 'null' description: The latitude for the front of the building. format: double example: -36.849308 front_of_property_longitude: type: - number - 'null' description: The longitude for the front of the building. format: double example: 174.76492 centroid_of_property_latitude: type: - number - 'null' description: The latitude for the centre of the property. format: double example: -36.849228 centroid_of_property_longitude: type: - number - 'null' description: The longitude for the centre of the property. format: double example: 174.76465 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: Building additionalProperties: false description: Enrichment attributes that can be returned, based on the NZL Regional Geocodes dataset. AddressLineContent: enum: - none - address - name - ancillary - dataplus type: string description: The type of address line. AddressLookupV1Request: required: - country_iso - datasets - key type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: The country ISO3 code. example: USA datasets: minItems: 1 type: array items: type: string description: The datasets for address lookup. example: - us-address key: $ref: '#/components/schemas/AddressLookupKey' additionalProperties: false description: Address lookup V1 request. AddressLookupV2Request: required: - components - country_iso - datasets type: object properties: country_iso: maxLength: 3 minLength: 3 type: string description: Gets or sets the country ISO3 code of address. example: GBR datasets: minItems: 1 type: - array - 'null' items: type: string description: Gets or sets the datasets for address validation. example: - gb-address max_addresses: type: - integer - 'null' description: Gets or sets the maximum number of addresses a search request should return. format: int32 example: 10 max_suggestions: type: - integer - 'null' description: Gets or sets the maximum number of suggestions a search request should return. format: int32 attributes: $ref: '#/components/schemas/AddressLookupV2RequestAttributes' key: $ref: '#/components/schemas/Key' preferred_language: type: - array - 'null' items: type: string description: Gets or sets the preferred language. preferred_script: type: - array - 'null' items: type: string description: Gets or sets the the preferred script. names: type: - array - 'null' items: $ref: '#/components/schemas/AddressInputComponentName' description: The names component. example: - 1 Main Street layouts: type: - array - 'null' items: type: string description: Custom layout name. example: - default additionalProperties: false description: The address lookup v2 request. EnrichmentV2AprCrossReferenceNonDomesticRatesResult: type: object properties: primary_key: type: - string - 'null' description: Primary key of the record in external dataset. key: type: - string - 'null' description: Unique key for the cross reference record. version: type: - string - 'null' description: Version number of the source object. created_date: type: - string - 'null' description: Date the record was created. update_date: type: - string - 'null' description: Date the record was last changed. entry_date: type: - string - 'null' description: Date of data entry. additionalProperties: false description: Response for Addressbase Cross Reference Non Domestic Rates. DatasetMetadata: type: object properties: code: type: - string - 'null' description: Attribute-level metadata code. example: S200 message: type: - string - 'null' description: Attribute-level metadata message. example: Match value: type: - string - 'null' description: The attribute's value that was returned by the API. additionalProperties: false description: The attribute's metadata. EnrichmentV2GbrLocationGridMetadata: type: object properties: postzon: $ref: '#/components/schemas/DatasetMetadataV2' codepoint: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2GbrHealthMetadata: type: object properties: authority_code: $ref: '#/components/schemas/DatasetMetadata' authority_code_2011: $ref: '#/components/schemas/DatasetMetadata' authority_name: $ref: '#/components/schemas/DatasetMetadata' pclh_code: $ref: '#/components/schemas/DatasetMetadata' pclh_code_2011: $ref: '#/components/schemas/DatasetMetadata' pclh_name: $ref: '#/components/schemas/DatasetMetadata' ward_code: $ref: '#/components/schemas/DatasetMetadata' ward_code_2011: $ref: '#/components/schemas/DatasetMetadata' ward_name: $ref: '#/components/schemas/DatasetMetadata' ccg_code: $ref: '#/components/schemas/DatasetMetadata' ccg_name: $ref: '#/components/schemas/DatasetMetadata' doh_code: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the GBR Health dataset. EnrichmentV2AprCrossReference: enum: - addresslayer_2 - council_tax - integrated_transport_network - non_domestic_rates - topography_layer type: string description: The dataset named Addressbase Cross Reference and its associated attributes. EnrichmentV2AprHealthResult: type: object properties: health: $ref: '#/components/schemas/EnrichmentV2AprHealthElementsResult' additionalProperties: false description: Response for Addressbase Health dataset. EnrichmentV2AusRegionalGeocodesMetadata: type: object properties: latitude: $ref: '#/components/schemas/DatasetMetadata' longitude: $ref: '#/components/schemas/DatasetMetadata' match_level: $ref: '#/components/schemas/DatasetMetadata' sa1: $ref: '#/components/schemas/DatasetMetadata' meshblock: $ref: '#/components/schemas/DatasetMetadata' lga_code: $ref: '#/components/schemas/DatasetMetadata' lga_name: $ref: '#/components/schemas/DatasetMetadata' street_pid: $ref: '#/components/schemas/DatasetMetadata' locality_pid: $ref: '#/components/schemas/DatasetMetadata' geocode_level_code: $ref: '#/components/schemas/DatasetMetadata' geocode_level_description: $ref: '#/components/schemas/DatasetMetadata' geocode_type_code: $ref: '#/components/schemas/DatasetMetadata' geocode_type_description: $ref: '#/components/schemas/DatasetMetadata' highest_level_longitude: $ref: '#/components/schemas/DatasetMetadata' highest_level_latitude: $ref: '#/components/schemas/DatasetMetadata' highest_level_elevation: $ref: '#/components/schemas/DatasetMetadata' highest_level_planimetric_accuracy: $ref: '#/components/schemas/DatasetMetadata' highest_level_boundary_extent: $ref: '#/components/schemas/DatasetMetadata' highest_level_geocode_reliability_code: $ref: '#/components/schemas/DatasetMetadata' highest_level_geocode_reliability_description: $ref: '#/components/schemas/DatasetMetadata' confidence_level_code: $ref: '#/components/schemas/DatasetMetadata' confidence_level_description: $ref: '#/components/schemas/DatasetMetadata' 2021_meshblock_id: $ref: '#/components/schemas/DatasetMetadata' 2021_meshblock_code: $ref: '#/components/schemas/DatasetMetadata' 2021_meshblock_match_code: $ref: '#/components/schemas/DatasetMetadata' 2021_meshblock_match_description: $ref: '#/components/schemas/DatasetMetadata' 2016_meshblock_id: $ref: '#/components/schemas/DatasetMetadata' 2016_meshblock_code: $ref: '#/components/schemas/DatasetMetadata' 2016_meshblock_match_code: $ref: '#/components/schemas/DatasetMetadata' 2016_meshblock_match_description: $ref: '#/components/schemas/DatasetMetadata' address_type_code: $ref: '#/components/schemas/DatasetMetadata' primary_address_pid: $ref: '#/components/schemas/DatasetMetadata' address_join_type: $ref: '#/components/schemas/DatasetMetadata' collector_district_id: $ref: '#/components/schemas/DatasetMetadata' collector_district_code: $ref: '#/components/schemas/DatasetMetadata' commonwealth_electoral_boundary_id: $ref: '#/components/schemas/DatasetMetadata' commonwealth_electoral_boundary_name: $ref: '#/components/schemas/DatasetMetadata' statistical_local_area_id: $ref: '#/components/schemas/DatasetMetadata' statistical_local_area_code: $ref: '#/components/schemas/DatasetMetadata' statistical_local_area_name: $ref: '#/components/schemas/DatasetMetadata' state_electoral_boundary_id: $ref: '#/components/schemas/DatasetMetadata' state_electoral_boundary_name: $ref: '#/components/schemas/DatasetMetadata' state_electoral_effective_start: $ref: '#/components/schemas/DatasetMetadata' state_electoral_effective_end: $ref: '#/components/schemas/DatasetMetadata' state_electoral_new_pid: $ref: '#/components/schemas/DatasetMetadata' state_electoral_new_name: $ref: '#/components/schemas/DatasetMetadata' state_electoral_new_effective_start: $ref: '#/components/schemas/DatasetMetadata' state_electoral_new_effective_end: $ref: '#/components/schemas/DatasetMetadata' address_level_longitude: $ref: '#/components/schemas/DatasetMetadata' address_level_latitude: $ref: '#/components/schemas/DatasetMetadata' address_level_elevation: $ref: '#/components/schemas/DatasetMetadata' address_level_planimetric_accuracy: $ref: '#/components/schemas/DatasetMetadata' address_level_boundary_extent: $ref: '#/components/schemas/DatasetMetadata' address_level_geocode_reliability_code: $ref: '#/components/schemas/DatasetMetadata' address_level_geocode_reliability_description: $ref: '#/components/schemas/DatasetMetadata' street_level_longitude: $ref: '#/components/schemas/DatasetMetadata' street_level_latitude: $ref: '#/components/schemas/DatasetMetadata' street_level_planimetric_accuracy: $ref: '#/components/schemas/DatasetMetadata' street_level_boundary_extent: $ref: '#/components/schemas/DatasetMetadata' street_level_geocode_reliability_code: $ref: '#/components/schemas/DatasetMetadata' street_level_geocode_reliability_description: $ref: '#/components/schemas/DatasetMetadata' locality_level_longitude: $ref: '#/components/schemas/DatasetMetadata' locality_level_latitude: $ref: '#/components/schemas/DatasetMetadata' locality_level_planimetric_accuracy: $ref: '#/components/schemas/DatasetMetadata' locality_level_geocode_reliability_code: $ref: '#/components/schemas/DatasetMetadata' locality_level_geocode_reliability_description: $ref: '#/components/schemas/DatasetMetadata' gnaf_legal_parcel_identifier: $ref: '#/components/schemas/DatasetMetadata' locality_class_code: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the AUS Regional Geocodes dataset. EnrichmentV2NzlHouseholdMetadata: type: object properties: head_of_household_age: $ref: '#/components/schemas/DatasetMetadataV2' children_at_address: $ref: '#/components/schemas/DatasetMetadataV2' household_composition: $ref: '#/components/schemas/DatasetMetadataV2' head_of_household_lifestage: $ref: '#/components/schemas/DatasetMetadataV2' adults_at_address: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2AprHealthElementsResult: type: object properties: authority_code: type: - string - 'null' description: Code for NHS Authority. authority_name: type: - string - 'null' description: Name of NHS Authority. pclh_code: type: - string - 'null' description: Code for Primary Care Trust or Local Health Group. pclh_name: type: - string - 'null' description: Name of Primary Care Trust or Local Health Group. ward_code: type: - string - 'null' description: Code for Local Authority Ward. ward_name: type: - string - 'null' description: Name of Local Authority Ward. ccg_code: type: - string - 'null' description: Code for Clinical Commissioning Group or equivalent. ccg_name: type: - string - 'null' description: Name of Clinical Commissioning Group or equivalent. doh_code: type: - string - 'null' description: Department of Health area code. additionalProperties: false description: Response for Addressbase Health Elements. MatchInfoFlags: type: object properties: postcode_action: type: - string - 'null' description: Postcode action info. address_action: type: - string - 'null' description: Address action info. generic_info: type: - array - 'null' items: type: string description: General match codes info. aus_info: type: - array - 'null' items: type: string description: AUS specific match codes info. deu_info: type: - array - 'null' items: type: string description: DEU specific match codes info. fra_info: type: - array - 'null' items: type: string description: FRA specific match codes info. gbr_info: type: - array - 'null' items: type: string description: GBR specific match codes info. nld_info: type: - array - 'null' items: type: string description: NLD specific match codes info. nzl_info: type: - array - 'null' items: type: string description: NZL specific match codes info. sgp_info: type: - array - 'null' items: type: string description: SGP specific match codes info. additionalProperties: false description: Class to map validation match info flags from proweb. EnrichmentV2AprStreetUsrnResult: type: object properties: usrn: type: - string - 'null' description: An 8-character code assigned to every street. usrn_match: type: - string - 'null' description: Indicates how the address was matched to the USRN (manual or spatial match). additionalProperties: false description: Response for Addressbase Street Usrn. CommercialMosaicElements: type: object properties: group_type_code: type: - string - 'null' description: The group type code. group_type_description: type: - string - 'null' description: The group type description. group_code: type: - string - 'null' description: The group code. group_description: type: - string - 'null' description: The group description. additionalProperties: false description: The Commercial mosaic elements. EnrichmentV2GbrMosaicFinancialResult: type: object properties: postal_code: $ref: '#/components/schemas/EnrichmentV2GbrCommonElementsResult' household: $ref: '#/components/schemas/EnrichmentV2GbrCommonElementsResult' additionalProperties: false description: Response for GBR Mosaic Financial dataset. EnrichmentV2GbrMosaicResult: type: object properties: household: $ref: '#/components/schemas/EnrichmentV2GbrCommonElementsWithVersionResult' postal_code: $ref: '#/components/schemas/EnrichmentV2GbrCommonElementsWithVersionResult' additionalProperties: false description: Response for GBR Mosaic dataset. EnrichmentV2AprStreetMetadata: type: object properties: grid: $ref: '#/components/schemas/DatasetMetadataV2' record: $ref: '#/components/schemas/DatasetMetadataV2' usrn: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false AddressSearchV1Response: type: object properties: error: $ref: '#/components/schemas/ResponseError' result: $ref: '#/components/schemas/AddressSearchV1Result' additionalProperties: false description: Response model for AddressSearchV1 endpoint. EnrichmentV2AprGovernmentResult: type: object properties: government: $ref: '#/components/schemas/EnrichmentV2AprGovernmentElementsResult' additionalProperties: false description: Response for Addressbase Government dataset. EnrichmentV2AprCrossReferenceIntegratedTransportNetworkResult: type: object properties: primary_key: type: - string - 'null' description: Primary key of the record in external dataset. key: type: - string - 'null' description: Unique key for the cross reference record. version: type: - string - 'null' description: Version number of the source object. created_date: type: - string - 'null' description: Date the record was created. update_date: type: - string - 'null' description: Date the record was last changed. entry_date: type: - string - 'null' description: Date of data entry. additionalProperties: false description: Response for Addressbase Cross Reference Integrated Transport Network. EnrichmentV2GeocodesMetadata: type: object properties: latitude: $ref: '#/components/schemas/DatasetMetadata' longitude: $ref: '#/components/schemas/DatasetMetadata' match_level: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the Geocodes dataset. EnrichmentV2UkLocationCompleteMetadata: type: object properties: latitude: $ref: '#/components/schemas/DatasetMetadata' longitude: $ref: '#/components/schemas/DatasetMetadata' match_level: $ref: '#/components/schemas/DatasetMetadata' udprn: $ref: '#/components/schemas/DatasetMetadata' uprn: $ref: '#/components/schemas/DatasetMetadata' x_coordinate: $ref: '#/components/schemas/DatasetMetadata' y_coordinate: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the UK Location Complete dataset. EnrichmentV2DatasetUsaRegionalGeocodes: type: object properties: latitude: type: - number - 'null' description: The latitude. format: double example: 33.693283 longitude: type: - number - 'null' description: The longitude. format: double example: -117.87428 match_level: type: - string - 'null' description: Specifies the accuracy of the coordinates for the specified address. example: Street census_tract: type: - string - 'null' description: Geographical region defined by US Census Bureau for the purpose of taking a census (6 digits). example: '050210' census_block: type: - string - 'null' description: Smallest geographical unit used by US Census Bureau for the purpose of taking a census; sub-division of a tract (4 digits). example: '2025' core_based_statistical_area: type: - string - 'null' description: '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).' example: '12060' congressional_district_code: type: - string - 'null' description: '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.' example: '1307116' county_code: type: - string - 'null' description: County code within a US state or possession (3 digits). example: '135' additionalProperties: false description: Enrichment attributes that can be returned, based on the USA Regional Geocodes dataset. EnrichmentV2GbrParliamentWestminsterResult: type: object properties: constituency_code: type: - string - 'null' description: Official code given to the Parliamentary Constituency. constituency: type: - string - 'null' description: Official name given to the Parliamentary Constituency. mp: type: - string - 'null' description: Name of the MP representing their constituency. mp_party: type: - string - 'null' description: Name of the party to which the MP belongs. additionalProperties: false description: Response for GBR Westminster Parliament. AddressRestrictionRules: type: object properties: exists: type: - boolean - 'null' description: '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: type: - array - 'null' items: type: string description: Gets or sets an array of values, causing the returned result to include only records that have one of the values must_not_be: type: - array - 'null' items: type: string description: Gets or sets an array of values, causing the returned result to include only records that exclude the values additionalProperties: false description: A class that represents address restriction rules AddressMetadataAddressClassification: type: object properties: address_type: $ref: '#/components/schemas/AddressMetadataAddressType' delivery_type: type: - string - 'null' description: Type of mail delivery at the address. Either "business", "residential" or "mixed". example: Business is_deliverable: type: - string - 'null' description: Indicator if the address is deliverable - applicable to NZL addresses only. example: Y additionalProperties: false description: Address deliverability and type indicators. AddressLayoutsV2ListResponseModel: required: - name type: object properties: id: type: - string - 'null' description: The layout ID. name: maxLength: 100 minLength: 1 pattern: ^([A-Za-z0-9_\-]{1}[A-Za-z0-9_\-\ ]*[A-Za-z0-9_\-]{1}|[A-Za-z0-9_\-]{1})$ type: string description: The layout name. applies_to: type: - array - 'null' items: $ref: '#/components/schemas/AddressLayoutV2AppliesTo' description: The layout applies to. status: $ref: '#/components/schemas/AddressLayoutV2Status' additionalProperties: false description: Address Layout V2 List Response Model. AddressFormatV1Request: type: object properties: layouts: type: - array - 'null' items: type: string description: Custom layout name. example: - default layout_format: $ref: '#/components/schemas/AddressLayoutFormat' attributes: $ref: '#/components/schemas/AddressFormatV1RequestAttributes' additionalProperties: false description: The address format V1 request. EnrichmentV2GbrGovernmentMetadata: type: object properties: eer_code: $ref: '#/components/schemas/DatasetMetadata' eer_code_pre_2011: $ref: '#/components/schemas/DatasetMetadata' eer_name: $ref: '#/components/schemas/DatasetMetadata' gor_code: $ref: '#/components/schemas/DatasetMetadata' gor_code_pre_2011: $ref: '#/components/schemas/DatasetMetadata' gor_name: $ref: '#/components/schemas/DatasetMetadata' lea_code: $ref: '#/components/schemas/DatasetMetadata' lea_name: $ref: '#/components/schemas/DatasetMetadata' la_code: $ref: '#/components/schemas/DatasetMetadata' la_code_pre_2011: $ref: '#/components/schemas/DatasetMetadata' la_name: $ref: '#/components/schemas/DatasetMetadata' ward_code: $ref: '#/components/schemas/DatasetMetadata' ward_code_pre_2011: $ref: '#/components/schemas/DatasetMetadata' ward_name: $ref: '#/components/schemas/DatasetMetadata' cens_out_area: $ref: '#/components/schemas/DatasetMetadata' additionalProperties: false description: Attribute-level metadata for the GBR Government dataset. EnrichmentV2GbrParliamentMetadata: type: object properties: westminster: $ref: '#/components/schemas/DatasetMetadataV2' scotland: $ref: '#/components/schemas/DatasetMetadataV2' additionalProperties: false EnrichmentV2NzlMosaicFactorResult: type: object properties: score: type: - number - 'null' description: Score. format: double percentile: type: - number - 'null' description: Percentile. format: double decile: type: - number - 'null' description: Decile. format: double additionalProperties: false description: Response for NZL Mosaic's Factor Elements. EnrichmentV2AprStreetGridResult: type: object properties: start_x_coordinate: type: - number - 'null' description: The Easting co-ordinate of the start point of the street. format: double start_y_coordinate: type: - number - 'null' description: The Northing co-ordinate of the start point of the street. format: double end_x_coordinate: type: - number - 'null' description: The Easting co-ordinate of the end point of the street. format: double end_y_coordinate: type: - number - 'null' description: The Northing co-ordinate of the end point of the street. format: double start_latitude: type: - number - 'null' description: Latitude of the start point of the street in accordance with the ETRS89 co-ordinate reference system. format: double start_longitude: type: - number - 'null' description: Longitude of the start point of the street in accordance with the ETRS89 co-ordinate reference system. format: double end_latitude: type: - number - 'null' description: Latitude of the end point of the street in accordance with the ETRS89 co-ordinate reference system. format: double end_longitude: type: - number - 'null' description: Longitude of the end point of the street in accordance with the ETRS89 co-ordinate reference system. format: double tolerance: type: - string - 'null' description: The potential variance in metres of the start and end co-ordinates of the street. additionalProperties: false description: Response for Addressbase Street Grid. AddressMetadataBarcode: type: object properties: delivery_point_barcode: type: - string - 'null' description: The delivery point barcode (applicable for USA addresses only). example: 02139430177 check_digit: type: - string - 'null' description: The delivery point barcode's check digit (applicable for USA addresses only). example: '3' sort_plan_number: type: - string - 'null' description: The sort plan number barcode (applicable for AUS addresses only). example: '022' additionalProperties: false description: Address barcode. EnrichmentV2AprParliamentWestminsterResult: type: object properties: constituency_code: type: - string - 'null' description: Code for Parliamentary Constituency. constituency: type: - string - 'null' description: Name of Parliamentary Constituency. mp: type: - string - 'null' description: Name of the MP. mp_party: type: - string - 'null' description: Political party of the MP. additionalProperties: false description: Response for Addressbase Parliament Westminster. EnrichmentV2AprQualityRecordResult: type: object properties: blpu_status: type: - string - 'null' description: Indicates the status of the address associated with the BLPU record. lpi_status: type: - string - 'null' description: Indicates the status of the address associated with the LPI record. state: type: - string - 'null' description: Indicates the current state of the BLPU. state_date: type: - string - 'null' description: The date on which the BLPU entered its current state. start_date: type: - string - 'null' description: The date on which the BLPU was defined. update_date: type: - string - 'null' description: The date on which the record was last updated. entry_date: type: - string - 'null' description: The date of data entry. update_frequency: type: - string - 'null' description: Indicates how frequently the data is updated. is_official: type: - string - 'null' description: Indicates the status of an address in the official street naming and numbering register. paf_update_date: type: - string - 'null' description: The date on which a Royal Mail Delivery Point Address was last updated. additionalProperties: false description: Response for Addressbase Quality Record. AddressComponentDeliveryService: type: object properties: full_name: type: - string - 'null' description: The full name of the delivery service. service_type: type: - string - 'null' description: The delivery service type. service_number: type: - string - 'null' description: The delivery service number. post_centre_name: type: - string - 'null' description: The delivery service post center name. additionalProperties: false description: The delivery service component. EnrichmentV2SgpMosaicFactorResult: type: object properties: score: type: - number - 'null' description: Score. format: double percentile: type: - number - 'null' description: Percentile. format: double decile: type: - number - 'null' description: Decile. format: double additionalProperties: false description: Response for SGP Mosaic Elements that contains score, percentile and decile. AddressSearchType: enum: - singleline - typedown - verification - keyfinder - intuitive_classic type: string description: The available search type. AddressDatasetsCountryResult: type: object properties: country_iso_3: type: - string - 'null' description: The country ISO3 code. example: GBR country_name: type: - string - 'null' description: The country name. example: United Kingdom datasets: type: - array - 'null' items: $ref: '#/components/schemas/AddressDatasetElement' description: The available datasets. valid_combinations: type: - array - 'null' items: type: array items: type: string description: The combination of valid datasets. example: - - gb-additional-electricity - gb-additional-gas - - gb-additional-names - gb-additional-notyetbuilt additionalProperties: false description: Address dataset result. AddressMetadataDpv: type: object properties: cmra_indicator: type: - string - 'null' description: Indicates that the address is a private business that acts as a commercial mail-receiving agent for specific clients. example: Y seed_indicator: type: - string - 'null' description: 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. example: Y dpv_indicator: type: - string - 'null' description: Indicates whether selected address is confirmed as deliverable via DPV (Delivery Point Validation) process. For all possible values, please visit our technical documentation portal. example: Y footnotes: type: - array - 'null' items: type: string description: USPS codes denoting DPV match levels. For a list of all possible values, please visit our technical documentation portal. example: - AA - BB vacancy_indicator: type: - string - 'null' description: An address known to be unoccupied for over 90 days and therefore not receiving mail deliveries. example: Y no_stats_indicator: type: - string - 'null' description: An address known to not receive mail deliveries (e.g. a house under construction). example: Y pbsa_indicator: type: - string - 'null' description: Indicates addresses known to be Post Office Box Street Addresses (PBSA). example: Y lacs_indicator: type: - string - 'null' description: '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.' example: Y lacs_code: type: - string - 'null' description: '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.' example: '14' urbanization: type: - string - 'null' description: Gets or sets Urbanization property of the address. delivery_line_1: type: - string - 'null' description: Gets or sets delivery line 1 of the address. delivery_line_2: type: - string - 'null' description: Gets or sets delivery line 2 of the address. last_line: type: - string - 'null' description: Gets or sets last line of the address. no_stat_reason_code: type: - array - 'null' items: type: string description: Gets or sets DPV No stat reason code drop: type: - string - 'null' description: Gets or sets DPV Drop indicator throwback: type: - string - 'null' description: Gets or sets DPV Throwback indicator non_delivery_days_indicator: type: - string - 'null' description: Gets or sets DPV Non Delivery Day indicator non_delivery_days_value: type: - array - 'null' items: type: string description: Gets or sets DPV Non Delivery Week Days indicator no_secure_location: type: - string - 'null' description: Gets or sets DPV No Secure Location indicator door_not_accessible: type: - string - 'null' description: Gets or sets DPV Door Not Accessible indicator enhanced_dpv_code: type: - string - 'null' description: Gets or sets Enhanced DPV Return Code firm_name: type: - string - 'null' description: Gets or sets Firm Name field of the address. additionalProperties: false description: Delivery Point Validation information for the address (USA only). AddressLayoutV2ElementConfigurationWithDefault: type: object properties: default: type: - string - 'null' description: The default configuration. configuration_by_element: type: - object - 'null' additionalProperties: type: - string - 'null' description: The configuration of each element. additionalProperties: false description: Address Layout V2 Element Configuration. securitySchemes: OAuth2: type: http description: "Token URL: https://sso.experianaperture.io/oauth2/aust0wkxjeKyT3HRO4x7/v1/token \n\n Flow: clientCredentials" scheme: Bearer bearerFormat: JWT Auth-Token: type: apiKey description: Your unique key, called a token, that is required to submit an API request. name: Auth-Token in: header x-app-key: type: apiKey description: Alternative Auth Token header. name: x-app-key in: header