Onboarding Sessions

Get an onboarding session

GET/onboarding-sessions/{id}
onboarding:readget_onboarding_sessionRead-only

Returns one onboarding session, with its status and latest verification. include=flow embeds the flow. A session of another organisation's user, a service user, a deleted flow or an unknown id returns 404. Use GET /onboarding-sessions to list sessions. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The onboarding session's id, a uuid. An unknown id, or a session you cannot see, returns 404.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • includestring#

    Set to flow to embed the session's onboarding flow, with its routes.

Responses

200

The onboarding session.

OnboardingSession
{
  "data": {
    "id": "3f6e1c0a-8d52-4b7e-9a14-2c5d7e9b1f60",
    "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "status": "completed",
    "flow_test": false,
    "started_at": "2026-11-08T10:30:00Z",
    "completed_at": "2026-11-08T10:52:00Z",
    "verification": {
      "verified_by_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
      "note": "Passport and proof of address checked.",
      "verified_at": "2026-11-08T11:15:00Z"
    },
    "created_at": "2026-11-08T10:30:00Z",
    "updated_at": "2026-11-08T10:30:00Z"
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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