For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
An array of onboarding flow update payloads. Each payload must include the ‘onboarding_id’ to identify the onboarding flow and can include any other fields that need to be updated. The ‘timestamp’ field represents the time of update.
onboarding_flow_idstringRequired
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.
timestampdatetimeRequired
When this onboarding flow step occurred in your system, in ISO 8601 format.
flow_namestringRequired
Latest onboarding flow that this entity has gone through, e.g. manual KYC, automated onboarding, Simplified Due Diligence, Enhanced Due Diligence
outcomestringRequired
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_idstringOptional
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_idstringOptional
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.
outcome_reasonstring or map from strings to anyOptional
Response
Onboarding flows updated successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.
