Authentication Module
The Authentication module re-authenticates a returning user by capturing a fresh selfie and matching it against their previously stored biometric record. Used
This guide is specific to Web SDK 2.0. If you are still using 1.x, you can find documentation here. We strongly recommend upgrading - contact your Incode Representative for upgrade information.
The Authentication module re-authenticates a returning user by capturing a fresh selfie and matching it against their previously stored biometric record. Used for re-entry into an existing identity (versus the first-time identity verification done by Selfie + Face Match).
Follows the camera-capture pattern. The lifecycle and capture sub-states are identical to Selfie since both use the same underlying face-capture machinery (
BaseFaceCaptureConfig).
Availability
This module is headless-only — there is no public <incode-authentication> web component. Drive it with createAuthenticationManager from @incodetech/core/authentication and use the same UI patterns as Selfie.
Configuration
AuthenticationConfig is the intersection of the dashboard-driven FlowModuleConfig['AUTHENTICATION'] and the shared BaseFaceCaptureConfig:
type AuthenticationConfig = FlowModuleConfig['AUTHENTICATION'] & BaseFaceCaptureConfig;The dashboard fields are similar to Selfie's: showTutorial, autoCaptureTimeout, numberOfAttempts, type (always 'ONE_TO_ONE' for re-auth), deepsightLiveness, plus the validate-* booleans (validateClosedEyes, validateFaceMask, validateHeadCover, validateLenses).
For the full config catalogue see Module: Selfie → Configuration Options — the same fields apply.
| Option | Type | Required | Description |
|---|---|---|---|
onDeviceFaceResultsSubmissionEnabled | boolean | ❌ | Opt-in. When true, face analysis runs entirely on-device via the onDeviceSelfie WASM workflow and only the results are submitted to the server. Video recording is skipped on this path. Requires WASM to be configured at setup(). Leave off to keep the legacy server-side path. |
State machine
AuthenticationState follows the same shape as SelfieState — see Module: Selfie → States Reference for the full list. The states are:
idle, loading, tutorial, permissions, capture, processing, finished, closed, error.
API methods
Identical to the Selfie manager API: load, nextStep, requestPermission, goToLearnMore, back, capture, retryCapture, close, plus the universal lifecycle (subscribe, getState, reset, stop).
See Module: Selfie → API Methods for the full reference.
WASM requirement
Authentication uses the same selfie ML pipeline as the Selfie module. Preload via setup({ wasm: { pipelines: ['selfie'] } }).
See also
- Module: Selfie: first-time identity capture
- Module: Face Match: selfie ↔ ID comparison for first-time verification
- Module: Identity Reuse: different flow for returning-user identification
- Module Patterns → camera-capture
- WASM Configuration
Updated about 6 hours ago