Tenant onboarding workspace and workflow

Add onboarding occupiers

Record all additional occupiers linked to the tenancy.

Audience: CRM staffPermission: Authorised tenant/rent staffModule v1.0.0
Exact navigationOnboarding workspace → Occupiers
Before you begin
  • Use an account with Authorised tenant/rent staff and confirm the intended record or setting before making a change.
  • Follow the exact route above. If the screen or action is absent, check module activation, ownership and permissions rather than using another person’s account.
  • Use controlled test data for configuration, integration, email, AI, payment, portal or automation changes before production-wide use.

What this guide covers

Record all additional occupiers linked to the tenancy. The instructions reflect the supplied module’s registered menus, controller actions, views, settings and code-backed validation flow.

Exact step-by-step process

  1. Open Onboarding workspace → Occupiers.
  2. Choose the New, Add, Create or Start action exposed on that screen.
  3. Complete the required fields described below and review any linked record, currency, tax, approval or recipient selection.
  4. Save or submit the form once; correct any validation message rather than bypassing it.
  5. Open the resulting record and verify its number, status, totals, files, activity and downstream links.

Fields, choices and supported possibilities

Exact actionAdd onboarding occupiers
Exact navigationOnboarding workspace → Occupiers
Module version1.0.0
Access ruleAuthorised tenant/rent staff
VerificationReopen the source record and confirm the expected status, linked record, file, notification, portal visibility or financial effect.
Tenant/applicantIdentity, contact, current address, employment/income, occupants, pets, smoker/benefits/children flags and right-to-rent data where exposed.
Tenancy termsProperty, tenant client, start/end/move-in dates, term, rent, frequency, deposit, holding deposit and deposit scheme.
Consent and workflowInvite mode, consents, review notes, agreement template/body, signature stage and workflow action.

Code-backed validations and workflow rules

  • Keep occupant count aligned with the approved application/renter profile.
  • Public application and onboarding actions use token/record checks and explicit workflow states.
  • Do not advance a workflow until the required party, property, dates, financial terms and consent/evidence are complete.

Expected result and verification

  • The supported add onboarding occupiers flow completes without bypassing permission or validation checks.
  • The resulting record, setting, status, file, delivery event or external response is visible from the relevant workspace.
  • Unexpected validation, provider or linked-record errors are investigated before retrying.

Security, privacy and operational checks

  • Apply least privilege to purchasing, vendor, invoice, payment, return, contract and report permissions.
  • Verify vendor identity, bank/payment details, tax, currency, totals and approvals before creating financial commitments.
  • Treat public links, signatures, portal files, attachments and exported reports as controlled business records.
  • Test settings and automated jobs with controlled records before production-wide use.