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

NFC capture

Introduction

Face Capture is performed with the NFC Component.

This component is responsible for reading the NFC of identity documents and passports. Its main processes are:

  • Internal management of the NFC sensor.

  • Permission management.

  • Document analysis.

  • Progress analysis.

  • Assistant in the reading processes.

  • Return of all possible information to read

  • Return of images when available for reading

Dependency

The specific dependency for the component is:

implementation "com.facephi.androidsdk:nfc_component:$sdk_nfc_component_version"{
      exclude group : "org.bouncycastle", module : "bcprov-jdk15on"
      exclude group : "org.bouncycastle", module : "jetified-bcprov-jdk15on-1.68"
  }

In addition, the following must be added in gradle:

Available controllers

Controller

Description

FNFCController

Main NFC reading controller

Error handling

Errors will be returned as an 'NfcError' object.

List of NFC capture errors:
  • NFC_APPLICATION_CONTEXT_ERROR: The required application context is null.

  • NFC_CANCEL_BY_USER: The user has cancelled the process.

  • NFC_CANCEL_LAUNCH: A general cancellation of the SDK has been made.

  • NFC_COMPONENT_LICENSE_ERROR: The component license is not valid.

  • NFC_EMPTY_LICENSE: The license String is empty.

  • NFC_EXTRACT_DATA_ERROR: Error in the extracted data.

  • NFC_FETCH_DATA_ERROR: Error in retrieving the result.

  • NFC_FLOW_ERROR: Error in the flow process.

  • NFC_INITIALIZATION_ERROR: Initialization error.

  • NFC_LAST_COMMAND_EXPECTED: Error in the finalization command

  • NFC_MANAGER_NOT_INITIALIZED: The managers are null.

  • NFC_NO_DATA_ERROR: The input data is null or no result has been received from the reading.

  • NFC_ERROR: General error

  • NFC_ERROR_DATA: Error in the input data

  • NFC_ERROR_DISABLED: NFC disabled

  • NFC_ERROR_ILLEGAL_ARGUMENT: NFC with an incorrect tag

  • NFC_ERROR_IO: Input/output error

  • NFC_ERROR_NOT_SUPPORTED: NFC not supported

  • NFC_ERROR_TAG_LOST: Connection lost

  • NFC_OPERATION_NOT_CREATED: There is no operation in progress.

  • NFC_TIMEOUT: Timeout in the process.

Reception of the correct result - data

In case of success, data contains a NfcResult with the data read from the document, available images, security data, and cryptographic validations.

Within NfcResult.nfcValidations, the result includes:

  • chipAuthenticationSupported: Indicates whether the document chip supports Chip Authentication. The field chipAuthenticationValidation stores the validation result when applicable.

Last updated