Package com.incode.welcome_sdk.modules

Class IdScan.Builder

    • Constructor Detail

      • IdScan.Builder

        IdScan.Builder()

    • Method Detail

      • setEnableFrontShownAsBackCheck

         final IdScan.Builder setEnableFrontShownAsBackCheck(Boolean enableFrontShownAsBackCheck)

        Enables/disables check if front shown while scanning back. Make sure to include 'com.incode.sdk:model-id-face-detection' to use this feature.

        Parameters:
        enableFrontShownAsBackCheck - If true, will perform check.
        Returns:

        Builder

      • setEnableBackShownAsFrontCheck

         final IdScan.Builder setEnableBackShownAsFrontCheck(Boolean enableBackShownAsFrontCheck)

        Enables/disables check if back shown while scanning front Make sure to include 'com.incode.sdk:model-id-face-detection' to use this feature.

        Parameters:
        enableBackShownAsFrontCheck - If true, will perform check.
        Returns:

        Builder

      • setShowIdTypeChooser

         final IdScan.Builder setShowIdTypeChooser(Boolean showIdTypeChooser)

        Controls whether the document selection (ID type chooser) screen is shown.

        If set to true, the SDK will display a document chooser screen, allowing the end user to select from the enabled document types.

        If set to false, the SDK will skip the chooser screen and proceed directly with the document type defined via IdScan.Builder.setIdType(IdScan.IdType).

        When using Dashboard (backend) configuration, the chooser will display only the document types enabled in the Dashboard. When using local configuration, the chooser will display ID and Passport by default, and optionally Digital ID (or any other available document type) if enabled.

        If both setShowIdTypeChooser(true) and setIdType(...) are provided, the chooser takes precedence and the explicitly set ID type is ignored.

        Since:

        5.33.0

        Previously Deprecated in: 2.4.0

      • setIdType

         final IdScan.Builder setIdType(IdScan.IdType idType)

        Sets the document type to be used for the ID capture flow.

        When the document chooser is not shown, this value determines which document type will be used for the capture process.

        If the chooser is disabled and no document type is explicitly set (or null is provided), the default document type is IdScan.IdType.ID.

        When using Dashboard (backend) configuration, the available document types are controlled by the Dashboard settings. In that case, this method defines the document type only if the chooser is disabled and the selected type is enabled in the configuration.

        Note: This setting is ignored if IdScan.Builder.setShowIdTypeChooser(true) is set.

        Since:

        2.4.0

      • setScanStep

         final IdScan.Builder setScanStep(IdScan.ScanStep scanStep)

        Sets which steps of the ID scanning process should be taken.

        Parameters:
        scanStep - Represents which steps in the ID scanning process will be included.
        Returns:

        Builder

      • setShowRetakeScreen

        @Deprecated(message = "Deprecated to improve clarity. Manual and auto capture now have separate methods: [setShowRetakeScreenForManualCapture] and [setShowRetakeScreenForAutoCapture].")@JvmOverloads() final IdScan.Builder setShowRetakeScreen(Boolean showForManualCapture, Boolean showForAutoCapture)
        Parameters:
        showForManualCapture - Shows (true) or hides (false) retake screen after manual capture mode was used.
        showForAutoCapture - Shows (true) or hides (false) retake screen after auto capture mode was used.
        Returns:

        Builder

        Since:

        Deprecated in 5.34.0

      • setShowRetakeScreen

        @Deprecated(message = "Deprecated to improve clarity. Manual and auto capture now have separate methods: [setShowRetakeScreenForManualCapture] and [setShowRetakeScreenForAutoCapture].")@JvmOverloads() final IdScan.Builder setShowRetakeScreen(Boolean showForManualCapture)
        Parameters:
        showForManualCapture - Shows (true) or hides (false) retake screen after manual capture mode was used.
        Returns:

        Builder

        Since:

        Deprecated in 5.34.0

      • setShowRetakeScreenForAutoCapture

         final IdScan.Builder setShowRetakeScreenForAutoCapture(Boolean showRetakeScreenForAutoCapture)

        Controls whether the Review Screen is shown after using Auto Capture

        Parameters:
        showRetakeScreenForAutoCapture - Shows (true) or hides (false) retake screen after auto capture mode was used.
        Returns:

        Builder

        Since:

        <a href="https://developer.incode.com/docs/changelog#/version-5290-kiosk-login-135-nfc-135-qr-face-login-123-core-light-264---2024-jul-19">5.29.0</a>

      • setShowRetakeScreenForManualCapture

         final IdScan.Builder setShowRetakeScreenForManualCapture(Boolean showRetakeScreenForManualCapture)

        Controls whether the Review Screen is shown after using Manual Capture

        Parameters:
        showRetakeScreenForManualCapture - Shows (true) or hides (false) retake screen after manual capture mode was used.
        Returns:

        Builder

        Since:

        <a href="https://developer.incode.com/docs/changelog#/version-5290-kiosk-login-135-nfc-135-qr-face-login-123-core-light-264---2024-jul-19">5.29.0</a>

      • setAutocaptureUXMode

        @Deprecated(message = "No longer supported in the new UI") final IdScan.Builder setAutocaptureUXMode(IdScan.AutocaptureUXMode autocaptureUXMode)

        Sets the type of feedback which is displayed before ID or Passport is captured in the scan process.

        Parameters:
        autocaptureUXMode - Countdown mode or HoldStill mode with the option to set duration.
        Returns:

        Builder

        Since:

        Deprecated in 5.34.0

      • setStreamFramesEnabled

         final IdScan.Builder setStreamFramesEnabled(Boolean streamFramesEnabled)

        Enables or disables video streaming of the IdScan module. Make sure to include 'com.incode.sdk:video-streaming' to use this feature.

        <p> **Dashboard equivalent:** the "Enable ID recording" checkbox under ID Capture configuration sets this same flag (`enableIdRecording` in the server response). Despite the dashboard label, it controls **frame streaming**, not session recording. For session recording (which has no dashboard control), see [com.incode.welcome_sdk.FlowConfig.Builder.configureScreenRecording]. <p> Note: This setting is ignored if the device has 2GB of RAM or less.
        Parameters:
        streamFramesEnabled - If true, perform streaming during the ID scan.
        Returns:

        Builder

      • setAutoCaptureNoIdTimeout

         final IdScan.Builder setAutoCaptureNoIdTimeout(Integer autoCaptureNoIdTimeout)

        Sets the ID auto capture timeout in seconds for the fallback timer. The timer is counting down since start of the module, until an ID is detected for the first time.

        Parameters:
        autoCaptureNoIdTimeout - Auto capture fallback timeout value.
        Returns:

        Builder

      • setDigitalIdEnabled

         final IdScan.Builder setDigitalIdEnabled(Boolean enabled)

        Enables or disables the Digital ID option, in the form of a PDF file, on the Document chooser screen.

        Parameters:
        enabled - If true, the Document chooser screen will show Digital ID alongside the other document options.
        Returns:

        Builder

      • setGoogleWalletIdEnabled

         final IdScan.Builder setGoogleWalletIdEnabled(Boolean enabled)

        Enables or disables the Google Wallet option on the Document chooser screen.

        When enabled, make sure to:

        • include the optional wallets dependency in your app (requires API 28+),

        • configure the Google Wallet environment when initializing the SDK using IncodeWelcome.Builder.setGoogleWalletEnvironment.

        Parameters:
        enabled - If true, the Document chooser screen will show Google Wallet alongside the other document options.
        Returns:

        Builder