Onboarding Sessions

Get an onboarding session report

GET/onboarding-sessions/{id}/report
onboarding:readget_onboarding_session_reportRead-only

Returns the report as JSON: the routes the respondent followed, in order, as choices with the conditions that sent them along each, and the forms answered, oldest completion first, as forms with answers keyed by form field id. Masked answers are withheld. GET /onboarding-sessions/{id}/report/download gives the same report as a PDF. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The onboarding session's id, a uuid. An unknown id, or a session you cannot see, returns 404.

Responses

200

The report.

OnboardingSessionReport
{
  "data": {
    "choices": [
      {
        "from_form_id": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9",
        "to_form_id": "5d6e7f8a-9b0c-4d1e-8f3a-4b5c6d7e8f90",
        "condition_sets": []
      }
    ],
    "forms": [
      {
        "form_id": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9",
        "name": "Investor qualification",
        "completed_at": "2026-11-09T11:05:00Z",
        "answers": {
          "4c5d6e7f-8a9b-4c0d-9e2f-3a4b5c6d7e8f": "85000"
        }
      }
    ]
  }
}
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-sessions/{id}/report\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"