---
title: "Check onboarding status"
method: GET
path: "/api/onboarding/agent/status"
---

# Check onboarding status

`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`

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

## Query parameters

- `userId` string, uuid, required

## Response `200`

Current onboarding status

- StatusResponse
  - `onboarded` boolean, required: Whether the user has completed onboarding
  - `step` 'connect' | 'analyzing' | 'confirm' | 'done', required: Current onboarding step
  - `unconfirmed_count` integer: Number of unconfirmed classifications. Only present when step is "confirm".
  - `needs_review_count` integer: Present on step "done" when low-confidence classifications (below the auto-confirm threshold) remain unconfirmed for ongoing review.

## Other responses

- `400`: Invalid request
- `401`: Invalid or missing API key
- `503`: Database not configured

---

[API](https://skmtc.dev/rightmoney/apis/right-money-agent-api.md) · [All operations](https://skmtc.dev/rightmoney/apis/right-money-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rightmoney/apis/right-money-agent-api/revisions/244b5180a5ff?raw)