> For the complete documentation index, see [llms.txt](https://docs.delos.financial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delos.financial/batchservice/get-batch-status.md). # Get Batch Status Returns a summary of the batch: its current state and counters, a paginated list of **problems** with readable explanations, and a paginated list of **customers already created** by the batch. * **Problems** are rows in `invalid`, `failed`, `change_requested` or `rejected`, plus rows in `creating` that are being retried after a temporary error. Each problem has a short `summary` of what is wrong. * **Clients** are rows whose customer has actually been created, with the `client_id` you can use in other API methods. Reserved IDs that were never used are not included. Counters include zeros and are available even before the first commit. **Endpoint** `GET /v2/compliance/batch/{batch_id}/status` **Link** **Request** **Path Parameters** | Parameter | Type | Description | Required | Example | | -------------- | -------- | ---------------------------------- | -------- | ---------------------------------------- | | **`batch_id`** | `string` | Batch ID returned by Create Batch. | Yes | `"01a0af8b-831f-7dbe-8eaf-459f81998958"` | **Query Parameters** | Parameter | Type | Description | Required | Default | | ---------------------- | --------- | ----------------------------------------------------- | -------- | ------- | | **`page`** | `integer` | Page of `problems`, starting at 1. | No | `1` | | **`page_size`** | `integer` | Problems per page, `0`–`100`. | No | `100` | | **`client_page`** | `integer` | Page of `clients`, starting at 1. | No | `1` | | **`client_page_size`** | `integer` | Clients per page, `0`–`100`. | No | `100` | | **`detailed`** | `boolean` | Include full row details in each problem (`details`). | No | `false` | **Headers** | Key | Value | Required | | --------------- | ------------------ | -------- | | `Authorization` | `` | Yes | | `Accept` | `application/json` | Yes | **Response (200 OK)** Returns a `BatchStatusResponse`. **Response Fields** | Field | Type | Description | | ---------------------- | --------------- | ------------------------------------------------------------- | | **`batch`** | `object` | `Batch` object. See Create Batch → Response Fields. | | **`problems`** | `array[object]` | `BatchProblem` objects for the current page. See below. | | **`problem_total`** | `integer` | Total number of problems. | | **`page`** | `integer` | Current problems page. | | **`page_size`** | `integer` | Problems page size. | | **`clients`** | `array[object]` | `CreatedBatchClient` objects for the current page. See below. | | **`client_total`** | `integer` | Total number of created customers. | | **`client_page`** | `integer` | Current clients page. | | **`client_page_size`** | `integer` | Clients page size. | **`problems[]` (`BatchProblem`)** | Field | Type | Description | | --------------------------- | -------- | ------------------------------------------------------------------------- | | **`row_key`** | `string` | Row identifier. | | **`client_id`** | `string` | Customer ID, if created. | | **`type`** | `string` | `individual` or `company`. | | **`status`** | `string` | Row status. | | **`current_review_status`** | `string` | Current compliance review status, read live. | | **`summary`** | `string` | Readable explanation of the problem. | | **`details`** | `object` | `BatchItemDetail`, same as Get Batch Item. Returned with `detailed=true`. | **`clients[]` (`CreatedBatchClient`)** | Field | Type | Description | | -------------------------- | -------- | ------------------------------------------- | | **`row_key`** | `string` | Row identifier. | | **`client_id`** | `string` | ID of the created customer. | | **`external_customer_id`** | `string` | Your customer identifier from the manifest. | **Example Response:** ```json { "batch": { "batch_id": "01a0af8b-831f-7dbe-8eaf-459f81998958", "status": "CLOSED", "schema_version": "string", "types": [ "individual", "company" ], "individual_kyc_level": "string", "company_kyc_level": "string", "party_kyc_levels": [ "string" ], "counters": { "total": 120, "draft": 0, "valid": 0, "invalid": 3, "creating": 2, "submitted": 85, "finished": 24, "change_requested": 4, "rejected": 1, "failed": 1 }, "processed": false, "done": false, "created_at": "2026-09-28T10:15:30Z", "committed_at": "2026-09-28T11:02:04Z", "error": "" }, "problem_total": 2, "problems": [ { "row_key": "client-017", "client_id": "", "type": "individual", "status": "invalid", "current_review_status": "", "summary": "fields.email: value does not match format email" }, { "row_key": "client-001", "client_id": "DNkjZcj-hHJA-yhO8yAX3rBRe", "type": "individual", "status": "change_requested", "current_review_status": "string", "summary": "ID_CARD FRONT_SIDE (client-001/id-front.jpg): document is not readable" } ], "page": 1, "page_size": 100, "clients": [ { "row_key": "client-001", "client_id": "DNkjZcj-hHJA-yhO8yAX3rBRe", "external_customer_id": "crm-48213" } ], "client_total": 1, "client_page": 1, "client_page_size": 100 } ``` *** **Examples** **Request** ```bash curl --request GET \ --url \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' ``` *** **Error Responses** Errors are returned as `{"code", "message", "details"}`, where `code` is a gRPC status code. Use the HTTP status for error handling. **Invalid Page Size (400)**: ```json { "code": 3, "message": "page_size must be between 0 and 100", "details": [] } ``` **Batch Not Found (404)** — the batch does not exist or belongs to another partner: ```json { "code": 5, "message": "batch not found", "details": [] } ``` **Authorization fail (401)**: ```json { "code": 16, "message": "Unauthorized", "details": [] } ``` *** **Notes** * **Two independent lists**: `page` / `page_size` control `problems`; `client_page` / `client_page_size` control `clients`. * **Live review data**: the problem set comes from row statuses, while review details are read from compliance in real time and may be newer. * **Use `clients` for mapping**: it is the quickest way to map your `row_key` and `external_customer_id` to Delos `client_id`. * **Uploads do not count**: uploading files to the prefix does not create rows; rows appear only after a commit. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.delos.financial/batchservice/get-batch-status.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.