Document Mass Uploads

Complete a mass upload

POST/document-mass-uploads/{id}/actions/complete
documents:writecomplete_document_mass_upload

From uploading to queued. Joins the parts (distinct, numbered 1 to part_count, else 422), checks the zip exists, starts the job that files each document, and returns 202 with it and a Location. A repeat is 409 invalid_state. 422 archive_not_found: start anew. 502 upstream_error leaves it uploading. If storage has forgotten the upload: 409, and it becomes failed. Gate: view-all-documents or super admin only, else 403. dry_run contacts no storage. Emits document_mass_upload.queued. It cannot be undone; cancel stops the job.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DocumentMassUploadComplete

  • partsobject[]Required#

    Every part of the zip. Part numbers must be distinct and no higher than the upload's part_count.

{
  "parts": [
    {
      "part_number": 1,
      "etag": "string"
    }
  ]
}

Responses

202

The job that processes the zip was started.

Job
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "string",
    "status": "queued",
    "progress": {
      "done": 1,
      "total": 1
    },
    "result": {},
    "error": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00",
    "completed_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error
502

An upstream dependency (e.g. Sumsub) was unavailable (error.code = upstream_error).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/document-mass-uploads/{id}/actions/complete\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "parts": [
    {
      "part_number": 1,
      "etag": "string"
    }
  ]
}'