Get financial summary

Returns the user's financial summary with transactions classified into the three-bucket system. If the user hasn't connected their bank or classified transactions yet, returns the appropriate next step.

post/api/onboarding/agent/start

Request

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

Request body

userIdstring uuid required

The user's unique identifier

Response

Onboarding state or financial summary

status'needs_plaid' | 'needs_classification' | 'ready' | 'confirmed' required

Current state of the onboarding flow

messagestring
link_urlstring uri

URL to direct the user to (when status is needs_plaid)

Changes

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