Video Selfie Module

The Video Selfie module runs selfie, ID, and optional voice-consent capture as one continuous camera session, recorded on-device and uploaded alongside the captures. The camera switches between front and rear while a single composited recording follows it, so the user sees one uninterrupted experience instead of a sequence of separate capture screens.

This module combines camera-capture and composite / orchestrator traits: it owns several capture steps and drives its own step progression.

Tag

<incode-video-selfie> is a standard Web Component. Importing the UI subpath registers the custom element; importing the CSS applies the module's styles.

import '@incodetech/web/video-selfie';
import '@incodetech/web/video-selfie/styles.css';

Properties

Configuration

VideoSelfieConfig mirrors the backend VIDEO_ONBOARDING workflow module, so inside <incode-flow> or <incode-workflow> the orchestrator supplies it from Dashboard. Standalone integrators set it on config directly.

config.steps can explicitly select and order the capture steps. When absent or empty, the SDK derives the order from options such as checkIdScan and checkVoiceConsent.

Pass Dashboard-provided quality-check settings through unmodified. The recording duration limit applies to the active recording, including capture steps.

Steps

VideoSelfieStep is the set of capture steps a session can run, in flow order:

For example, steps: ['selfie', 'frontId', 'backId'] keeps that order. A nonempty top-level steps option on createVideoSelfieRecordingManager takes precedence over config.steps. If both are absent or empty, the derived order is ID sides, optional proof of address, Selfie, then configured questions and speech.

State machine

VideoSelfieRecordingState carries a status plus live step and detection detail:

State properties:

API methods

Plus the universal lifecycle: subscribe, getState, stop.

Terminal errors

maxVideoLengthReached means the configured recording duration has elapsed. Do not offer retry. The SDK completes the recorded upload, briefly displays the limit message, then reaches finished so Flow can advance.

validationAttemptsExhausted means the allowed validation attempts have ended. Do not retry or restart that attempt in place. A standalone component reports it through onError with moduleErrorCode: 'VIDEO_SELFIE_VALIDATION_ATTEMPTS_EXHAUSTED'. Flow handles that terminal module outcome by advancing the configured journey; it is not a successful verification result.

Headless hosts should branch on errorKind, preserve session-result handling, and stop the manager when leaving the surface.

Headless usage

import { setup } from '@incodetech/core';
import { createVideoSelfieRecordingManager } from '@incodetech/core/video-selfie';

await setup({ apiURL, token });

const manager = createVideoSelfieRecordingManager({ config });

manager.subscribe((state) => {
  if (state.status === 'recording') {
    renderPreview(state.stream, {
      step: state.step,
      guidance: state.detectionStatus,
      attemptsLeft: state.attemptsRemaining,
    });
  }
  if (state.status === 'finished') {
    onDone(state.recordingId);
  }
});

manager.start();

Render state.stream as the preview, not state.composite — the composite exists to keep one continuous recording across camera switches.

Creating the manager starts its required WASM warmup. manager.start() waits for that warmup before it acquires the camera, and reports a retryable technical error if warmup fails.

@incodetech/core/video-selfie also exports helpers for building your own capture screen: resolveVideoSelfieSteps (which steps a config runs), facingModeForStep, createVideoSelfieCameraWarmer (warm the camera before the user reaches the step), getVideoSelfieQuestions and getVoiceConsentPhrase (consent copy), and createConsentRecorder.

App background recovery

When the browser moves to the background, the module pauses recording and capture validation. The open upload and completed video chunks remain unchanged.

When the browser returns, the module waits for a new camera frame before it resumes recording. The module acquires the video camera again if necessary.

If the audio track or recorder cannot recover, the module reports a technical error. The user can retry with a new recording.

The module does not complete a recording with a frozen background interval.

WASM requirement

The resolved steps determine pipelines: selfie needs videoSelfie; frontId or backId needs videoSelfieId. This also applies to explicit step lists. The Core recording manager automatically loads exactly what its config needs. You can still call warmupVideoSelfieWasm(config, steps) earlier for explicit preloading, or derive the list with videoSelfieWasmPipelines(config, steps) and pass it to setup({ wasm: { pipelines } }).

See also

• Module Patterns → camera-capture
• WASM Configuration
• Module: Selfie: the single-step selfie capture module
• Individual Modules