Onboarding

Get an onboarding implementation

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

Returns one implementation, a single respondent's run through an onboarding flow. Deprecated: withdrawn on 2027-06-30. GET /onboarding-sessions/{id} replaces it; the Link header names it.

Path parameters

  • implementationIdstring (uuid)Required#

    The compliance implementation's public uuid.

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": false,
    "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:30: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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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