Onboarding

List an onboarding flow's sections/forms

GET/onboarding/flows/{complianceId}/forms
onboarding:readlist_compliance_formsRead-onlyDeprecatedSunset 2027-06-30

Lists the sections/forms attached to the onboarding flow as a simple { "data": [...] } envelope (no cursor). Deprecated: withdrawn on 2027-06-30. GET /onboarding-flows/{onboarding_flow_id}/forms replaces it; the Link header names it.

Path parameters

  • complianceIdstring (uuid)Required#

    The compliance flow's public uuid.

Responses

200

OK

ComplianceForm[]
{
  "data": [
    {
      "id": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112",
      "compliance_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "form_id": "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9",
      "name": "Investor Categorisation",
      "is_start": true
    },
    {
      "id": "d4e5f607-1829-4304-b5c6-d7e8f9011223",
      "compliance_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "form_id": "b2c3d4e5-f607-4182-93a4-b5c6d7e8f901",
      "name": "Source of Wealth",
      "is_start": false
    }
  ]
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/onboarding/flows/{complianceId}/forms\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"