GET
Onboarding state

Overview

Returns the authenticated user’s current position in the four-step onboarding flow. The mobile client calls this on app launch and after every disconnect to know where to resume the user — it is the resume oracle for the onboarding state machine. currentStep is the step the user is currently expected to submit next. Once onboardingStatus becomes COMPLETE, currentStep is set to null and all onboarding step endpoints return 409 STATE_CONFLICT. From that point further edits go through the post-onboarding surfaces (/current-home/me, /preferences/me).

Authentication

Bearer <accessToken> required. Scope: user.

Path parameters

None.

Query parameters

None.

Request body

None.

Response — 200 OK

Example response

Error responses

Example error — 401

Side effects

None — this is a pure read.

See also

curl