Check onboarding status

Returns the current onboarding step for a user. Use this to determine what action to take next.

get/api/onboarding/agent/status

Request

  • Base URL: https://app.rightmoney.com
  • URL: https://app.rightmoney.com/api/onboarding/agent/status
  • Auth: API key in header X-RM-Agent-Key

Query parameters

userIdstring uuid required

The user's unique identifier

Response

Current onboarding status

onboardedboolean required

Whether the user has completed onboarding

step'connect' | 'analyzing' | 'confirm' | 'done' required

Current onboarding step

unconfirmed_countinteger

Number of unconfirmed classifications. Only present when step is "confirm".

needs_review_countinteger

Present on step "done" when low-confidence classifications (below the auto-confirm threshold) remain unconfirmed for ongoing review.

Changes

No recorded changes to this operation across all 1 revision of this API.