Properties
Configuration properties of the SelphID Widget component.
These properties allow you to customize the behavior of the Document Capture Flow.
Constants and typing
SelphID offers types and constants to make implementation easier in typed environments.
import { CameraType, CameraPreferred } from '@facephi/selphid-web-component'In React, the enum CameraPreferred (among others) is 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.
SelphID Widget configuration properties
Capture
allowUncertain: Increases permissiveness for unrecognized documents.
allowUnknown: Allows capturing any document with a photo.
barcode: Enables the barcode and QR reader.
barcodeSide: Side of the document where the code is read.
blurredThreshold: Blur tolerance threshold.
captureRetries: Maximum number of capture retries.
captureTimeout: Capture time limit per attempt (seconds).
country: Document country in ISO-2. Deprecated: use
countryFilter.countryFilter: Allowed countries in ISO-2. Recommended:
enabledCountries.documentType: Document types supported in capture.
expectedSides: Number of document sides to capture.
maxAllowedMismatches: Allowed OCR errors per word.
progressiveMismatches: Increase in permissiveness with each retry.
retryCurrentSide: Retry only the current side of the document.
rules: Rules for filtering capture by country.
Extraction
anonymizationMode: Anonymization mode for extracted data.
capturePadding: Additional margin added to the captured image.
cropFactor: Scaling factor for the document crop.
imageFormat: Format of the returned images.
imageQuality: JPEG compression (0.0–1.0).
tokenize: Enables result tokenization.
Camera
cameraHeight: Preferred camera vertical resolution.
cameraId: Camera identifier.
cameraSwitch: Shows the button to switch cameras.
cameraType: Camera type (front or rear). Recommended:
cameraPreferred.cameraWidth: Preferred camera horizontal resolution.
dpi: DPI of the extracted images.
externalCamera: External video Flow for capture.
Customization
audible: Enables text-to-speech reading.
cameraOverflow: Shows the full camera image as the background.
chooseDocument: Enables prior document selection. Recommended:
showDocumentSelector.disableExit: Hides the widget close button. Recommended:
showExitButton.disableTutorial: Disables access to the tutorial. Recommended:
showTutorial.enableDocumentFlip: Enables the document flip animation.
initialTip: Shows a tip before capture. Recommended:
showPreviousTip.initialTipHeight: Initial tip height in pixels.
initialTipWidth: Initial tip width in pixels.
tipAnimations: Initial tip animations (mobile and desktop).
loadingAnimation: Loading animation path.
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.
engineFallback: Enables the fallback engine.
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 a timer during recording.
videoRecord: Enables Video Recording.
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