POST
Onboarding step 4 — desired home

Overview

Submits the user’s matching preferences (the “desired home” filter) and completes onboarding. After a successful call:
  • user_preferences is persisted (full replace).
  • users.onboardingStatus = COMPLETE and users.currentStep = null.
  • A tenancy.review job is enqueued (admin queue gate — Phase 6 will consume it).
  • A match.recompute job is enqueued (Phase 3 will consume it).
From this point all onboarding endpoints return 409 STATE_CONFLICT. Further preferences edits go through PUT /preferences/me; further listing edits through /current-home/me/*. Preconditions:
  • currentStep is exactly 4.

Authentication

Bearer <accessToken> required. Scope: user.

Path parameters

None.

Query parameters

None.

Request body

MaxRent object

PreferredLocation object

Example payload

Response — 200 OK

Returns the refreshed onboarding state. onboardingStatus flips to COMPLETE and currentStep becomes null.

Example response

Error responses

Example error — 400

Side effects

  • Upserts the caller’s row in the user_preferences collection (maxRentMonthlyMinor is derived server-side).
  • Sets users.onboardingStatus = COMPLETE, users.currentStep = null, and stamps onboardingCompletedAt.
  • Enqueues a tenancy.review job for the admin review queue (consumed in Phase 6) when a tenancyVerificationId exists.
  • Enqueues a match.recompute job (consumed in Phase 3) with reason: 'preferences_updated'.

See also

curl