Cancel Batch
Closes a batch permanently. The batch moves from OPEN or CHANGE_REQUESTED to CANCELLED and no longer counts against the limit of 3 open batches.
Cancellation is one-way: a cancelled batch never reopens. Calling it again on a CANCELLED batch is a no-op. A CLOSEDbatch cannot be cancelled (409); reopen it with Request Batch Changes first.
What happens to rows:
Rows that were never submitted to compliance review become
failed.Rows already submitted cannot be withdrawn and still receive a final result.
Endpoint
POST /v2/compliance/batch/{batch_id}/cancel
Link
Request
Path Parameters
batch_id
string
Batch ID returned by Create Batch.
Yes
"01a0af8b-831f-7dbe-8eaf-459f81998958"
Headers
Authorization
<JWT>
Yes
Accept
application/json
Yes
Body
No request body.
Response (200 OK)
Returns the Batch object. See Create Batch → Response Fields for every field and the counters object.
Example Response:
Examples
Request
Error Responses
Errors are returned as {"code", "message", "details"}, where code is a gRPC status code. Use the HTTP status for error handling.
Batch Cannot Be Cancelled (409) — the batch is CLOSED:
Batch Not Found (404) — the batch does not exist or belongs to another partner:
Authorization fail (401):
Notes
Irreversible: to onboard the same customers later, create a new batch.
Submitted rows keep going: customers already under review are not affected. Track their results with List Batch Items.
Freeing a slot: cancel draft batches you no longer need so that Create Batch does not return
409.
Last updated

