Constructor Detail

• NfcScan.Builder

  NfcScan.Builder()

Method Detail

• setShowNfcSymbolConfirmationScreen

  @Deprecated(message = "NFC Scan no longer shows the chip-symbol question, so this option has no effect.") final NfcScan.Builder setShowNfcSymbolConfirmationScreen(Boolean showNfcSymbolConfirmationScreen)

  Retained for compatibility. NFC Scan no longer shows the chip-symbol question, so this option has no effect.

  Deprecated since 5.56.0

  Parameters:

  showNfcSymbolConfirmationScreen - Retained for compatibility.

  Returns:

  Builder

• setShowTutorials

   final NfcScan.Builder setShowTutorials(Boolean showTutorials)

  Parameters:

  showTutorials - If true, tutorials will be shown on how to scan an ID/Passport.

  Returns:

  Builder

• setProcessNfcData

   final NfcScan.Builder setProcessNfcData(Boolean processNfcData)

  Parameters:

  processNfcData - If true, the data read from the NFC chip will be used to validate identity.

  Returns:

  Builder

• setNfcMaxRetries

   final NfcScan.Builder setNfcMaxRetries(Integer nfcMaxRetries)

  Parameters:

  nfcMaxRetries - sets the maximum number of NFC scan attempts for reading a passport or ID.

  Returns:

  Builder

• setIdType

   final NfcScan.Builder setIdType(IdScan.IdType idType)

  Parameters:

  idType - Set Id Type which should be used for NFC scanning.

  Returns:

  Builder

• setShowInitialDataConfirmationScreen

   final NfcScan.Builder setShowInitialDataConfirmationScreen(Boolean showInitialDataConfirmationScreen)

  Parameters:

  showInitialDataConfirmationScreen - If true, Document OCR data confirmation screen will be shown before the first NFC scan.

  Returns:

  Builder

• setReturnResultImmediately

   final NfcScan.Builder setReturnResultImmediately(Boolean returnResultImmediately)

  Parameters:

  returnResultImmediately - If true, the result of the NFC scan is returned immediately after the scan is completed.

  Returns:

  Builder

• setForceV2

   final NfcScan.Builder setForceV2(Boolean forceV2)

  Parameters:

  forceV2 - If true, the NfcScan module always shows its UXv2 screens, even when the rest of the flow runs the legacy UI.

  Returns:

  Builder

• setForceNfcModule

   final NfcScan.Builder setForceNfcModule(Boolean forceNfcModule)

  Bypasses smart gating when enabled so NFC Scan can run despite a negative backend capability hint. Existing document support, hardware requirements, and confirmation screens still apply. A false value does not cancel a server override.

  Since 5.56.0

  Parameters:

  forceNfcModule - Whether to bypass smart gating.

  Returns:

  This builder.

• build

   final NfcScan build()

  Builds an NFC Scan module that can be added to a flow. Once ProcessId is done on a supported document type, it is possible to use the NfcScan module.