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

Selphi Configuration

Possible configuration parameters

livenessMode

Sets the component's capture mode. Possible values are:

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

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

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

debug

Activates the component's debug mode.

resourcesPath

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

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

cropPercent

Allows you to modify the face crop percentage. The higher the number, the greater the rectangle will be cropped relative to the face.

cropImageDebug

Allows debug mode to check the face crop percentage.

showResultAfterCapture

Indicates whether to show 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 is not correct.

showTutorial

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

livenessMode

Sets the widget's 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 that purpose.

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

stabilizationMode

Sets a stabilization mode before any authentication process in the widget. With this mode, the widget is prevented from starting any process unless the user is facing forward, looking ahead, and keeping their head still.

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 both a language code (e.g. ‘en’) and a regional identifier code (e.g. ‘en_US’). If the widget resources file does not have a localization for the selected ‘locale’, its configuration will fall back to the default language.

fullscreen

Indicates whether the view will have priority to be shown fullscreen, if the system allows it.

templateRawOptimized

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

qrMode

Boolean indicating whether QR reading should be enabled before the authentication process.

videoFilename

Sets the absolute path of the filename in which 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 via an XML-formatted string.

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 with the 5 best images captured from the user is returned

showPreviousTip

Shows a screen before capture launch with information about the process to be performed and a launch button.

extractionDuration

Duration of the facial extraction process. Possible values:

  • SelphiExtractionDuration.SHORT

  • SelphiExtractionDuration.MEDIUM

  • SelphiExtractionDuration.LONG

cameraPreferred

Camera with which the process should be carried out: FRONT, BACK

vibrationEnabled

Indicates whether vibration feedback is desired when the process finishes.

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