Capture App Flow Setup

Create and configure a flow that controls how the Capture App collects ID, document, and selfie images for Document Verification (DocV). This page explains both flow-level configuration and per-transaction overrides.

How it works

RiskOS™ supports two types of configuration for Capture App flows:

Flow configuration

1. Create or edit a flow

   In the RiskOS™ Dashboard, navigate to Settings > DocV App > Flow. You can create a new flow using + Add Flow or duplicate an existing one by opening its three-dot menu and selecting Clone.

   
   

   Note: You can create multiple flows to support different verification paths (e.g., onboarding vs. step-up verification). Flow names should clearly indicate their purpose so your systems can route users correctly.
   
   A maximum of 12 flows is supported per environment. Contact your Account Manager if you require more.

   

2. Configure flow options

   When creating or editing a Capture App flow, configure the options below to define how the flow behaves. These settings determine which document types users can submit, whether a selfie is required, and how long their session link remains valid.
   
   

   Core options

   Feature	Description
   Flow Name	Display name for the flow.
   Set as Default Flow	Makes this the default flow in the current environment.
   Skip Splash Screen	Starts Capture App flow without the splash/intro screen.
   Document Type	Accept license only, or license + passport. If set to license-only, the user skips document type selection.
   Selfie Capture	Enable/disable selfie capture (availability depends on integration/version).
   Enable Selfie Auto-Capture UI	Enables the updated selfie UI with automatic capture. Native SDKs fall back to the standard frame if unsupported.
   Link Validity	The allowed time window (minutes/hours/days) for a user to start the capture session after the link is issued. Default is 1 day.

   

3. Save the flow

   Click Create to apply the configuration in the current environment.

   
   

   Note: For redirect, logos, colors, fonts, and text, see Customization, Branding & Copy. These settings must be configured in Sandbox and then published to Production.

Per-transaction configuration via the Evaluation API

You can override certain flow behaviors for a single transaction by including fields under data.individual.docv.config in your request to the /api/evaluation endpoint. These overrides let you adjust document requirements, flow routing, language, SMS delivery, and redirect behavior without modifying your environment-level flow configuration.

Use these options when you need dynamic, one-off adjustments that differ from the default Capture App flow your environment is configured to use.

Common overrides

Example request

The example below shows a typical Evaluation API request with several per-transaction overrides applied.

{
  "id": "APP-123456",
  "timestamp": "2025-07-31T15:00:10.761Z",
  "workflow": "consumer_onboarding",
  "data": {
    "individual": {
      "given_name": "John",
      "family_name": "Smith",
      "date_of_birth": "1989-05-07",
      "phone_number": "+19998887777",
      "address": {
        "line_1": "1234 N College Ave",
        "locality": "New York City",
        "major_admin_division": "NY",
        "country": "US",
        "postal_code": "10001"
      },
      "docv": {
        "config": {
          "document_type": "license",
          "send_message": true,
          "language": "en-us",
          "redirect": {
            "method": "POST",
            "url": "https://example.com/docv"
          }
        }
      }
    }
  }
}

config fields