Skip to content

Workflow

A Workflow is a configured sequence of technologies that a user completes during a single verification. For example, a basic KYC flow can consist of Liveness, Document Recognition, and Face2Face.

Each Workflow run creates a separate session. The session associates a specific user's actions, technology results, and metadata passed when the session starts.

Even a single technology runs through a Workflow

If a verification requires only one technology, you must still create a Workflow containing that technology.

General integration flow

flowchart LR
    A[Configure Workflow] --> B[Create session]
    B --> C{Integration method}
    C --> D[Remote]
    C --> E[Widget]
    C --> F[WebView]
    D --> G[User completes verification]
    E --> G
    F --> G
    G --> H[Webhook or completion event]
    H --> I[Retrieve result]
    I --> J{Verification outcome}
    J -->|Success| K[Continue business process]
    J -->|Failure| L[Handle failure_reason]
    I --> M[Create or update person]
  1. Configure a Workflow in the dashboard.
  2. Create a new session on the client system backend.
  3. Pass the session_id to the user through the selected integration method.
  4. Wait for verification to finish.
  5. Retrieve the result on the backend and make a business decision.

Create a Workflow

Open the Workflow creation page in the dashboard, enter a name, and add the required technologies.

The technology order determines the verification sequence. For example:

  1. Liveness checks that a live person is in front of the camera.
  2. Document Recognition recognizes and verifies the document.
  3. Face2Face compares the user's face with the photo from the document.

Only technologies enabled for your organization are available in the production environment.

Workflow API KEY

After you create a Workflow, its API KEY is available in the dashboard. This key is used to create sessions and retrieve results.

Keep the API KEY on the backend

The API KEY grants access to the Workflow and its session results. Do not pass it to the browser or mobile application, or include it in public URLs, client-side logs, or analytics systems.

Keep the mapping between business scenarios and their API KEY values in secure backend configuration. The frontend or mobile application should receive only a session_id or a ready-to-use verification URL.

Modify a Workflow

Changing the technology set or order affects new Workflow sessions. If the backend expects specific result blocks, coordinate the Workflow change with an update to the client system.

Use a separate Workflow for each independent verification contract, such as customer registration, repeat identification, or document signing.

Next steps