Registration & invites
How residents onboard and tie accounts to units.
Overview
Residents onboard via invites created by property managers, then complete signup in the app or portal.
See Imports & onboarding for the full invite API.
Invite flow
- PM creates invite:
POST /api/admin/onboarding/invite - System dispatches email/SMS:
POST .../dispatchor.../resend - Resident opens invite link → Clerk sign-up (portal) or app registration
- Resident links to unit; invite status →
ACCEPTED
Admin-side prep
| Step | API |
|---|---|
| Ensure unit exists | POST /api/admin/units |
| Assign virtual number | POST /api/admin/virtual-numbers/:id/assign |
| Create invite | POST /api/admin/onboarding/invite |
| Bulk import | POST /api/admin/imports/residents/dry-run → commit |
Invite model
| Field | Notes |
|---|---|
token | Unique invite token |
inviteUrl | Shareable URL |
expiresAt | Expiration datetime |
status | PENDING, ACCEPTED, EXPIRED |
inviteeEmail / inviteePhone | Pre-filled contact info |
Auditing
Use /api/admin/audit to trace administrative changes during disputes or compliance reviews.
Last verified: 2026-06-21 (commit 293c4a7)