Create a verification workflow template
A verification workflow template is the blueprint for a verification. Each workflow template lists the checks an applicant goes through, the order they run in, and the per-check configuration. Every verification you start references a workflow template, so when you adjust the workflow template you change every future verification built from it.
Before you start
Section titled “Before you start”You need an active organization and the Owner, Admin, or Manager role to create or edit workflow templates. Members can view workflow templates but cannot author them. Open Dashboard → Workflows to land on the list page.
You can preview the applicant journey live in the editor before you save.
Create a workflow template
Section titled “Create a workflow template”Click New workflow. The page splits into two surfaces:
- AI setup chat at the top. Describe the workflow in plain language (“collect name and date of birth, then run a sanctions screen”); the assistant emits a starter document you can refine. The chat may be unavailable in some regions; you simply fall through to the manual editor.
- Toggle editor and live preview below. Each check is a switch with its own configuration controls when enabled.
Give the workflow template a name and an optional description. The name appears in the verification list and in audit-log entries, so prefer something descriptive (“Standard sanctions screen”) over a code (“v2-final”).
Add checks
Section titled “Add checks”Toggle the checks you want in the workflow template. The editor surfaces seven single-instance check types as toggles: collect_user_info, id_verification, watchlist, background_us_criminal, background_global, esign, and credit_history. custom_form is added separately, in its own multi-instance section below the toggle list, since a workflow template can include more than one custom-form screen. See Choose the right check types for the comparison.
One row is region-dependent. Credit history check is listed on US-region organizations and is not listed at all on an EU-region organization, rather than shown as a switch that cannot be turned on. See Where the check can run.
The order in the editor is the order the applicant experiences. collect_user_info should sit first because the data it captures feeds every downstream check. Applicant-facing checks render screens in the verify journey; server-side checks run automatically once their inputs are available.
Configure thresholds
Section titled “Configure thresholds”Each check exposes the controls that matter for it:
- Watchlist: set the minimum match confidence (50–99%). Lower thresholds catch more hits but produce more false positives that go to manual review.
- Background checks: pick whether to include US-only or global sources. The jurisdiction is implicit in the check type itself.
- Collect user info: the name is always collected, as a family name plus an ordered list of given names, with a generational suffix (Jr., III) captured separately. The suffix is optional for the applicant to enter; it is not a per-template toggle. Email, phone, date of birth, and home address are toggleable; email and phone are on by default. Downstream checks perform better with more contact data, so removing fields is a deliberate tradeoff.
- Credit history: pick the Permissible purpose the report is pulled under, Tenant screening or Employment screening. There is no default and the workflow template will not save until you choose one, because a consumer report pulled under a basis nobody chose is the failure the applicant’s authorization screen exists to prevent. The remaining controls set how much the applicant is asked for: months of address history, whether a national identifier is offered or required, whether previous names are collected and how many, an optional notice of your own alongside the platform’s authorization copy, and what the check lands when the applicant lives outside the countries the check covers. The check also needs the Identity information step earlier in the same workflow template with date of birth turned on. See Credit history for every setting and its default.
- Identity document verification: choose which document types you accept (passport, driver’s license, national ID card, residence permit, visa, work permit; at least one stays selected). The Face match control sets the biometric mode: Off for document only (
none, the default), Selfie photo (selfie), or Active liveness (liveness). The biometric check is optional and the modes are mutually exclusive. See Biometric modes for the comparison.
The live preview re-renders as you change controls so you see the applicant view without leaving the editor.
Add fraud signals (optional)
Section titled “Add fraud signals (optional)”The Fraud signals section lets a workflow watch for suspicious patterns (many verification attempts from one device, networks with a poor reputation, automated behavior, and the like) and surface them to your reviewers. It is off by default and opt-in per workflow. See Add fraud signals to a workflow for the full walkthrough.
Set how long links last
Section titled “Set how long links last”The Applicant links card sets how long the links you send keep working. It also sets how long an applicant can come back to an unfinished verification. Its help text updates as you change a value and always states what a verification created from this workflow template actually gets.
- Allow applicants to request a fresh link. When on, an applicant whose link has stopped working can confirm their email on the expired-link page and get a new one. When off, an applicant cannot get a new link on their own, but your team can still send one and reminders still go out.
- Link lifetime (hours, 1 to 384, default 168, which is 7 days; 384 hours is 16 days). How long each link keeps working after it is issued. Each new link issued later works for this long again. A new link never lasts past the return window.
- Single-use link lifetime (hours, default 72, at most the link lifetime). How long a link in an invite or reminder email, or returned by the regenerate-link API, can be opened for the first time, counted from when it was issued. It never lasts longer than the link lifetime. A longer value is treated as the link lifetime, and the card asks you to lower it.
- Return window (days, default 14). How many days past the first link’s expiry an applicant can still come back. Two limits apply, and no setting can raise them. The window counts at most 14 days past the first link’s expiry. No link works later than 30 days after the verification was created, unless you re-verify the applicant. The end of the return window is the verification’s deadline. For a verification from a reservation in a connected system, the deadline is never set later than the reservation’s due time. A change to the reservation can move it earlier. Only re-verifying the applicant can set a later deadline. No link you send, no reminder and no request from the applicant moves it.
A connected system can hold a reservation’s own link, which belongs to the reservation rather than to one verification. That link follows the connection’s verification timing instead of the windows below. Any other reusable link from a connected system opens the verification directly for the return window, counted from creation, within two bounds. It never opens for less than the link lifetime, or for more than the link lifetime plus 14 days. Once a new link has been issued, the reusable link opens the verification until the deadline too. That new link can come from your team (sent by email, or returned by the API when you ask for a new link for the verification), a reminder that has to send a new link, or the applicant’s own request.
Before a new link is issued, the reusable link stops opening the verification when its window ends. It then opens the expired-link page. Until the deadline, the applicant can ask for a new link there if self-service links are on. After the deadline, no new link can be issued.
| Link lifetime | Return window | Applicants can come back for | Reusable link opens directly for | After a new link is issued | No effect above |
|---|---|---|---|---|---|
| 7 days (default) | 14 (default) | 21 days | 14 days | 21 days | 21 |
| 7 days | 3 | 10 days | 7 days | 10 days | 21 |
| 7 days | 90 | 21 days | 21 days | 21 days | 21 |
| 2 days | 14 | 16 days | 14 days | 16 days | 16 |
| 16 days | 14 | 30 days | 16 days | 30 days | 30 |
The durations count from when the verification was created. See How long links last for how each new link renews the lifetimes.
Publish and version
Section titled “Publish and version”A workflow template has two switches that govern how it is used:
- Active: when on, the workflow template can back new verifications. Turn this off to retire a workflow template without deleting it. A workflow that an integration uses, as its default or in a routing rule, cannot be deactivated or deleted: the editor names the integrations that use it, and you change the workflow in each of them first (or, if you cannot change integrations, ask an organization owner or admin to).
- Default: when on, this workflow template is the one used when you start a verification without naming a workflow template. Only one workflow template per organization can be the default at a time.
Save the workflow template. Saving updates the existing workflow template or creates a new one, then routes you to the edit page.
Use the workflow template
Section titled “Use the workflow template”Once the workflow template is active, reference it by id when you start a verification, or leave the workflow template id off the call and rely on the default. See Start a verification for the request shapes. Every verification built from this workflow template inherits its check list and configuration; workflow templates are not versioned, so edits affect future verifications only. Completed verifications retain the document they were created against.
For terminology, see the Glossary.