NFC Capture

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 all possible information to be read

• Return images when they are available for reading

Dependencies

Capacitor:

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

Android - Gradle:

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

iOS - CocoaPods:

s.dependency 'FPHISDKNFCComponent', '~> $version'

startNfc Method

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

Launching the NFC reader:

startNfc(configuration: NfcConfiguration): Promise<NfcResult>;

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 required for it is as follows:

class NfcConfiguration
{
  docNumber: string;
  birthDate: string;
  expirationDate: string;
  extractionTimeout?: number;
  docType?: NfcDocumentType;
  showTutorial?: boolean;
  vibrationEnabled?: boolean;
  skipPACE?: boolean;
  debug?: boolean;
  showDiagnostic?: boolean;
  showPreviousTip?: boolean;
  extractFacialImage?: boolean;
  extractSignatureImage?: boolean;
}

Advanced component configuration

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

NFC Configuration

Receiving the result

The launch will return the information in NfcResult. Being able to distinguish between a successful and an unsuccessful launch:

class NfcResult
{
  finishStatus: number;
  finishStatusDescription?: string;
  errorType: string;
  errorMessage?: string;
  nfcDocumentInformation?: any;
  nfcPersonalInformation?: any;
  nfcValidations?: any;
  facialImage?: string;
  fingerprintImage?: string;
  signatureImage?: string;
}

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

NFC Result