Onboarding Sessions

Reset an onboarding session

POST/onboarding-sessions/{id}/actions/reset
onboarding:adminreset_onboarding_sessionDestructive

Sensitive. Voids a session in any state. A continuous session becomes expired with completed_at cleared; clear_routes, clear_data and clear_classifications clear what they say, and awarded classification links always go. A versioned flow keeps the old session, which reads as expired once the new one exists, starts a new one, ignores the options and answers the NEW session. Sends the onboarding_session.reset webhook, plus created for a new session. dry_run supported. Can't be undone.

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

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, optional · OnboardingSessionResetOptions

  • clear_routesboolean#

    Remove the routes the respondent followed, so the session starts again at the start form.

    Default: false
  • clear_databoolean#

    Delete the respondent's answers.

    Default: false
  • clear_classificationsboolean#

    Also remove the awarded investor classes from the user in Horizon. The links to awarded classifications are removed either way.

    Default: false
{
  "clear_routes": true,
  "clear_data": true,
  "clear_classifications": false
}

Responses

200

The reset session on a continuous flow, or the new session on a versioned flow.

OnboardingSession
{
  "data": {
    "id": "3f6e1c0a-8d52-4b7e-9a14-2c5d7e9b1f60",
    "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "status": "expired",
    "flow_test": false,
    "started_at": "2026-11-08T10:30:00Z",
    "completed_at": null,
    "verification": null,
    "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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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 -X POST https://your-org-domain/kong/core/api/v2/onboarding-sessions/{id}/actions/reset\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "clear_routes": true,
  "clear_data": true,
  "clear_classifications": false
}'