For the complete documentation index, see llms.txt. This page is also available as Markdown.

Selphi Configuration

Possible configuration parameters

livenessMode

Sets the capture mode of the component. Possible values are:

  • SelphiFaceLivenessMode.NONE: Indicates that photo detection mode should not be enabled in authentication processes.

  • SelphiFaceLivenessMode.PASSIVE: Indicates that the passive liveness check is performed on the server, sending the corresponding "BestImage" for that purpose.

  • SelphiFaceLivenessMode.MOVE: Indicates that the liveness test is active, showing some instructions during capture, and returning the corresponding result of the process.

debug

Enables the component debug mode.

resourcesPath

Indicates the name of the component's resources in zip format. Example: “resources-selphi-2-0.zip“.

This name will be used to look for the file at the path of assets.

cropPercent

Allows you to modify the percentage of face cropping. The higher the number, the greater the rectangle crop relative to the face.

cropImageDebug

Allows debug mode to check the face cropping percentage.

showResultAfterCapture

Indicates whether or not to display a screen with the captured image after the analysis process. On this screen, the user is given the option to repeat the capture process if the image obtained was not correct.

showTutorial

Indicates whether the widget activates the tutorial screen. This view explains intuitively how the capture is performed.

livenessMode

Sets the widget liveness mode. Allowed values are:

  • SelphiFaceLivenessMode.NONE: Indicates that photo detection mode should not be activated in authentication processes.

  • SelphiFaceLivenessMode.PASSIVE: Indicates that the passive liveness check is performed on the server, sending the corresponding “BestImage” or “TemplateRaw” for this purpose.

  • SelphiFaceLivenessMode.MOVE: Indicates that the liveness test is active, showing some instructions during capture, and returning the corresponding result of the process.

stabilizationMode

Sets a stabilization mode prior to any authentication process in the widget. With this mode, the widget is forced not to start any process if the user is not centered, looking straight ahead, and not moving their head.

cameraFlashEnabled

Indicates whether the device camera flash is enabled.

locale

Forces the widget to use the language configuration indicated by the locale parameter. This parameter accepts either a language code (e.g., ‘en’) or a regional identification code (e.g., ‘en_US’). If the widget resources file does not have a localization for the selected ‘locale’, its configuration will use the default language.

fullscreen

Indicates whether the view will have priority to be displayed in full screen, if the system allows it.

templateRawOptimized

Indicates whether or not the template (templateRaw) generated after the selfie should be optimized.

qrMode

Boolean indicating whether QR reading should be enabled or not prior to the authentication process.

videoFilename

Sets the absolute path of the file name where a video of the capture process will be recorded. The application is responsible for requesting the necessary permissions from the phone in case that path requires additional permissions. By default, the widget will not perform any recording process unless a file path is specified through this method.

viewsContent

This advanced property allows the widget views to be configured using a string in xml format.

Note: This property does not alter the contents of the resources file.

showDiagnostic

Show diagnostic screens at the end of the process

logImages

When enabled, a list is returned with the 5 best images taken of the user

showPreviousTip

Displays a screen before starting the capture with information about the process to be carried out and a button to start it.

extractionDuration

Duration of the facial extraction process. Possible values:

  • SelphiExtractionDuration.SHORT

  • SelphiExtractionDuration.MEDIUM

  • SelphiExtractionDuration.LONG

cameraPreferred

Camera to be used for the process: FRONT, BACK

vibrationEnabled

Indicates whether vibration feedback is desired when the process ends.

moveSuccessfulAttempts

Number of retries for correct capture in the movement process (Default 1)

moveFailedAttempts

Number of retries for incorrect capture in the movement process (Default 2)

Last updated