Onboarding

Get an onboarding implementation report

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

Returns the implementation report as JSON: the routes taken as choices and the answered forms as form_implementations, both as the domain models serialise them. Deprecated: withdrawn on 2027-06-30. GET /onboarding-sessions/{id}/report replaces it; the Link header names it.

Path parameters

  • implementationIdstring (uuid)Required#

    The compliance implementation's public uuid.

Responses

200

OK

ComplianceReport
{
  "data": {
    "choices": [
      {
        "id": 31,
        "uuid": "0d1e2f30-4152-4a63-8b74-95a6b7c8d9e0",
        "from_form_id": 21,
        "to_form_id": 22,
        "compliance_id": 7,
        "_lft": 1,
        "_rgt": 2,
        "parent_id": null,
        "created_at": "2026-06-15T10:31:00+00:00",
        "updated_at": "2026-06-15T10:31:00+00:00",
        "deleted_at": null,
        "condition_type": null,
        "condition_value": null,
        "laravel_through_key": 12,
        "from_form": {
          "id": 21,
          "name": "Investor Categorisation",
          "uuid": "b2c3d4e5-f607-4182-93a4-b5c6d7e8f901"
        },
        "to_form": {
          "id": 22,
          "name": "Source of Wealth",
          "uuid": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112"
        },
        "condition_sets": []
      }
    ],
    "form_implementations": [
      {
        "id": 41,
        "uuid": "e5f60718-2930-4415-a6b7-c8d9e0f11234",
        "form_id": 21,
        "started_on": "2026-06-15T10:31:00+00:00",
        "completed_on": "2026-06-15T10:35:00+00:00",
        "created_at": "2026-06-15T10:31:00+00:00",
        "updated_at": "2026-06-15T10:35:00+00:00",
        "deleted_at": null,
        "type": null,
        "form_field_answers": [],
        "form": {
          "id": 21,
          "name": "Investor Categorisation",
          "uuid": "b2c3d4e5-f607-4182-93a4-b5c6d7e8f901"
        },
        "form_implementation_assignments": []
      }
    ]
  }
}
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}/report\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"