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

# Gets the status of a batch of phone numbers to be validated.

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

## Request

- Base URL: `https://api.experianaperture.io`
- URL: `https://api.experianaperture.io/phone/bulk/v1/batches/{batch_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `Auth-Token`
- TypeScript: <https://skmtc.dev/experianaperture/apis/aperture-rest-api/docs/phone/bulk/v1/batches/:batch_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `batch_id` string, required

## Headers

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

## Response `200`

OK

- BulkPhoneV1GetBatchStatusResponse: Bulk Phone 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` BulkPhoneV1GetBatchStatusResult: Bulk Phone 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 phone numbers have been submitted.
    - `records_processed` integer, nullable: The number of phone numbers have been processed.
    - `date_submitted` string, date-time: 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` BulkPhoneV1GetBatchStatusMetadata: Bulk Phone V1 Get Batch Status metadata.
    - `batch_config` BulkPhoneV1GetBatchStatusBatchConfig: The submitted default options.
      - `output_format` string, nullable: The desired format of the phone number: E164, PLUS_E164, NATIONAL, any 3-letter ISO country code.
      - `country_iso` string, nullable: The 3-letter ISO country code if the phone number that is subject to validation doesn't contain a phone country code.
      - `get_ported_date` boolean, nullable: A boolean indicator to attempt to retrieve the last ported date of the phone number.
      - `supplementary_live_status` BulkPhoneV1GetBatchStatusBatchConfigSupplementaryLiveStatus: Batch configuration supplementary live status.
        - `mobile` string[], nullable: An indicator to attempt to get supplementary live status for Mobile Phone Number.
        - `landline` string[], nullable: An indicator to attempt to get supplementary live status for Landline Phone Number.
      - `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/e762934f3de5?raw)