---
title: "Gets the status of a batch of address to be validated."
method: GET
path: "/address/bulk/v1/batches/{batch_id}"
tags: ["Bulk Address"]
---

# Gets the status of a batch of address to be validated.

`GET /address/bulk/v1/batches/{batch_id}`

## Path parameters

- `batch_id` string, required

## Headers

- `Reference-Id` string
- `Add-Metadata` boolean

## Response `200`

OK

- BulkAddressV1GetBatchStatusResponse — Bulk Address V1 Get Batch Status 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` BulkAddressV1GetBatchStatusResult — Bulk Address V1 Get Batch Status result.
    - `batch_id` string, nullable — Batch ID.
    - `batch_reference_id` string, nullable — Optional reference identifier to track this batch.
    - `status` string, nullable — The current Batch status.
    - `reason` string, nullable — The reason of the current Batch status.
    - `records` integer, nullable — The number of address have been submitted.
    - `records_processed` integer, nullable — The number of address have been processed.
    - `date_submitted` string, date-time, nullable — The date time when the Batch is created in ISO-8601 format.
    - `date_started` string, date-time, nullable — The date time when the Batch is started in ISO-8601 format.
    - `date_ended` string, date-time, nullable — The date time when the Batch is ended in ISO-8601 format.
  - `metadata` BulkAddressV1GetBatchStatusMetadata — Bulk Address V1 Get Batch Status metadata.
    - `batch_config` BulkAddressV1GetBatchStatusMetadataBatchConfig — Bulk Address V1 Get Batch Status metadata's batch config.
      - `country_iso` string, nullable — Country ISO.
      - `datasets` string[], nullable — Datasets.
      - `add_components` boolean, nullable — Add components.
      - `add_metadata` boolean, nullable — Add metadata.
      - `add_extra_match_info` boolean, nullable — Add extra match info.
      - `max_processing_time` string, nullable — Optional maximum processing time of the batch.

## 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

---

[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/1806e209c39d?raw)