v9.7.0 Release Notes

v9.7 – FREE Unlimited Photo ID Scans With OCR, 2,300+ Officially Supported OCR Templates, Two+ Forms of ID Support, Universal 3D FaceVectors, & Much More

Note: Please review the v9.6.0, v9.5.0/v9.4.0, v9.3.0, v9.2.0, and v9.1.0 Release Notes.

Updates in v9.7:

  1. Numerous Device Compatibility and Algorithm Accuracy Improvements (Usability & Security) Bug Fixes - All bugs addressed since the last version of v9.6 will be released as a part of this major version release.
  2. NO Breaking Changes - unless using Deprecated Code. For Developers using Deprecated Code in their current release, please see the v9.7 Table of Removed Deprecations.
  3. Preparing for v10 - FaceTec will be releasing v10 in 2025.

New & Improved in v9.7:

  1. Standalone, Unlimited ID Scans without a 3D Liveness Check are now supported and are Free for all FaceTec Customers & Partners.
  2. Universal 3D FaceVectors allow ALL FaceTec Customers and Partners to share 3D Face Data in a format that contains NO image data, making them ideal for cases that require enhanced privacy, such as Mobile Driver Licenses and Web 3.
  3. 3D FaceScan and ID Scan UI Improvements – Screen transitions and animations are smoother across a wider variety of devices and OS versions.
  4. Photo ID Auto-Capture is now faster during ID Scans on all platforms.
  5. Scanning multiple documents sequentially is now supported by calling additional ID Scans.
  6. Official FaceTec Server Support for 2,300+ Official OCR Templates.
  7. New Lab Tested & Security Confirmed Level 4 & 5 Video Injection & Camera Bypass Security.
  8. Chinese, Japanese, and Vietnamese added to FaceTec’s Default Supported Languages.
  9. Universal Photo ID Mode – ID Scans can now be performed on any Photo ID, whether it is included in the 2,300+ Official OCR Templates or not. This captures any Photo ID and still performs some authentication checks, even if FaceTec’s AI has never seen that Photo ID Type before.
  10. “Additional Review Required” Screen added. This optional screen is shown if any tampering or Red Flags are observed on an ID Scan.
  11. FaceTec Customization APIs added. Developers can now customize the display times of various Screen Animations in the Device SDK UI.
  12. Greatly Improved and Expanded FaceTec Server Moderator Dashboard UI.
  13. Dashboard + FaceTec Standard/Custom (v9) Servers: New native Account De-duplication and Known Fraudster List features.
  14. 1:N Search/Duplicate Checks Speed Improvements in Large Databases of +1M 3D FaceMaps.
  15. Dozens of miscellaneous compatibility, security, UI/UX improvements.
  16. ID Scan Feedback for flipping the ID Document added. The new ID Scan Feedback instructs users to flip over their ID document to either the front or back (when applicable). This new ID Scan Feedback has customizable animations and text.
  17. Most Deprecated Methods have now been fully removed. For the full list of Removed Deprecations, see the v9.7 Table of Removed Deprecations.
  18. "getNextStep" function added to the FaceTec Server to determine what step the User is in. This function is a superset of the "isCompletelyDone" and "isReadyForUserConfirmation" flags, so these flags have been deprecated and will be removed in the future.

v9.7 Introduction

v9.7 contains a variety of Device Compatibility and Algorithm Accuracy Improvements (Usability & Security). There are NO significant new features and NO breaking changes, except for certain deprecated API removals. If your App is using deprecated code, you may need to make a few small changes to remove your usage of deprecated code. More information about Updating to v9.7 is included further below.

Please Note:  Updates to your FaceTec SDKs can be completed using the same process used for v9.6.x.  When Updating your SDKs, always Update the FaceTec Server first, then your Device SDKs, per FaceTec's Release Practice guidance.  The FaceTec SDKs v9.7.x have been rolled out in phases by geography -- the first available version for most FaceTec Partners & Customers is >v9.7.0.


Upgrading & Breaking Changes

3D Liveness, Enrollment, Re-Verification - There are NO Breaking Changes unless Your App is using deprecated code. If you are using Deprecated Code, you may need to adjust Your App accordingly. Please see the Deprecations Removal List further below for more details.

ID Scan  - There are No Breaking API Changes with v9.7. However, there is a new User Guidance Animation & Text to guide Users to Show the Front or Back of their Documents for Documents that have a Front & Back side.  Please see the documentation below for more details.

Testing v9.7.0

It is Extremely Important that these upgraded versions are well tested On Your System before putting them into production. Please make sure you deploy v9.7. Device and FaceTec Servers to a pre-production environment and test your integration and all important scenarios before putting them in production.


Behavior Change Notices

New ID Scan Feedback in v9.7

ID Scan Feedback can now be customized and used to instruct Users to flip the ID Document.

New ID Scan Animations & Texts in v9.7

New FeatureAffected SDKsNew APIsDetails
Localizable Feedback with Animation for Flipping the IDAndroid, iOS, and Browser

Feedback Screen/Animation: 

  • ScreenFaceTecIDScanCustomization.idFeedbackScreenFlipIDToBackAnimation (Android and Browser only)
  • FaceTecIDScanCustomization.idFeedbackScreenFlipIDToFrontAnimation (Android and Browser only)
  • onCreateIDFeedbackScreenFlipIDToBackAnimationView (iOS Only)
  • onCreateIDFeedbackScreenFlipIDToFrontAnimationView (iOS Only)

