---
title: "Update onboarding flow in batch"
method: PUT
path: "/v2/onboarding_flow"
tags: ["Onboarding Flow"]
---

# Update onboarding flow in batch

`PUT /v2/onboarding_flow`

## Request body

- OnboardingFlow[]
  - `flow_name` string, required — Latest onboarding flow that this entity has gone through, e.g. manual KYC, automated onboarding, Simplified Due Diligence, Enhanced Due Diligence
  - `onboarding_flow_id` string, required — Unique identifier for an onboarding flow belonging to an onboarding flow. This is the primary key for an onboarding flow and should be unique across all onboarding flows. Updates to an onboarding flow should be made using this identifier.
  - `outcome` string, required — Outcome for the latest onboarding flow that this entity has gone through, e.g. automated approval, manual approval, automated rejection, manual rejection, EDD required
  - `outcome_reason` union
    - string
    - object
  - `related_company_id` string — Unique identifier of the related company entity (used for business contexts). Only one of related_company_id and related_person_id can be specified.
  - `related_person_id` string — Unique identifier of the related person entity (used for retail contexts or when a person is the subject). Only one of related_company_id and related_person_id can be specified.
  - `timestamp` string, date-time, required — When this onboarding flow step occurred in your system, in ISO 8601 format.

## Response `200`

Onboarding flows updated successfully

- WriteOperationResponse
  - `message` string, required — Provides additional information about the operation result.
  - `organization_id` string, required — The organization ID for which the operation was performed.
  - `success` boolean, required — Indicates if the write operation was successful.
  - `write_count` integer, required — The number of records written to the database.

## Other responses

- `400` — Onbnoarding flow data
- `401` — Unauthorized request
- `404` — Onboarding flow not found
- `429` — Rate limit exceeded
- `500` — Server error
- `default` — General error

---

[API](https://skmtc.dev/cable/apis/cable-api.md) · [All operations](https://skmtc.dev/cable/apis/cable-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cable/cable-api/revisions/3222cd28dba5/schema)