--- title: "Gets the validation result of a batch of address." method: GET path: "/address/bulk/v1/batches/{batch_id}/results" tags: ["Bulk Address"] --- # Gets the validation result of a batch of address. `GET /address/bulk/v1/batches/{batch_id}/results` ## Request - Base URL: `https://api.experianaperture.io` - URL: `https://api.experianaperture.io/address/bulk/v1/batches/{batch_id}/results` - Auth: one of: - HTTP bearer - API key in header `Auth-Token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `batch_id` string, required ## Headers - `Reference-Id` string ## Response `200` OK - BulkAddressV1GetBatchResultsResponse: Bulk Address V1 Get Results response. - `error` ResponseError: Error model containing the error details. - `type` string, nullable: A link to documentation that provides more details about the error you’ve encountered. - `title` string, nullable: The title of the error. - `detail` string, nullable: A description of the error. - `instance` string, nullable: The endpoint that returned the error. - `result` BulkAddressV1GetBatchResultsResponseResult: Bulk Address V1 Get Batch Results result. - `batch_id` string, nullable: Batch ID. - `batch_reference_id` string, nullable: Optional reference identifier to track this batch. - `credits_charged` integer: The number of credits charged for this Batch. - `status` string, nullable: The current Batch status. - `reason` string, nullable: The reason of the current Batch status. - `statistics` BulkAddressV1GetBatchResultsResponseStatistic[], nullable: The statistics of the address confidence level. - `name` string, nullable: Confidence. - `value` integer: Count. - `addresses` BulkAddressV1GetBatchResultsResponseAddress[], nullable: The Addresses validation results. - `address` string, nullable: The address that is the subject of the validation. - `country_iso` string, nullable: The country ISO of the validation. - `datasets` string[], nullable: The datasets of the validation. - `confidence` string, nullable: The outcome (confidence level) of the validation. - `match_type` string, nullable: Match type for verified address. - `match_confidence` string, nullable: Match confidence for verified address. - `match_info` BulkAddressV1GetBatchResultsResponseAddressMatchInfo: Bulk Address V1 Get Results response Address Match Info data - `postcode_action` string, nullable: Postcode action info. - `address_action` string, nullable: Address action info. - `generic_info` string[], nullable: General match codes info. - `aus_info` string[], nullable: AUS specific match codes info. - `deu_info` string[], nullable: DEU specific match codes info. - `fra_info` string[], nullable: FRA specific match codes info. - `gbr_info` string[], nullable: GBR specific match codes info. - `nld_info` string[], nullable: NLD specific match codes info. - `nzl_info` string[], nullable: NZL specific match codes info. - `sgp_info` string[], nullable: SGP specific match codes info. - `addresses_formatted` BulkAddressV1GetBatchResultsResponseAddressAddressFormatted[], nullable: Addresses formatted details for verified address. - `layout_name` string, nullable: The layout name for address to map. - `address` object, nullable: The address formatted. - `components` BulkAddressV1GetBatchResultsResponseAddressComponents: Bulk Address V1 Get Results response Address Components data - `language` string, nullable: Address language. - `country_name` string, nullable: The name of the country where the address is located. - `country_iso_3` string, nullable: The 3-letter ISO country code. - `country_iso_2` string, nullable: The 2-letter ISO country code. - `postal_code` BulkAddressV1GetBatchResultsResponseAddressComponentsPostalCode: The post code component. - `full_name` string, nullable: The full name of the postal code. - `primary` string, nullable: The primary name of the postal code. - `secondary` string, nullable: The secondary name of the postal code. - `delivery_service` BulkAddressV1GetBatchResultsResponseAddressComponentsDeliveryService: The delivery service component. - `full_name` string, nullable: The full name of the delivery service. - `service_type` string, nullable: The delivery service type. - `service_number` string, nullable: The delivery service number. - `post_centre_name` string, nullable: The delivery service post center name. - `secondary_delivery_service` BulkAddressV1GetBatchResultsResponseAddressComponentsDeliveryService: The delivery service component. - `full_name` string, nullable: The full name of the delivery service. - `service_type` string, nullable: The delivery service type. - `service_number` string, nullable: The delivery service number. - `post_centre_name` string, nullable: The delivery service post center name. - `sub_building` BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuilding: The sub building component. - `name` string, nullable: The name of a building or property. - `entrance` BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem: An item of sub-building information, such as a floor or entrance number or name. - `full_name` string, nullable: The full name of this subcomponent. - `type` string, nullable: The type of this subcomponent. - `value` string, nullable: The value of this subcomponent. - `floor` BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem: An item of sub-building information, such as a floor or entrance number or name. - `full_name` string, nullable: The full name of this subcomponent. - `type` string, nullable: The type of this subcomponent. - `value` string, nullable: The value of this subcomponent. - `door` BulkAddressV1GetBatchResultsResponseAddressComponentsSubBuildingItem: An item of sub-building information, such as a floor or entrance number or name. - `full_name` string, nullable: The full name of this subcomponent. - `type` string, nullable: The type of this subcomponent. - `value` string, nullable: The value of this subcomponent. - `building` BulkAddressV1GetBatchResultsResponseAddressComponentsBuilding: The building component. - `building_name` string, nullable: The building name. - `building_number` string, nullable: The building number. - `secondary_name` string, nullable: The secondary building name. - `secondary_number` string, nullable: The secondary name of the building (if available). - `allotment_number` string, nullable: The allotment name where a person or property resides. - `organization` BulkAddressV1GetBatchResultsResponseAddressComponentsOrganization: The organization component. - `department_name` string, nullable: The department name within an organization. - `secondary_department_name` string, nullable: The secondary department name within an organization. - `company_name` string, nullable: The company name. - `street` BulkAddressV1GetBatchResultsResponseAddressComponentsStreet: The street component. - `full_name` string, nullable: The combination of the other populated secondary street components: prefix, name, type, suffix. - `name` string, nullable: The street name only. - `type` string, nullable: The street type only. - `prefix` string, nullable: The street prefix only. - `suffix` string, nullable: The street suffix only. - `secondary_street` BulkAddressV1GetBatchResultsResponseAddressComponentsStreet: The street component. - `full_name` string, nullable: The combination of the other populated secondary street components: prefix, name, type, suffix. - `name` string, nullable: The street name only. - `type` string, nullable: The street type only. - `prefix` string, nullable: The street prefix only. - `suffix` string, nullable: The street suffix only. - `route_service` BulkAddressV1GetBatchResultsResponseAddressComponentsRouteService: The route service component. - `full_name` string, nullable: The full name of the route service. - `service_type` string, nullable: The route service type. - `service_number` string, nullable: The route service number. - `delivery_name` string, nullable: The route service delivery name. - `qualifier` string, nullable: The route service qualifier. - `locality` BulkAddressV1GetBatchResultsResponseAddressComponentsLocality: The locality component. - `region` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `sub_region` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `town` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `district` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `sub_district` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `physical_locality` BulkAddressV1GetBatchResultsResponseAddressComponentsLocality: The locality component. - `region` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `sub_region` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `town` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `district` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `sub_district` BulkAddressV1GetBatchResultsResponseAddressComponentsLocalityItem: A single place name, code and a description of its type. - `name` string, nullable: Gets or sets the locality name - `code` string, nullable: Gets or sets the locality code - `description` string, nullable: Gets or sets the locality description - `metadata` BulkAddressV1GetBatchResultsResponseAddressMetadata: The address metadata. - `address_info` BulkAddressV1GetBatchResultsResponseAddressMetadataAddressInfo: Address information. - `sources` string[], nullable: Source of address information. - `number_of_households` string, nullable: Number of households for records in GBR Not Yet Built, or multi-occupancy count of the owning delivery point for GBR Multiple Residence. - `just_built_date` string, nullable: Construction date of the record, if it has been constructed in the last 6 months (GBR specific). - `identifier` BulkAddressV1GetBatchResultsResponseAddressMetadataAddressInfoIdentifier: The ID metadata of formatted address. - `udprn` string, nullable: Royal Mail's Unique Delivery Point Reference Number, an eight-digit code assigned to every delivery point in the Postcode Address File (PAF). - `umrrn` string, nullable: Royal Mail's Unique Multiple Residence Reference Number, an eight-digit code linked to UDPRNs in Royal Mail's Multiple Residence dataset. - `dpid` string, nullable: Australia Post's Delivery Point Identifier, an eight-digit number that uniquely identifies a physical location to which Australia Post delivers mail - applicable to AUS and NZL addresses. - `gnafpid` string, nullable: Geoscape Australia's Geocoded National Address File Persistent Identifier (G-NAF ID). - `hin` string, nullable: Household Identification Number (applicable for AUS addresses). - `paf_address_key` string, nullable: PAF Address key (GBR specific). - `route_classification` BulkAddressV1GetBatchResultsResponseAddressMetadataRouteClassification: Address deliverability and type indicators. - `carrier_route` string, nullable: The carrier route value (applicable for USA addresses only). - `id` string, nullable: The street identifier (applicable for AUS addresses only). - `barcode` BulkAddressV1GetBatchResultsResponseAddressMetadataBarcode: Address barcode. - `delivery_point_barcode` string, nullable: The delivery point barcode (applicable for USA addresses only). - `check_digit` string, nullable: The delivery point barcode's check digit (applicable for USA addresses only). - `sort_plan_number` string, nullable: The sort plan number barcode (applicable for AUS addresses only). - `address_classification` BulkAddressV1GetBatchResultsResponseAddressMetadataAddressClassification: Address deliverability and type indicators. - `address_type` BulkAddressV1GetBatchResultsResponseAddressMetadataAddressClassificationAddressType: The address type. - `code` string, nullable: The code of the address type (applicable to USA, AUS and NZL addresses). - `description` string, nullable: The description of the address type (applicable to USA, AUS and NZL addresses). - `delivery_type` string, nullable: Type of mail delivery at the address. Either "business", "residential" or "mixed". - `is_deliverable` string, nullable: Indicator if the address is deliverable - applicable to NZL addresses only. - `dpv` BulkAddressV1GetBatchResultsResponseAddressMetadataDpv: Delivery Point Validation information for the address (USA only). - `cmra_indicator` string, nullable: Indicates that the address is a private business that acts as a commercial mail-receiving agent for specific clients. - `seed_indicator` string, nullable: Seed records are control records placed by the USPS to prevent unauthorized tampering (e.g., creation of lists containing every single delivery point in a geographical region). A seed address will deactivate DPV functionality. To re-activate, please visit the Self Service Portal. - `dpv_indicator` string, nullable: Indicates whether selected address is confirmed as deliverable via DPV (Delivery Point Validation) process. For all possible values, please visit our technical documentation portal. - `footnotes` string[], nullable: USPS codes denoting DPV match levels. For a list of all possible values, please visit our technical documentation portal. - `vacancy_indicator` string, nullable: An address known to be unoccupied for over 90 days and therefore not receiving mail deliveries. - `no_stats_indicator` string, nullable: An address known to not receive mail deliveries (e.g. a house under construction). - `pbsa_indicator` string, nullable: Indicates addresses known to be Post Office Box Street Addresses (PBSA). - `no_stat_reason_code` string[], nullable: Provides details as to why records are flagged as No-Stats. - `drop` string, nullable: Indicates mail is delivered to a single receptable at a site. - `throwback` string, nullable: Indicates mail is not delivered to the street address. - `non_delivery_days_indicator` string, nullable: Indicates mail delivery is not performed every day of the week. - `non_delivery_days_value` string[], nullable: Indicates which days mail is not delivered to the address. - `no_secure_location` string, nullable: Indicates that the door is accessible, but package will not be left due to security concerns. - `door_not_accessible` string, nullable: Indicates addresses where USPS cannot knock on a door to deliver mail. - `enhanced_dpv_code` string, nullable: Indicates whether selected address is confirmed as deliverable via Delivery Point Validation process. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `406`: Not Acceptable - `408`: Request Timeout - `429`: Too Many Requests - `500`: Internal Server Error - `503`: Service Unavailable ## Changes - **2026-10-29** `e762934f3de5`: 8 info - added the optional property `result/addresses/items/metadata/dpv/door_not_accessible` to the response with the `200` status - added the optional property `result/addresses/items/metadata/dpv/drop` to the response with the `200` status - added the optional property `result/addresses/items/metadata/dpv/enhanced_dpv_code` to the response with the `200` status - added the optional property `result/addresses/items/metadata/dpv/no_secure_location` to the response with the `200` status - …4 more [Operation history](https://skmtc.dev/experianaperture/apis/aperture-rest-api/changes/address/bulk/v1/batches/:batch_id/results/get.md) --- [API](https://skmtc.dev/experianaperture/apis/aperture-rest-api.md) - [All operations](https://skmtc.dev/experianaperture/apis/aperture-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/experianaperture/apis/aperture-rest-api/revisions/e762934f3de5?raw)