Get started with Workflow Builder
Use Workflow Builder to set up verification steps no-code.
Build custom verification logic with no-code and integrate with Sumsub easily:
- Navigate to Workflow Builder and go to the Draft view to edit the flow.
- Add level steps, build conditions, set up review steps, and configure actions according to your needs.
- Create multiple versions of your flow and test them.
- Publish your flow to make it available in production.
- Set up WebSDK or MobileSDK integration that will handle the whole verification process.
- Review verification results.
Note
While setting up an applicant workflow, avoid using the same verification level twice. Instead, to prevent your verification logic from conflicts, create separate flows.
Add level step
A level node always goes first and is always required to start your workflow, as it will be responsible for initiating a process of collecting information about your applicants. Without this node, the verification flow will not run.
You can map a level node to any verification level that obtains necessary information about your applicants, such as, for example:
- Country/State
- Age
- Gender
- IP address
- Data from applicant documents
- Data from Questionnaire
- Metadata
- Other details: high-risk applicants, large transactions
- Internal fraud score results
- External databases results
- Company type
To add a level node:
- Set up a verification level.
- Right-click anywhere on the canvas and select Level step.
- Specify the name of the node and select a level that you have configured at step 1.
- Click Choose next level to continue building your flow by adding such nodes as Level step, Condition, Action, and Terminal step.
Important
All verification levels must use the same WebSDK version.
Build conditions
A conditional node is an optional node directing applicants further down the flow, depending on the specified criteria.
For example, you may want to ask applicants from USA and Canada to go through identity verification and by that check, you obtain information about their age, country, and so on. Then you decide to decline applicants whose age is less than 16 and for the rest cases, you need to additionally direct applicants to different checks, depending on their country.
To set up a conditional node:
- Select whether to approve or reject applicants.
- Set up a logical condition
IF
,IF NOT
,OR
,OR NOT
,IS IN
, andEQUALS
and add necessary values in accordance with your scenario. For example, you can use blocklists to form a list of suspicious applicants and auto-reject each of them by defining a condition. - Add a new conditional branch for another group of applicants, depending on the obtained information.
- For every branch, proceed with the next step, which can be: Level step, Action, Terminal step.
Tip
You can use regular expressions to check if a field matches certain conditions. There are some of the expressions that might be useful:
.*[0-9].*
and.*\d.*
allow you to define whether a field contains a single digit number, e.g.5
..*\d+.*
should be used to check if a field contains only digits—123456
, but not12345a
.When using expressions, ensure the following conditions:
- Use the expressions for matching fields (the 'contains' logic) in the
.*\example.*
format. The\example
expression does not cover the entire field.- Code the
\
symbol as\\
.
Note
IS IN
andEQUALS
conditions are both used for comparison. The first one is used for comparing entities, such as client lists, and the second one — for comparing specific values.
Set up review steps
You can use the review step node to send applicants for manual review or block them automatically—for example, due to non-compliant personal data—with the final rejection decision. Applicants who got a final rejection will not be allowed to even upload documents.
To set up a review step node:
- Select the type of the node, which can be Final reject or Manual review.
- Specify the corresponding assignment:
- For the final review, choose from the list of rejection labels as necessary.
- In case of manual review, applicants are automatically assigned the Requires action status and queued for manual processing by compliance officers. You can also use this functionality to create Queues. Then you will also need to specify the tag you want to add to the applicant when configuring action.
Configure actions
An action node adds certain information to applicant profiles for further filtering.
To set up an action node:
- Add an action type that you want to be performed. You can set the following:
- Tag — to assign a tag (or several tags) to the applicant.
- Note — to leave a note in the applicant profile.
- Source key — to add or delete applicant source key and change their level accordingly.
- Proceed with the next step if necessary or leave as it is for defining the end of the flow.
Review flow history
Every time you make changes to your flow and publish it, the previous state is saved as an archived version, allowing you to revert to any of the available versions at any time.
To see the available versions, in the top-right corner, open the menu and select Version history.
Create multiple versions of your workflow
Before putting your flow into operation, you may want to improve it or create one or several alternatives.
To copy your flow and experiment with changing different steps:
- Click Copy to Test Workflow.
- Switch to the Test Workflow tab.
- Change your flow as needed.
- Click Run flow.
- Click Generate to get the permalink to your flow.
- Pass verification checking every step.
- Click Copy to Active Workflow to replace your previous flow.
- Return to the Active Workflow tab and proceed with publishing your flow.
Publish your flow and go live
When the whole logic is built and tested, don’t forget to save and publish your draft. The created flow will then be shown in the Published view.
To initiate your flow from the Dashboard, click Run and generate a permalink for passing verification in SDK.
Review verification results
Once the check is performed, you will receive an applicantReviewed webhook with the verification status.
You will not receive this webhook until the user finishes the flow (a final rejection in the middle or final approval).
To review results via applicant profiles, go to the Applicants page, select an applicant, and check on Summary, which is a comprehensive report that includes the applicant data, checks results, and uploaded documents.
Updated 1 day ago