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

• Return of images when they are available for reading

Dependencies

Cordova:

cordova plugin add @facephi/sdk-nfc-cordova@<versión>

Android - Gradle:

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

iOS - CocoaPods:

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

launchNfc method

Once the SDK has been 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:

exports.launchNfc = function (cfg)
{
    return new Promise((resolve, reject) => {
        config = [];
        try {
            config = [{"config": cfg}];
        }
        catch (e) {
            console.log(e);
        }

        exec(resolve, reject, 'SdkNfc', 'nfc', config);
    });
};

Basic configuration

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

The basic configuration needed for this is as follows:

export interface 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

Result reception

The launch will return the information in the format NfcResult. It being possible to distinguish between a successful launch and an unsuccessful one:

export interface NfcResult {
  finishStatus: number;
  finishStatusDescription?: string;
  errorType: string;
  errorMessage?: string;
  nfcDocumentInformation?: any;
  nfcPersonalInformation?: any;
  nfcValidations?: any;
  nfcRawData?: any;
  nfcSecurityData?: any;
  facialImage?: string;
  fingerprintImage?: string;
  signatureImage?: string;
  tokenOCR?: string;
  tokenFacialImage?: string;
  tokenSignatureImage?: string;
}

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

NFC Result