Constructor Detail

• FaceAuthentication.Builder

  FaceAuthentication.Builder()

Method Detail

• setShowTutorials

   final FaceAuthentication.Builder setShowTutorials(Boolean showTutorials)

  Show tutorials how to capture selfie before the actual scan. Default value is true.

  Returns:

  Builder

• setAutoCaptureTimeout

   final FaceAuthentication.Builder setAutoCaptureTimeout(Integer autoCaptureTimeout)

  Sets the selfie auto capture timeout in seconds.

  Parameters:

  autoCaptureTimeout - Auto capture timeout value.

  Returns:

  Builder

• setCaptureAttempts

   final FaceAuthentication.Builder setCaptureAttempts(Integer captureAttempts)

  Sets the selfie capture attempts.

  Parameters:

  captureAttempts - Capture attempts value.

  Returns:

  Builder

• setEyesClosedCheckEnabled

   final FaceAuthentication.Builder setEyesClosedCheckEnabled(Boolean eyesClosedCheckEnabled)

  Enables/disables eyes closed check. Default value is enabled. If enabled:

  • In auto capture mode, all frames where closed eyes are detected are filtered out and not used for further processing.

  • In manual capture mode, photos where closed eyes are detected are processed but the results are marked for additional review.

  Parameters:

  eyesClosedCheckEnabled - Boolean to indicate if the eyes closed check should be performed.

  Returns:

  Builder

• setHeadCoverCheckEnabled

   final FaceAuthentication.Builder setHeadCoverCheckEnabled(Boolean headCoverCheckEnabled)

  Enables/disables head cover check. Default value is enabled. If enabled:

  • In auto capture mode, all frames where head cover is detected are filtered out and not used for further processing.

  • In manual capture mode, photos where head cover is detected are processed but the results are marked for additional review.

  Parameters:

  headCoverCheckEnabled - Boolean to indicate if the head cover check should be performed.

  Returns:

  Builder

• setLensesCheckEnabled

   final FaceAuthentication.Builder setLensesCheckEnabled(Boolean lensesCheckEnabled)

  Enables/disables lenses check. Default value is enabled. If enabled:

  • In auto capture mode, all frames where lenses are detected are filtered out and not used for further processing.

  • In manual capture mode, photos where lenses are detected are processed but the results are marked for additional review.

  Parameters:

  lensesCheckEnabled - Boolean to indicate if the lenses check should be performed.

  Returns:

  Builder

• setMaskCheckEnabled

   final FaceAuthentication.Builder setMaskCheckEnabled(Boolean maskCheckEnabled)

  Specify true to enable local face mask check detection during face capture. Default value is true. If disabled, the Face Mask Check is performed on the server.

  Parameters:

  maskCheckEnabled - Boolean to indicate if the mask check should be performed.

  Returns:

  Builder

• setFaceOcclusionEnabled

   final FaceAuthentication.Builder setFaceOcclusionEnabled(Boolean faceOcclusionEnabled)

  Specify true to enable face occlusion check during face authentication.

  Make sure you have included the com.incode.sdk:model-face-occlusion:x.y.z dependency in your [module]/build.gradle, otherwise a com.incode.welcome_sdk.commons.exceptions.MissingModelFaceOcclusionDependencyException is thrown when this feature is enabled.

  Parameters:

  faceOcclusionEnabled - Set to true to enable face occlusion check, false otherwise; Default value is false.

  Returns:

  Builder Returns the updated Builder object with the face occlusion check configuration.

  Since:

  5.47.0

• setFaceOcclusionSeverity

   final FaceAuthentication.Builder setFaceOcclusionSeverity(SeverityLevel level)

  Sets the severity for the face occlusion check during face authentication.

  Lower severity is more restrictive (flags partial occlusion such as a finger over the chin), while higher severity only flags heavily occluded frames. Default value is SeverityLevel.LOW.

  Make sure you have included the com.incode.sdk:model-face-occlusion:x.y.z dependency in your [module]/build.gradle, otherwise a com.incode.welcome_sdk.commons.exceptions.MissingModelFaceOcclusionDependencyException is thrown when this feature is enabled.

  Note: This setting is ignored if setFaceOcclusionEnabled is false.

  Parameters:

  level - Face occlusion severity (SeverityLevel.LOW, SeverityLevel.MEDIUM, or SeverityLevel.HIGH).

  Returns:

  Builder

  Since:

  5.47.0

• setImageQualityCheckSeverity

   final FaceAuthentication.Builder setImageQualityCheckSeverity(SeverityLevel level)

  Sets how strict the image quality check is during face authentication capture.

  Higher values are more restrictive and require better capture conditions before frames are accepted, while lower values are more permissive. Default value is SeverityLevel.ULTRA_LOW.

  Parameters:

  level - Image quality checks severity (SeverityLevel.ULTRA_LOW, SeverityLevel.LOW, SeverityLevel.MEDIUM, SeverityLevel.HIGH, or SeverityLevel.ULTRA_HIGH).

  Returns:

  Builder

  Since:

  5.45.0

• build

   final FaceAuthentication build()