Skip to main content
Application configurations let you design your own onboarding journey once and reuse it across applications. Instead of following a fixed sequence, you build a flow from the exact steps your tenancies require — referencing, payments, contracts, and more — and Yorlet guides each applicant through it automatically. This is ideal when different portfolios, sectors, or landlords need different onboarding requirements. Every new application runs on a configuration, so you need at least one published configuration before you can create an application.

Building a configuration

To create a configuration, navigate to Application configurations and click New configuration. Give your configuration a name, then build the flow using the visual builder. Every flow begins with a Start node and ends with a Completion node. To add a step, click the add (+) button beneath a node and choose a step type. Steps run from top to bottom in the order they appear. You can reorder a step using Move up and Move down, or remove it with Remove. Select any step to edit its settings in the panel on the right. When you are happy with the flow, you can either:
  • Save draft: Save your progress without making the configuration available for use. Draft configurations are labelled Draft.
  • Publish: Make the configuration available to use on new applications. Published configurations are labelled Active.

Managing configurations

Open a configuration from the Application configurations page to see its steps and every application that uses it. From here you can:
  • Edit flow: Reopen the builder to change the name, steps, or step settings.
  • Deactivate: Stop the configuration being offered on new applications. Applications already using it are unaffected.
  • Activate: Make a draft or deactivated configuration available again.
Each application keeps a copy of the steps as they were when it was created. Editing or deactivating a configuration never changes an application that is already in progress, so you can safely improve your flow while onboarding is under way.

Step types

Steps are grouped into three categories.

Core

  • Pre-qualification: Collect and assess applicant details, such as affordability and eligibility, before the application progresses.
  • Referencing: Require a tenant reference. You can have the reference created automatically with one of your integrated referencing providers.
  • Verification: Run an identity verification check on the applicant.
  • Network check: Look up what other accounts have reported for each applicant. Anything found is shown as a risk signal on the customer. Place this step after Verification so the check runs against a verified identity.
  • Contract: Generate and collect a signed tenancy contract.
  • Completion: The final step. Every flow ends here, and it controls what happens once onboarding finishes.
Network check requires a Guardrails plan, and each applicant checked counts as one billable check. A check stays valid for twelve months, so checking the same person again within that time is not charged.

Payments

  • Holding fee: Collect a holding deposit to secure the tenancy.
  • Deposit: Collect the security deposit.
  • Advance rent: Collect the move-in payment.
  • Partial payment: Collect a portion of the rent upfront as a credit towards future invoices.
  • Payment method: Set up rent collection, either Charge automatically or Send invoice.

Tools

  • Branching: Split the flow based on conditions.
  • Waitpoint: Pause the flow until you are ready to continue. Give each waitpoint a descriptive name so it is easy to identify.
Waitpoint is the only step that can be used more than once in a flow. Every other step type can be added once, and every flow ends with a single Completion step.

Step settings

Select a step to configure it. The available settings depend on the step type.

Completion

  • Completion behaviour: Automatic completes the application as soon as this step is reached. Manual requires you to approve completion.
  • Tenancy behaviour: Roll periodically keeps the tenancy running after the initial term ends, and Complete ends it at the end of the term.
  • Credit note: How to credit the previous tenancy when the application is a revision. Choose No credit note, Credit outside of Yorlet, or Credit to customer balance.

Contract

  • Allowed contract templates: Restrict which contract templates can be used at this step. Leave this empty to allow all of them.
  • Owner signature required: Require the owner’s signature when the contract is signed.
  • Owner email notification: Email the owner once the contract has been signed.
  • Break clause: Pre-fill the break clause terms for contracts generated at this step.

Referencing

  • Automatic referencing: Enable to create references automatically when the application reaches this step.
  • Provider: The referencing provider to use for automatic checks — Let Alliance, Homelet, Canopy, or Advance Rent.

Payment method

  • Rent collection method: Charge automatically collects a rent payment method and charges invoices automatically. Send invoice sends invoices to your customers for manual payment.

Waitpoint

  • Waitpoint name: A descriptive name so you can identify this pause in the flow. The name is shown as the application’s status while it is waiting.

Using a configuration on an application

When you create an application, you select a published configuration first — the rest of the form appears once you have chosen one. Several of the configuration’s settings then pre-fill the application, including the contract template, owner signature options, rent collection method, and end of tenancy behaviour. See Create an application. Once the application is live, it moves through your steps as your customers complete them, and you can move it along manually with the Progress action. See Manage an application for progressing, skipping, and reverting steps.