Onboarding

Reset an onboarding implementation

POST/onboarding/implementations/{implementationId}/reset
onboarding:adminreset_compliance_implementationDestructiveDeprecatedSunset 2027-06-30

Sensitive. Resets one implementation. clear_routes drops navigation history, clear_data deletes answers and clear_classifications removes granted investor-class links. A continuous flow's implementation answers with expired true and end_date null; a versioned flow starts a new one and this route answers the OLD one. Deprecated: withdrawn on 2027-06-30. POST /onboarding-sessions/{id}/actions/reset replaces it; the Link header names it.

Path parameters

  • implementationIdstring (uuid)Required#

    The compliance implementation's public uuid.

Request body

application/json, optional

  • clear_routesboolean#
    Default: false
  • clear_databoolean#
    Default: false
  • clear_classificationsboolean#
    Default: false
{
  "clear_routes": true,
  "clear_data": true,
  "clear_classifications": false
}

Responses

200

OK

ComplianceImplementation
{
  "data": {
    "id": "1f0c9e8d-7b6a-4039-8271-6e5d4c3b2a19",
    "compliance_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "user_id": "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9",
    "flow_test": false,
    "expired": true,
    "start_date": "2026-06-15T10:30:00+00:00",
    "end_date": null,
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-15T10:40: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
422

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/onboarding/implementations/{implementationId}/reset\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "clear_routes": true,
  "clear_data": true,
  "clear_classifications": false
}'