v1

latestOpenAPI 3.0.32026-08-04404186.8 KB

Onboarding Flow

Update onboarding flow in batch

put/v2/onboarding_flow

Request body

flow_namestring required

Latest onboarding flow that this entity has gone through, e.g. manual KYC, automated onboarding, Simplified Due Diligence, Enhanced Due Diligence

onboarding_flow_idstring 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.

outcomestring 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

related_company_idstring

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_idstring

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.

timestampstring date-time required

When this onboarding flow step occurred in your system, in ISO 8601 format.

Example request

[
  {
    "flow_name": "Manual KYC",
    "outcome": "automated approval",
    "related_company_id": "company-id-12345",
    "related_person_id": "person-id-56789"
  }
]

Response

Onboarding flows updated successfully

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.