v9.5.0/v9.4.0 Release Notes

NFC, Barcode, Arabic OCR & Much More Added!

Note:  When upgrading from a version earlier than v9.3.0, be sure to check out the v9.3.0, v9.2.0, and v9.1.0 release notes.

High-level notes about this release:

  1. Added Barcode Scan Support (PDF417, QR & many more)
  2. Added NFC Chip Scan Support for ePassports
  3. Arabic Language is now Supported for OCR Templates
  4. Cyrillic Language is now Supported for OCR Templates
  5. Thai Language is now Supported for OCR Templates
  6. Hebrew Language is now Supported for OCR Templates
  7. Standard Server, Custom Server, and Dashboard have been updated with the new functionality.
  8. Smarter Photo ID Document Auto-Capture
  9. Certain Legacy UI customization APIs have been retired from all Device SDKs.
  10. Increased Security, Bug Fixes, Performance Enhancements, & Stability Improvements throughout the FaceScan and ID Scan process.
  11. Added Face Photo Tamper detection. See Photo ID Anti-Spoofing

Upgrading

3D Liveness, Enrollment, Re-Verification - There are NO Breaking Changes in Device SDKs or FaceTec Servers for these modes.

ID Scan & Photo ID Match - There are No Breaking API Changes with this release, however, there are many new features in the ID Scan process that likely will require developer customization to fully use.

For Organizations currently using ID Scan, please take the following steps:

  1. If using Custom OCR Templates, please update them and re-download them.
  2. Please take a look at the new APIs and String Customizations listed on this page and in our Sample Apps.
  3. Please see the UI/UX Customizations Page for more details about the new ID Scan Screens.
  4. The Legacy Result & Upload Message Dynamic Override APIs are now deprecated.  Please use the new versions of these overloads as they contain all possible Strings that can be customized.
  5. Review the new FaceTec Strings files and make sure to customize all of the new Strings that are available in this release.

FaceTec Server Initialization and Usage Log Server Requirements

In a previous release, the default setup for FaceTec Server would connect FaceTec Server instances to the FaceTec Usage Log Server.  The FaceTec Usage Log Server aggregates the log files for all FaceTec Server instances and handles automatically sending Usage Logs to FaceTec.  As long as the configuration files are correct, the FaceTec Server initializes successfully, the FaceTec Usage Log Server initializes successfully, your Server instances are configured correctly and you do not need to handle any details about sending Usage Logs to FaceTec.

In previous versions of the FaceTec SDK, the above functionality was on by default and could be turned off, but turning this off was not recommended and was only possible to support legacy implementations.

In v9.4.x, the Usage Log Server is now required, and the only way that Usage Logs can be sent to FaceTec.  If you are upgrading from a recent, previous version of the FaceTec SDK, and did not do any specific workaround Usage Logs, you likely do not need to worry about this message, and your FaceTec Server will behave the same as always.

However, some customers who either the disabled Usage Log Server in a previous version or who implemented Usage Log sending prior to the existence of the FaceTec Usage Log Server, will need to update their deployment configuration to use the new Usage Log Server.  The Usage Log Server runs automatically if you use the default configuration of Standard or Custom Server, and simply requires that you use the correct configuration options in order to initialize it successfully. 

