---
title: "Store onboarding step in session"
method: POST
path: "/api/auth/onboarding-step"
tags: ["auth", "internal"]
---

# Store onboarding step in session

`POST /api/auth/onboarding-step`

## Request body

- OnboardingStepRequest — Request to save onboarding step
  - `referral_source` string, nullable — Referral source (how they heard about Scanopy)
  - `referral_source_other` string, nullable — Free-text referral source (when "other" is selected)
  - `step` string, required
  - `use_case` string, nullable — Use case selection (homelab, company, msp)

## Response `200`

Step saved

- ApiResponse
  - `data` TupleUnit — unresolved $ref
  - `error` string, nullable
  - `meta` ApiMeta, required — API metadata included in all responses
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required

## Changes

- **2026-04-20** `f04499e2280f` — 2 breaking, 3 info
  - removed `#/components/schemas/UseCase, subschema #1` from the `use_case` request property `oneOf` list
  - the `use_case` request property type/format changed from ``/`` to `string, null`/``
  - added the new optional request property `referral_source`
  - added the new optional request property `referral_source_other`
  - …1 more

[Change history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/auth/onboarding-step/post.md)

---

[API](https://skmtc.dev/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.dev/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/f04499e2280f/schema)