About this template
Comply with your regulatory requirements by requiring your customers to provide information about their businesses as part of your onboarding flow.
This "KYB onboarding" template includes the following:
- An initial form step requires the user to input the company's legal name, location, and incorporation year, along with a description of its services.
- A flow that updates the user’s profile to include the collected company details.
How to configure this template
Visit the Auth0 Dashboard and then open the Forms Dashboard by clicking the Actions > Forms option from the sidebar. Once there, click the "Create form" button.
You have two options for creating this form: you can use a template or import a JSON file.
Use a template
- Click the "Use a template" option in the "Create form" modal.
- Click the "KYB Onboarding" template.
- Click the "Continue" button to customize the template to fit your use case.
Import a JSON file
- Download the template JSON file.
- Click the link to import a JSON file at the bottom of the "Create form" modal.
- Either drag and drop the JSON file you downloaded or browse to its location and upload it.
- Provide a name to your form and its flow if the default values are not fitting.
- Click the "Continue" button to customize the template to fit your use case.
How to use this form
You can render a form with an Action using the api.prompt.render()
method, which takes the form ID as an argument.
There are different ways in which you can find your form ID:
- On the Forms Dashboard home page, you can see a list of your existing forms. Each entry includes a "Title" and "Form ID" field, which you can copy.
- If you are using the Form Editor in the Forms Dashboard:
- Click the "Render" tab to see the sample code that contains the
FORM_ID
value. - Alternatively, you can inspect the URL which follows this pattern:
- Click the "Render" tab to see the sample code that contains the
https://forms.auth0.com/tenants/<REGION>/<TENANT>/forms/<FORM_ID>/render
Once you have located your Form ID, copy and paste it in the following field so that any code snippet that uses such value updates to reflect it:
It's best to render the "KYB Onboarding" form during the login flow. As such, you need to create a Login Action to render it by following these steps:
- Visit the "Flows" section of the Auth0 Dashboard and select the "Login" flow.
- Locate the "Add Action" panel in the "Login" flow board and click the + icon button.
- Select the "Build from scratch" option.
- Provide a name to your Action and click the "Create" button.
KYB Onboarding
- Replace the default code in the Actions editor with the following code:
- Note: Ensure that you replace the
AUTH0_FORM_ID
placeholder with your form ID.
- Note: Ensure that you replace the
/*** @param {Event} event - Details about the user and the context in which they are logging in.* @param {PostLoginAPI} api - Interface whose methods can be used to change the behavior of the login.*/exports.onExecutePostLogin = async (event, api) => {const FORM_ID = 'AUTH0_FORM_ID';if (!event.user.user_metadata.company_legal_name) {api.prompt.render(FORM_ID);}}/*** @param {Event} event - Details about the user and the context in which they are logging in.* @param {PostLoginAPI} api - Interface whose methods can be used to change the behavior of the login.*/exports.onContinuePostLogin = async (event, api) => {}
- Click the "Deploy" button.
- Next, click on the "Add to flow" link in the toast message that comes up, or click on the "Back to flow" link to return to the "Login" flow board.
- Locate the "Add Action" panel in the "Login" flow board, click the Custom tab, and drag-and-drop the "KYB Onboarding" Action between the "Start" and "Complete" states in the board.
- Finally, click the "Apply" button in the top-right corner.
Now, when any user attempts to log in and their event.user.app_metadata
object does not have a company_legal_name
property defined, this Action will render your "KYB Onboarding" form and require the user to provide all that company information before they can complete their login flow. Additionally, you could check if the event.user.app_metadata
object contains all other properties related to company information.