Onboarding

List onboarding flow templates

GET/onboarding/flow-templates
onboarding:readlist_compliance_templatesRead-onlyDeprecatedSunset 2027-06-30

Lists the platform-supplied onboarding flow templates — reusable, pre-built onboarding flows a caller can preview and clone into their own flow. The catalogue is a fixed, code-defined library shared by every tenant — it is not paginated or org-scoped. Preview one with GET /onboarding/flow-templates/{key} and clone it with POST /onboarding/flow-templates/{key}/instantiate. Deprecated: withdrawn on 2027-06-30. GET /flow-templates replaces it; the Link header names it.

Responses

200

OK

ComplianceTemplate[]
{
  "data": [
    {
      "key": "uk-investor-categorisation",
      "region": "UK",
      "title": "UK Investor Categorisation",
      "description": "Categorises an investor under FCA COBS rules.",
      "regulatory_basis": "FCA COBS 4.12",
      "page_count": 3,
      "field_count": 12,
      "classifications": [
        {
          "id": 42,
          "name": "High Net Worth Individual"
        },
        {
          "id": 43,
          "name": "Self-Certified Sophisticated Investor"
        }
      ]
    },
    {
      "key": "us-accredited-investor",
      "region": "US",
      "title": "US Accredited Investor",
      "description": "Verifies accredited-investor status under Regulation D.",
      "regulatory_basis": "SEC Rule 501(a)",
      "page_count": 2,
      "field_count": 8,
      "classifications": [
        {
          "id": 51,
          "name": "Accredited Investor"
        }
      ]
    }
  ]
}
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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/onboarding/flow-templates\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"