Onboarding

Get a user's onboarding status

GET/users/{userId}/onboarding
onboarding:readget_user_onboardingRead-onlyDeprecatedSunset 2027-06-30

Per-flow onboarding status for the user (latest implementation per flow), in a simple { "data": [...] } envelope that is not cursor paginated. Deprecated: withdrawn on 2027-06-30. GET /onboarding-sessions?filter[user_id]={userId} replaces it; the Link header names it.

Path parameters

  • userIdstring (uuid)Required#

    The user's public guid.

Responses

200

OK

OnboardingStatus[]
{
  "data": [
    {
      "flow_id": "e5f60718-293a-4b4c-9d6e-7f8091a2b3c4",
      "flow_name": "Individual KYC",
      "status": "completed",
      "completed_at": "2026-06-15T10:30:00+00:00"
    },
    {
      "flow_id": "1a2b3c4d-5e6f-4071-8293-a4b5c6d7e8f9",
      "flow_name": "Source of Funds",
      "status": "pending",
      "completed_at": null
    }
  ]
}
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/users/{userId}/onboarding\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"