List Batch Items
Returns a paginated list of batch rows with their current status, customer ID and error, optionally filtered by status. Use it to find the rows you need to act on, for example every row in change_requested or failed.
For full review details of a single row, use Get Batch Item.
Endpoint
GET /v2/compliance/batch/{batch_id}/items
Link
Request
Path Parameters
batch_id
string
Batch ID returned by Create Batch.
Yes
"01a0af8b-831f-7dbe-8eaf-459f81998958"
Query Parameters
status
string
Comma-separated row statuses to include.
No
"change_requested,rejected,failed,invalid"
page
integer
Page number, starting at 1.
No
1
page_size
integer
Number of rows per page.
No
100
Headers
Authorization
<JWT>
Yes
Accept
application/json
Yes
Response (200 OK)
Returns a ListBatchItemsResponse.
Response Fields
items
array[object]
BatchItem objects.
—
page
integer
Current page.
1
page_size
integer
Page size.
100
total
integer
Total matching rows.
2
BatchItem object
row_key
string
Your row identifier from the manifest.
"client-001"
type
string
What the row onboards: individual or company.
"individual"
client_id
string
ID of the created customer. Empty for invalid rows: they never get one.
"DNkjZcj-hHJA-yhO8yAX3rBRe"
external_customer_id
string
Your customer identifier from the manifest, stable across batches.
"crm-48213"
status
string
Row status: invalid, valid, creating, submitted, finished, rejected, change_requested or failed.
"submitted"
review_status
string
Current status of the compliance review.
"pending"
error
string
Reason for invalid or failed, or the latest temporary error while the row is being retried.
""
updated_at
string (date-time)
Last change of the row.
"2026-09-28T11:05:12Z"
Example Response:
Examples
Request — rows that need attention
Error Responses
Errors are returned as {"code", "message", "details"}, where code is a gRPC status code. Use the HTTP status for error handling.
Batch Not Found (404) — the batch does not exist or belongs to another partner:
Authorization fail (401):
Notes
Row statuses:
invalidandfailedcarry the reason inerror.finished,rejectedandfailedare final.Rows being retried: while a row is in
creatingand the platform is retrying a temporary error,errorshows the latest retry reason.Explanations: for a readable summary of every problem in the batch, use Get Batch Status.
Last updated

