Get onboarding state

Get onboarding state

When to use this: Read onboarding checklist/progress for the current user.

Required scope: onboarding.read.

GET /user/v1/onboarding

Get onboarding state

cURL

curl --request GET \
  --url https://api.machines.cash/user/v1/onboarding \
  --header 'Authorization: Bearer <token>'

200

{
  "ok": true,
  "data": {},
  "summary": "success"
}

Authorizations

Authorization · string · header · required

Bearer session token for User API operations. Legacy UserSessionBearer naming remains supported.

Response

200

application/json

Success

ok · boolean

data · object

summary · string

errors · object[]

Show child attributes

next · string