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.
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 set the step to create an Automatic reference with one of your integrated referencing providers.
- Verification: Run an identity verification check on the applicant.
- Contract: Generate and collect a signed tenancy contract.
- Completion: The final step. Every flow ends here, and it controls what happens once onboarding finishes.
Payments
- Holding fee: Collect a holding deposit to secure the tenancy.
- Deposit: Collect the security deposit.
- Advance rent: Collect rent in advance.
- 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.
Some step types can only be added once per flow (for example, Contract, Deposit, and Payment method).
Step settings
Select a step to configure it. The available settings depend on the step type.- Completion: Choose the Completion behaviour (Automatic completes the application as soon as this step is reached, Manual requires you to approve completion), the Tenancy behaviour (Roll periodically or Complete at the end of the term), and an optional Credit note behaviour.
- Contract: Restrict which contract templates can be used, require an Owner signature, send an Owner email notification when the contract is signed, and pre-fill a Break clause.
- Referencing: Enable Automatic referencing and choose the Provider.
- Payment method: Choose the Rent collection method.
- Waitpoint: Set a Waitpoint name.
Using a configuration on an application
When creating an application, you can select a published configuration to run. The application then follows your configured steps rather than the standard flow. See Create an application to get started.Progressing an application
Applications that follow a configuration move through your steps as your customer completes them. You can also move an application along manually from the application page using the Progress action. Depending on the current step, you can:- Progress the application to the next step.
- Skip current step and move straight to the next step.
- Complete the application when it reaches the completion step.