Onboarding

Preview an onboarding flow template

GET/onboarding/flow-templates/{key}
onboarding:readget_compliance_templateRead-onlyDeprecatedSunset 2027-06-30

Returns the full definition of one onboarding flow template (ordered pages, routing graph and classification gates) so a caller can inspect it before cloning. Clone it with POST /onboarding/flow-templates/{key}/instantiate. Unknown keys are a leak-safe 404. Deprecated: withdrawn on 2027-06-30. GET /flow-templates/{id} replaces it; the Link header names it.

Path parameters

  • keystringRequired#

    The compliance flow template's catalogue key.

Responses

200

OK

ComplianceTemplatePreview
{
  "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"
      }
    ],
    "start_page_reference": "start",
    "pages": [
      {
        "reference": "start",
        "title": "Investor Type",
        "fields": [
          {
            "reference": "investor_type",
            "type": "radio",
            "label": "Which category applies to you?",
            "required": true,
            "options": [
              "High Net Worth",
              "Sophisticated"
            ]
          }
        ]
      },
      {
        "reference": "hnw_declaration",
        "title": "High Net Worth Declaration",
        "fields": [
          {
            "reference": "annual_income",
            "type": "currency",
            "label": "Annual income",
            "required": true
          },
          {
            "reference": "net_assets",
            "type": "currency",
            "label": "Net assets",
            "required": true
          }
        ]
      },
      {
        "reference": "confirmation",
        "title": "Confirmation",
        "fields": [
          {
            "reference": "declaration_agreed",
            "type": "checkbox",
            "label": "I confirm the above is accurate",
            "required": true
          }
        ]
      }
    ],
    "routes": [
      {
        "from": "start",
        "to": "hnw_declaration",
        "conditions": [
          {
            "field": "investor_type",
            "operator": "equals",
            "value": "High Net Worth"
          }
        ]
      },
      {
        "from": "hnw_declaration",
        "to": "confirmation",
        "conditions": []
      }
    ]
  }
}
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/flow-templates/{key}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"