For more details, please see the FaceTec Standard or Custom Server (v9 packages.  If you download them using the Configuration Wizard, both the FaceTec Server and the Usage Log Server will be configured with the correct parameters for successful initialization (assuming that outbound connections from your network are configured correctly).

Finally, initialization of the FaceTec Server in Development Mode has been removed, as this was not being used during our new customer onboarding flow -- instead of initializing in Development Mode, FaceTec now issues temporary Production Keys for FaceTec Server testing.


Adding NFC Support to iOS and Android

In order for apps to access the NFC hardware, Android and iOS Apps must be configured correctly.

Adding Android Support:

Declare these items in your AndroidManifest.xml:

<uses-permission android:name="android.permission.NFC"/>
<uses-feature android:name="android.hardware.nfc"android:required="false"/>

Adding iOS Support:

 - Device: iOS 13.0 and above
 - Device: iPhone 7+ (iPads don't have NFC readers)
 - App: Must have "Near Field Communication Tag Reading" added in its project settings ("Signing & Capabilities" > "+ Capability" > "Near Field Communication Tag Reading")
 - App: Must have "Privacy - NFC Scan Usage Description" key set in target properties (Info.plist)
 - App: Must have "ISO7816 application identifiers for NFC Tag Reader Session" filled in target properties (Info.plist)

<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
  <string>A0000002471001</string>
  <string>A0000002472001</string>
  <string>00000000000000</string>
</array>

The documentData Object

In v9.4.0, the old "ocrResults" object has been deprecated and the contents remain unchanged from the previous behavior.

New in v9.4.0, we have created a documentData object that holds the same data as the ocrResults object but also has additional data for NFC and Barcode scenarios.

Notes:

  • The documentData object contains properties for:
    • scannedValues - Values specified on the OCR Template that have been OCR'd.
    • userConfirmedValues - Values that the User Submitted from the User Confirmation Page.
    • barcodeValues - Values that were scanned from the Barcode.  
    • nfcValues - Values that were extracted from the NFC Chip.
  • The "extractedInfo" field is special for barcodeValues and nfcValues, and contains the "raw" data (key/value pairs) that was lifted from the Barcode or NFC Scan. FaceTec has created some internal/private NFC and Barcode parsers that attempt to get structured data from the NFC or Barcode scan, but these parsers are not guaranteed to work for all Document Types that exist. We provide the "extractedInfo" property so that the Barcode or NFC data can be parsed by Customers based on their knowledge of specific formats.

Example documentData Object:

{
  "nfcValues": {
    "extractedInfo": {
      "issuingAuthority": "VALUE_SCANNED_FROM_NFC_CHIP",
      "mrzData": "VALUE_SCANNED_FROM_NFC_CHIP",
      "placeOfBirth": "VALUE_SCANNED_FROM_NFC_CHIP"
    },
    "groups": [
      {
        "fields": [
          {
            "fieldKey": "placeOfBirth",
            "uiFieldType": "Alphabetic",
            "value": "VALUE_SCANNED_FROM_NFC_CHIP"
          }
        ],
        "groupFriendlyName": "Your Information",
        "groupKey": "userInfo"
      }
    ]
  },
  "barcodeValues": {
    "extractedInfo": {
      "firstName": "VALUE_SCANNED_FROM_BARCODE",
    },
    "groups": [
      {
        "fields": [
          {
            "fieldKey": "placeOfBirth",
            "uiFieldType": "Alphabetic",
            "value": "VALUE_SCANNED_FROM_BARCODE"
          }
        ],
        "groupFriendlyName": "Your Information",
        "groupKey": "userInfo"
      }
    ]
  },
  "scannedValues": {
    "groups": [
      {
        "fields": [
          {
            "fieldKey": "firstName",
            "uiFieldType": "Alphabetic",
            "value": "VALUE_SCANNED_FROM_PHOTO_ID"
          },
          {
            "fieldKey": "dateOfBirth",
            "uiFieldType": "FORMAT_DEFINED_IN_IDTC",
            "value": "VALUE_SCANNED_FROM_PHOTO_ID"
          },
          {
        ],
        "groupFriendlyName": "Your Information",
        "groupKey": "userInfo"
      }
    ]
  },
  "userConfirmedValues": {
    "groups": [
      {
        "fields": [
          {
            "fieldKey": "firstName",
            "uiFieldType": "Alphabetic",
            "value": "VALUE_ENTERED_ON_USER_CONFIRMED"
          }
        ],
        "groupFriendlyName": "Your Information",
        "groupKey": "userInfo"
      }
    ]
  },
  "templateInfo" :{
    "templateName": "TEMPLATE_NAME",
    "templateType": "TEMPLATE_TYPE",
  }
}

Extracting Date Type Values (Date of Birth, Expiration, Issue, etc.)

Date values can be found in nfcValues, barcodeValues, or scannedValues, inside the various "groups" objects.  Date properties contain the raw string value in the "value" property, and the Date Format itself is specified in the OCRTemplate in the "uiFieldType" property.  This Date Format is a string containing the characters "y" (year digit), "m" (month digit), "d" (day digit), or "M" (only appears as "MMM" or "MMMM" and both mean month abbreviation with the number of M's, but also the month full name), as well as character delimiters (i.e.: "/", ".", " ", "-", etc).

Examples: Getting Date values from an IDScan response using Java and Python

Get DOB Value using Java

// 1.1 Get the documentData from the result.
String documentDataString = match3D2DIDScanResult.documentData;
JSONObject documentDataJSON = new JSONObject(documentDataString);

// 1.2 Get DOB field JSON (assuming the JSON example above, here you might need to loop through groups and fields to find the date you want)
JSONObject dobField = documentDataJSON["scannedValues"]["groups"][0][1];

// 1.3 Get DOB scannedValue and DOB format as specified in the OCRTemplate
String dobValue = dobField["value"].toString();
String dobFormat = dobField["uiFieldType"].toString();

// 2.0 Use SimpleDateFormat to parse the format and result
SimpleDateFormat format = new SimpleDateFormat(dobFormat);
Date dateObj = format.parse(dobValue); 

Get DOB Value using Python

# Example in Python, by using strptime (C++ is similar)
from datetime import datetime

# Convert from our format string to the expected by the strptime function
dobFormat.replace("MMMM", "%b");
dobFormat.replace("MMM", "%b");
dobFormat.replace("dd", "%d");
dobFormat.replace("yyyy", "%Y");
dobFormat.replace("mm", "%m");
dobFormat.replace("yy", "%y");
dateTimeObj = datetime.strptime(dobValue, dobFormat)

NFC Support in OCR Templates

The FaceTec SDK now supports scanning ePassports with NFC Chips.  To enable ePassport Scan, ensure the OCR Template you are creating has NFC Enabled on the Template Settings.

Implementation Notes:

  • iOS Support - iOS 13 and above.
  • Android Support - All Android Devices with NFC Support are supported.
  • Browser Support - While most modern Browsers have basic NFC Support, no modern Browser supports specific NFC features required to scan ePassports.  Thus, Browser is not supported.
  • On Browser, or on Android Devices without NFC Support, or on iOS 12 and below devices, if the OCR Template specifies NFC is Enabled, the NFC step will simply be skipped.
  • On Android, if NFC is supported, but turned off via settings, a customizable UI will be shown to guide the User to turn on NFC before proceeding.
  • iOS uses a built-in UI similar to FaceID and Apple Pay to guide Users to using NFC.  This UI is required.  FaceTec has exposed all possible NFC String customizations possible for this built-in UI to Developers.
  • v9.4.0 contains a variety of new String customizations for the upload, success, retry, and skip behavior introduced by adding NFC support.  Please see the Sample Apps for exhaustive examples of how to customize the NFC experience on both iOS and Android.
  • Matching of the 3D FaceMap to the Image from the NFC Chip is performed during the NFC portion of the flow and the Match Level is returned.

Barcode Support in OCR Templates

The FaceTec SDK now supports scanning a variety of Barcodes, including PDF417, QR Codes, and more!  To scan Barcodes, the OCR Template must be marked up with the Barcode location and the Barcode Type.

Barcode data is returned to you on the documentData object in raw format in the "extractedInfo" property.  Structured data is returned if possible, however, there are numerous formats for the extracted Barcode data and FaceTec only supports several prominent formats.


Arabic Support in OCR Templates

The FaceTec SDK now supports the Arabic Language.  To OCR Arabic characters, the OCR Template must have fields marked correctly specifying Arabic.

The following Official OCR Templates have been updated to OCR data in Arabic:

  • Egypt - National ID Card - 2005 - Horizontal
  • Algeria - National ID Card - 2017 - Horizontal

These Official OCR Templates have been added and come pre-installed with the FaceTec Server:

  • Saudi Arabia - ID Card (Resident) - 2020_UC - Horizontal
  • Lebanon - Driver License - 2021_UC
  • Syria - National ID Card - 1998 - Horizontal

Behavior Caveats:

  • The OCR Template Creator doesn’t support marking a field designator in one charset (Latin for example) and its contents in a different charset (Arabic for example). Both the designator and the content must use the same character set.

Cyrillic Support in OCR Templates

The FaceTec SDK now supports the Cyrillic Language.  To OCR Cyrillic characters, the OCR Template must have fields marked correctly specifying Cyrillic.

Behavior Caveats:

  • The OCR Template Creator doesn’t support marking a field designator in one charset (Latin for example) and its contents in a different charset (Cyrillic for example). Both the designator and the content must use the same character set.

Thai Support in OCR Templates

The FaceTec SDK now supports the Thai Language.  To OCR Thai characters, the OCR Template must have fields marked correctly specifying Thai.

Behavior Caveats:

  • The OCR Template Creator doesn’t support marking a field designator in one charset (Latin for example) and its contents in a different charset (Thai for example). Both the designator and the content must use the same character set.

Hebrew Support in OCR Templates

The FaceTec SDK now supports the Hebrew Language.  To OCR Hebrew characters, the OCR Template must have fields marked correctly specifying Hebrew.

This Official OCR Template has been added and comes pre-installed with the FaceTec Server:

  • Israel - National ID Card - 2020 - Horizontal

Behavior Caveats:

  • The OCR Template Creator doesn’t support marking a field designator in one charset (Latin for example) and its contents in a different charset (Hebrew for example). Both the designator and the content must use the same character set.

iOS Config Wizard Sample App Note

Please note that the iOS SDK Config Wizard build will not run until you register your Bundle ID with Apple and add NFC support to your Application profile in your Apple Account.