Onboarding Builder


The Onboarding Builder is the place where templates for the client's onboarding can be created. This builder is intuitive and does not require any code for the client to change its settings and customize each of the steps that the end user will go through according to their visual identity and business needs.

In Trust Platform, there is a dedicated menu for it, and that's what we'll discuss below.

Creating an Onboarding Template

The first step to create a template is to access the Onboarding Builder screen. To do this, simply click on the "Onboarding Builder" menu in the sidebar, and when directed to the screen where the templates are already created, if you don't have any yet or want to create a new one, click the "Create Template" button.

When the creation modal appears, follow these steps:

  1. Select the desired language.

  2. Define the template model (whether it's for Person, Company, or Face Authenticator).

  3. Finally, choose a theme.

After making these decisions, the user will be directed to the template editing/configuration screen.

Note: for the Face Authenticator service, it's necessary to create an exclusive template for it in the Builder, hence the model option.

Important: in the Global flow, there is currently no possibility to create a Face Authenticator Template.

Appearance menu

When you enter the template editing section, you'll find the first customization step, which is "Appearance". In this menu, clients can adapt their visual identity, including:

  1. Font: you can choose from all the fonts available on Google Fonts.

  2. Background: this relates to the background of the Onboarding, which can be a solid color or an image.

  3. Colors: you can automatically change colors.

  4. Texts and Images: it's possible to alter titles, subtitles, button text, error messages, and the images for each step of the chosen workflow.

Remember to click "Save" whenever changes are made.

Flow menu

The second menu available in the Onboarding Builder is the "Flow" section, where you can create and modify flows according to your business needs. To do this, simply click on the second icon on the left side of the screen.

By default, there is a standard suggestion flow already presented, but clients can change it or use it as a guide, adding new steps, for example. It's important to note that the order of some steps in the suggested flow can be changed, but there are also validation rules to assist users in making customizations without creating a flow with issues. For example, the permission to access the camera should not come after capturing the document logically, so we provide these validations.

To add a new step, simply click on a box and drag it to the center of the screen, connecting it to an arrow from an existing flow and step. To delete a step, click on the three dots above it and press delete. It's also possible to view the step as a whole, see what texts and colors it has, and even duplicate it.

Settings menu

The third menu in the Builder is the "Settings" menu, where you have:

  1. Properties: this includes the favicon, template title, and description.

  2. General: here you can configure:

    • Email Template: customize the message sent to the end user in accordance with the partner's visual identity, built in HTML.

    • Domain: customize the onboarding link, providing more user trust in the process.

    • Help Button: specify the URL for a help center that the user will be redirected to if they click the button.

    • Just Mobile: you can encourage users to complete onboarding on a mobile device by displaying a QR code on the desktop interface that redirects the user to a mobile device.

    • Capture Data from the Acceptance Terms: to comply with LGPD, you capture certain information such as the date and time of acceptance, user IP, and browser details.

    • Browser Compatibility Warning: you can activate a modal/pop-up warning for users to complete their onboarding using one of the three browsers guaranteed to be 100% compatible: Chrome, Firefox, and Safari. The onboarding also works in other browsers but may not support certain specific components.

    • Reload data: you can enable data saving so that if a user hasn't completed their onboarding and returns to it, they won't need to re-enter the data they've already filled out, making the process faster.

  3. Link Resend: configure intervals for resending links when the link status is pending.

  4. Variables: a variable is used to store a value that can be modified during the onboarding process. Variables can be used at different stages and moments throughout the process. Some default variables cannot be modified, for example: the personCpf variable cannot be changed when the onboarding link is associated with a CPF.

  5. Accessibility Options: these options include:

    • High Contrast: a dark background with white text is more visually appealing and improves legibility.

    • Increase All Fonts: all fonts are displayed in bold for easier reading.

    • Monochromatic Mode: a single color scheme improves readability for individuals with color vision deficiencies.

Template listing

On the initial screen of the Onboarding Builder, you will see a list of all the templates created in your account. From here, you can click on a template to go to the editing screen or click on the three dots (...) and choose from the following options:

  • Properties: this allows you to configure the favicon, template title, and description.

  • Import/Export: useful for testing a template in a staging environment and then moving it to a production environment after testing.

  • Duplicate: it's useful when you want to reuse customizations made to a template.

  • Delete: used to discard a created template.

  • Design: this option takes you to the template customization section.

How an Onboarding Template is used

Once created, a template can be linked to a processing flow and when an onboarding link is created with this template, the end user will go through each step configured in the Onboarding Builder, filling in to finalize their onboarding.

To learn how to create an onboardin link, visit: Onboarding List.

And if you want to remember how to link an onboarding template to a Query Templates and/or Workflow Builder access the links.

Last updated


2023 © Caf. - All rights reserved