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

NFC capture

This component is responsible for reading the NFC of identity documents and passports.

Your 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

Dependencies

Capacitor:

npm install @facephi/sdk-nfc-capacitor@<versión>
npm run build
npx cap sync

Android - Gradle:

implementation "com.facephi.androidsdk:nfc_component:$version"

iOS - CocoaPods:

startNfc method

Once the SDK has started and a new operation has been created, the component can be launched. Any of its controllers can be used to execute its functionality.

NFC reader launch:

Basic configuration

To launch the current component, an object must be created NfcConfiguration which will be the configuration of the component controller.

The basic configuration needed is the following:

Advanced configuration of the component

Below are all the fields that are part of this class.

NFC Configuration

Receipt of the result

The launch will return the information in NfcResult. It can be differentiated between a successful launch and an unsuccessful one:

Below are all the fields that are part of this class.

NFC Result

Last updated