Onboarding

Get an onboarding flow

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

Returns one onboarding flow (the investor journey definition). Deprecated: withdrawn on 2027-06-30. GET /onboarding-flows/{id} replaces it; the Link header names it.

Path parameters

  • complianceIdstring (uuid)Required#

    The compliance flow's public uuid.

Responses

200

OK

Compliance
{
  "data": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "name": "Investor Suitability",
    "status": "published",
    "expiry_type": "TWELVE_MONTH",
    "mode_type": "Continuous",
    "definition": null,
    "forms_count": 2,
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-15T10:30:00+00:00"
  }
}
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}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"