For the complete documentation index, see llms.txt. This page is also available as Markdown.

Request Batch Changes

Reopens a committed batch for corrections. The batch moves from CLOSED to CHANGE_REQUESTED; you can then get new storage credentials, upload corrected files and a new manifest, and commit again.

Calling it on a batch already in CHANGE_REQUESTED is a no-op. Calling it on an OPEN batch returns 409: an open batch is already editable.

Endpoint

POST /v2/compliance/batch/{batch_id}/change

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

batch_id

string

Batch ID returned by Create Batch.

Yes

"01a0af8b-831f-7dbe-8eaf-459f81998958"

Headers

Key
Value
Required

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:

{
  "batch_id": "01a0af8b-831f-7dbe-8eaf-459f81998958",
  "status": "CHANGE_REQUESTED",
  "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": ""
}

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 Changed (409) — the batch is OPEN or CANCELLED:

Batch Not Found (404) — the batch does not exist or belongs to another partner:

Authorization fail (401):


Notes

  • Full manifest: after reopening, always upload the complete manifest, not only the changed rows. The manifest is the source of truth: a row you remove that has not yet been submitted for review is withdrawn.

  • Replace files under new paths: upload a corrected document under a new file path instead of overwriting the old one, and point the row to it.

  • Final rows are history: rows in finished, rejected or failed are never changed by a later commit. To retry a failed customer, add a new row with a new row_key.

  • Immutable row identity: the type and external_customer_id of an existing row_key cannot be changed.

  • Customer-side fixes: for rows in change_requested, you can also send the end customer a verification link from Get Item WebSDK Link.

Typical Workflow:

  1. Find rows to fix with Get Batch Status.

  2. Call POST /v2/compliance/batch/{batch_id}/change.

  3. Get new credentials with Get Upload Credentials.

  4. Upload corrected files under new paths and the full manifest.json.

  5. Call Commit Batch.

Last updated