Text Customization/Localization:

  • "FaceTec_idscan_feedback_flip_id_to_back_message"
  • "FaceTec_idscan_feedback_flip_id_to_front_message"
  • During an ID Scan, when transitioning from a successful ID front capture to an ID back capture, the ID Feedback Screen will show the "Flip ID To Back" animation and display localized feedback.
  • During an ID Scan, if a user captures the incorrect side of their ID, the ID Feedback Screen will show the appropriate Feedback Animation ("Flip ID To Front" or "Flip ID To Back") and display localized feedback.
  • If a custom animation is not configured, a default animation is displayed that will be tinted to match the screen's configured foreground color.
Display Time AnimationsAndroid, iOS, and Browser
  • FaceTecResultScreenCustomization.resultAnimationDisplayTime
  • FaceTecIDScanCustomization.additionalReviewScreenAnimationDisplayTime
  • FaceTecIDScanCustomization.idFeedbackScreenAnimationDisplayTime
  • FaceTecIDScanCustomization.nfcScreenAnimationDisplayTime (Android and iOS SDKs only)
  • Customizes the display time for one-shot animations on the Result Screen, Additional Review Screen, ID Feedback Screen, and NFC Screen.
  • Display times can be set in a range between 1.5 seconds and 3 seconds. The default is 2 seconds.

Removed Deprecations in v9.7

NameAffected SDKsRemoved APIsOther Details
Attributed Strings for the Retry and Ready ScreensBrowser

FaceTecGuidanceCustomization.retryScreenSubtextAttributedString

FaceTecGuidanceCustomization.retryScreenHeaderAttributedString

FaceTecGuidanceCustomization.readyScreenHeaderAttributedString

FaceTecGuidanceCustomization.readyScreenSubtextAttributedString

To achieve the same functionality, please use HTML within your localized string files.

Localization Override with JSONBrowser

configureLocalizationWithJSON

This was previously replaced with FaceTecSDK.configureLocalization.

ID Scan Capture Screen Document Image CustomizationsBrowser

captureScreenIDFrontPlaceHolderImage

captureScreenIDBackPlaceHolderImage

captureScreenPassportPlaceholderImage

captureScreenIDFrontCheckmarkImage

captureScreenIDBackCheckmarkImage

captureScreenPassportCheckmarkImage

These APIs were already non-operational and did not affect behavior.

No Interaction Timeouts for Liveness Checks and ID ScansAndroid, iOS, and Browser

FaceTecSessionTimerCustomization.idScanNoInteractionTimeout

FaceTecSessionTimerCustomization.livenessCheckNoInteractionTimeout

These APIs were already non-operational and did not affect behavior.

No Interaction Timeouts for Liveness Checks and ID ScansBrowser

FaceTecSessionTimerCustomization.maxTimeBeforeCameraPermissionsError

These APIs were already non-operational and did not affect behavior.

Selection Screen Branding ImageAndroid, iOS, and Browser

FaceTecIDScanCustomization.selectionScreenBrandingImage

FaceTecIDScanCustomization.showSelectionScreenBrandingImage

These APIs were already non-operational and did not affect behavior. They were replaced with FaceTecOverlayCustomization.showBrandingImage and FaceTecOverlayCustomization.brandingImage.

Static Animation Drawable CustomizationsAndroid

FaceTecIDScanCustomization.customStaticNFCStartingAnimation

FaceTecIDScanCustomization.customStaticNFCScanningAnimation

FaceTecIDScanCustomization.customStaticNFCSkipOrErrorAnimation

FaceTecIDScanCustomization.additionalReviewScreenStaticAnimation

FaceTecOCRConfirmationCustomization.customStaticScrollIndicatorAnimation

FaceTecResultScreenCustomization.customStaticResultAnimationSuccess

FaceTecResultScreenCustomization.customStaticResultAnimationUnsuccess

These APIs were already non-operational and did not affect behavior. Each animation is still fully customizable by alternate FaceTecCustomization APIs.

Removed deprecated Versions of ID Scan Upload Message and Result Message Override (APIs still exist)Android, iOS, and Browser

FaceTecCustomization.setIDScanUploadMessageOverrides

FaceTecCustomization.setIDScanResultScreenMessageOverrides

These APIs still exist, but deprecated overloads have been removed.

iOS Config Wizard Sample App Notice

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

In the FaceTec SDK's .framework, the arm64 slice can only be built on actual devices (and not on a simulator). To resolve this issue, you should use the .xcframework instead. It has a specific simulator framework with a stubbed-out binary for x86 and arm64, which allows it to compile and build on the simulator.

Standalone ID Scan (v9.6)

Standalone ID Scan allows FaceTec Customers and Partners to Scan IDs without performing a 3D Liveness Check. Standalone ID Scan is FREE for all FaceTec Customers and Partners. It can be launched via a similar Processor code as that used for 3D Liveness Checks and the already-existing Photo ID Matching. Please see the Device SDK Processors for more details on their configuration.

Standalone ID Scan requires one additional String customization, as well as a Loading Animation Customization, in order to change the look, feel, and text when launching directly into the ID Scan experience.

Universal 3D FaceVectors (v9.6)

Universal 3D FaceVectors provide all of the benefits of 3D FaceVectors, but they can be used for matching by any FaceTec Server with any set of Encryption Keys. This means that there is no code or special keys required in order to send, receive, and process Universal 3D FaceVectors from other organizations using FaceTec SDKs.

To convert a 3D FaceVector or 3D FaceMap into a Universal 3D FaceVector, use the "convertToUniversalFaceVector" function on the FaceTec Core API, or the "/convert-to-universal-face-vector" with the FaceTec Server HTTPS API.

1:N Search Performance (v9.6)

1:N Search/De-duplication Speed with large (+1M to +10M Databases) has been greatly increased.