Workflow Settings
The Workflows page in the dashboard is where an Administrator authors and edits workflow definitions — visually or as raw JSON — with no code. For the underlying concepts (steps, outcomes, decisions), see Workflow Model; this page covers the editing UI.
The workflow library
The Workflows page lists every workflow available to the tenant:
- Templates — the ready-made workflows shipped with the platform, marked with a Default badge. They are read-only.
- Custom — your own workflows, marked with a Custom badge.
Each row shows the workflow's display name and its identifier. Selecting one enables the actions:
| Action | Applies to | Effect |
|---|---|---|
| Clone | Any workflow | Opens the builder on a new editable copy, pre-filled from the selected workflow. |
| Show | Templates | Opens the template read-only (templates can't be edited in place — clone to change one). |
| Edit | Custom | Opens the workflow in the builder for editing. |
| Delete | Custom | Removes the workflow, after a confirmation dialog. |
The builder
At the top of the builder:
- Workflow name — the human-readable label.
- Workflow ID — the unique identifier (lowercase,
snake_case). Set it when creating; it is fixed once the workflow exists. - UUID — shown when editing an existing workflow; read-only, with a copy button.
- Save and Cancel — Save is enabled only when the definition is valid (see Validation & saving).
A validation banner sits above the tabs and updates as you edit, showing whether the definition is valid and listing any issues.
The builder is organized into four tabs.
Outcomes
Define the named outcomes a workflow can produce and the actions each one triggers.
- Add outcome creates a named outcome; rename it inline.
- Within an outcome, Add action and choose from the action catalog (create a new Customer, merge into an existing one, re-point the primary identity, move to the Blocklist or review, emit an event, …). Add several to run in order.
These are the outcomes a decision step maps to — see Workflow Model → Actions.
Steps
The ordered sequence of capture and evaluation steps.
- Add step, then set its Name and Action (from the step catalog). Drag the handle to reorder — steps renumber automatically. Remove a step with its delete button.
- The parameters shown depend on the chosen action:
| Action | Parameters in the UI |
|---|---|
| Simple capture steps (e.g. face / liveness capture) | None |
mobile_redirect | Skippable toggle |
external_capture | Skippable toggle, plus a data key/value editor for hand-off values (supports template variables such as ${document_capture.document_type}, offered as suggestions) |
Trust-factor evaluation (tf_eval) | Trust Factor configuration to apply, chosen from your Trust Factor profiles; a warning appears if the selected one no longer exists |
document_capture | Capture back page toggle (the accepted documents themselves are set on the Documents tab) |
decision | The decision builder (below) |
Decision builder — for a decision step:
- A Default result: the workflow outcome and the status it terminates in — Accept, Review, Reject, Incomplete, or Continue (fall through to the next step) — used when no rule matches.
- Rules, evaluated first-match-wins. Each rule (expandable) has:
- a When condition built from the results of earlier steps (for example the trust-factor result or a duplicity-check outcome);
- the outcome it produces (from the ones defined on the Outcomes tab);
- the status it terminates in (or continue);
- an optional reason code.
Documents
Restrict which identity documents each document capture step will accept. This tab is organized per document_capture step (if the workflow has none, it prompts you to add one on the Steps tab).
For each step, build a list of allowed document types:
- Add a document type (from the platform's supported types).
- Leave All countries on to accept that type from any country, or turn it off and select the specific countries to allow.
A document presented outside this allow-list prompts the user to try a different one during capture.
JSON
The complete workflow manifest as editable JSON.
- The visual builder and the JSON stay in sync — opening this tab renders the current definition, and editing the JSON updates the other tabs. Invalid JSON is flagged and blocks saving.
- Use it for advanced edits, copy/paste between workflows, or to review the exact manifest. See the Workflow Manifest Reference.
Validation & saving
- The definition is validated continuously, and Save stays disabled until it passes: schema correctness, that every step action, Trust Factor configuration, and referenced outcome resolves, that decision conditions parse, and that every path reaches a valid terminal state.
- Saving a new workflow adds it to your custom workflows; saving an existing one updates it in place. Changes take effect for new sessions only — sessions already running finish on the version they started with (see Custom Workflows).
- Templates cannot be saved over — Clone one to create an editable copy.
Who can edit
Creating, editing, saving, and deleting workflows require the Administrator role. Other roles have read-only access, and templates are read-only for everyone. Workflows are scoped per tenant.
See also
- Workflow Model · Custom Workflows · Predefined Workflows
- Workflow Manifest Reference
- IDV Configuration — Trust Factor profiles referenced by
tf_evalsteps