Onboarding

Get an onboarding implementation's active form

GET/onboarding/implementations/{implementationId}/form
onboarding:readget_compliance_implementation_formRead-onlyDeprecatedSunset 2027-06-30

Returns the form at the respondent's current step, creating the form implementation on first access, plus a camelCase canGoBack flag. The payload is the platform's form-implementation shape. Deprecated: withdrawn on 2027-06-30. GET /onboarding-sessions/{id}/form replaces it; the Link header names it.

Path parameters

  • implementationIdstring (uuid)Required#

    The compliance implementation's public uuid.

Responses

200

OK

{
  "data": {
    "id": 41,
    "uuid": "e5f60718-2930-4415-a6b7-c8d9e0f11234",
    "form_id": 22,
    "started_on": "2026-06-15T10:31:00+00:00",
    "completed_on": null,
    "created_at": "2026-06-15T10:31:00+00:00",
    "updated_at": "2026-06-15T10:31:00+00:00",
    "deleted_at": null,
    "type": null,
    "form": {
      "id": 22,
      "name": "Source of Wealth",
      "uuid": "b2c3d4e5-f607-4182-93a4-b5c6d7e8f901"
    },
    "form_field_answers": [],
    "form_implementation_assignments": [],
    "canGoBack": true
  }
}
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/implementations/{implementationId}/form\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"