Skip to main content

Get the current state of an onboarding workflow.

GET 

/v1/onboarding/individual/:workflowId/status

Reads the workflow_state row from ark-flows DB. The row is seeded with status=INITIATED when the workflow starts and upserted by the worker at every step transition. Miss ⇒ 404 ONB004001.

results[] contains one ActivityResult per activity that has actually executed (only-run, MVP — see solution-design Decisions §8). Output fields are sanitised by the API mapper before serialisation — access tokens, raw address details, and other PII are stripped.

Request

Responses

Current workflow state.