Skip to main content

Ark Flows API — overview

Ark Flows API is the REST entry point for Ark's orchestrated onboarding. A caller starts an onboarding with one request; Ark runs the whole multi-step journey on its own — validating the address, verifying identity, assessing risk, and provisioning the new party — and the caller follows progress by polling a status endpoint.

It is a start-and-poll API: the work runs asynchronously after the start call returns, so the caller never has to drive each step.

Flows available today​

FlowWhat it does
Individual onboardingOnboards an individual applicant end-to-end: address validation, identity verification (KYX), a business-rules risk assessment, and provisioning of a party, an account, and a card.
Sole-trader onboardingSame journey as individual, with the applicant flagged as a sole trader (ABN + optional trading name on the party). Risk scoring and downstream provisioning use the sole-trader entity flavour.
Company onboardingOnboards a company end-to-end. Same pre-provisioning trunk (address → KYX → risk), then a provisioning chain that adds a signatory link between the company account and a previously-onboarded director.

All three flows share the same status envelope and the same set of statuses — only the work behind the scenes differs.

How a caller uses it​

  1. Start an onboarding with POST /v1/onboarding/{type} where {type} is individual, sole-trader, or company. The response returns immediately with a workflow id and an initial status of INITIATED — the work runs in the background.
  2. Poll GET /v1/onboarding/{type}/{workflowId}/status to follow the onboarding through its states until it reaches COMPLETED or FAILED.

The workflow id returned by the start call is the single handle a caller uses to track the onboarding for its whole lifetime.

You want…Doc
How to call the six endpointsendpoints (non-dev)
How an onboarding progresses end-to-endlifecycle (non-dev)

The formal request/response contract is the Ark Onboarding API OpenAPI specification (openapi/source/platform/onboarding/onboarding.yml); this doc set does not restate it.