Properties
Configuration properties of the Selphi Widget component.
These properties allow customizing the behavior of the facial pattern capture flow.
Constants and typing
Selphi offers types and constants to facilitate its implementation in typed environments.
import { CameraType, CameraPreferred, LivenessMode } from '@facephi/selphi-web-component'In React, these enums (CameraPreferred and LivenessMode, among others) are also exported from @facephi/sdk-web-react.
Recommendation: Configure the properties using JavaScript, JSX, or your framework bindings (React, Vue, Angular, etc.). Avoid native HTML configuration with attributes (
nombre-atributo="valor"), since it can lose the typing and the format expected by the component.
Selphi Widget configuration properties
Capture
stabilization: Enables face stabilization during capture.
timeout: Timeout in milliseconds to capture the face.
Extraction
cropFactor: Face crop enlargement factor.
imageFormat: Format of images returned by the Widget.
imageQuality: JPEG compression level (0.0–1.0).
logImages: Returns the best images used in the extraction.
templateFormat: Format for generating the Biometric Template.
antispoof: Enables anti-fraud detection (anti-spoofing).
antispoofPayloadSize: Size of the anti-spoofing payload.
Camera
cameraHeight: Preferred camera vertical resolution.
cameraId: Identifier of the camera to use.
cameraSwitch: Shows the button to switch cameras.
cameraType: Camera type (front or rear). Recommended:
cameraPreferred.cameraWidth: Preferred camera horizontal resolution.
externalCamera: External video Flow for capture.
cameraRotation: Rotation applied to the camera image.
Customization
audible: Enables text-to-speech reading.
disableExit: Hides the widget close button. Recommended:
showExitButton.disableTutorial: Disables access to the tutorial. Recommended:
showTutorial.faceTracking: Centers the face before capture.
initialTip: Shows a tip before capture. Recommended:
showPreviousTip.initialTipHeight: Initial tip height in pixels.
initialTipWidth: Initial tip width in pixels.
interactible: Requires user interaction to start.
tipAnimations: Initial tip animations (mobile and desktop).
livenessMode: Widget liveness check mode.
livenessMoveFailedAttempts: Failed attempts allowed in Active Liveness. Recommended:
moveFailedAttempts.livenessMoveSteps: Steps required in Active Liveness. Recommended:
moveSuccessfulAttempts.livenessMoveTimeout: Time per step of Active Liveness (seconds).
loadingAnimation: Path to the custom loading animation.
logo: Path to the custom logo.
previewImage: Shows a preview after capture. Recommended:
showResultAfterCapture.tutorialAnimations: Custom tutorial animations.
tutorialModal: Shows the tutorial in modal mode.
Internal configuration
advancedTracking: Enables advanced Tracking generation.
androidWebViewBehaviour: Behavior in Android WebView.
diagnosticTimer: Online diagnostic time before error.
engineLocation: Path or CDN of the engine resources.
errorTimer: Duration of terminal error views.
settingsStrictness: Shows an error if there are misconfigured parameters.
Video Recording
enableVideoTimer: Shows timer during Video Recording.
videoRecord: Enables Video Recording in the session.
videoRecordAudio: Records audio in the local recording.
videoRecordQuality: Quality of the Video Recording.
videoRecordRate: Frame rate of the remote recording.
videoRecordType: Recording type (local or remote).
Developer tools
Compatibility and property validation
Some properties have been renamed. The legacy name remains the main one and works in this Version, while the new name is the recommended. Resolution rules:
Precedence: if you define both the legacy and the new name, the new wins and a precedence warning is emitted in the console.
Legacy only: using only the legacy name emits a deprecation warning in the console. The legacy name will be removed in the next major Version.
Unknown property: an unrecognized property is silently ignored always.
Validation (settingsStrictness, tolerant by default): in tolerant mode, an invalid value is replaced with its default value and a warning is emitted; in strict mode, it stops the SDK with a blocking error.
Last updated