FaceTec's Update Policy and Info
Staying on the latest version of the FaceTec SDKs is important and required.
Update Policy
FaceTec strongly encourages all applications be on the Latest Version of FaceTec Device, Server, Usage Log Server, and Dashboard SDKs for optimal Security & Usability.
All Partners, Customers, and Developers must update to the latest version of the FaceTec SDKs (including Usage Log Server) within 90 days of release.
Usage of FaceTec SDK libraries that are older than 90 days is not supported.
FaceTec Server & Usage Log Server updates, in the vast majority of cases, are non-breaking, and the latest version of the FaceTec Server & Usage Log Server is always backward compatible with FaceMaps generated using older versions of the FaceTec SDK libraries. This means that updating the FaceTec Server normally only involves the installation of the new library, which then provides you with all of the benefits of our latest security and usability improvements.
FaceTec Device SDK updates are also mostly non-breaking. We realize that there is a development cycle whereby staying "Up-to-Date" with Device SDK versions requires installing the new SDK in your App and then getting the change into the App Store, Google Play, or live on your website. We also realize that even after this, users must then download the latest version of your App to get this update. For these reasons, the 90 day requirement describes the time from release on the FaceTec Developer Site until the time the SDK shows up in the latest version of your SDK or App.
FaceTec highly recommends updating all Device SDK, FaceTec Server, and Usage Log Server Versions frequently. Device SDKs and FaceTec Servers (not only the FaceTec Server) must be updated for optimal Security (and Usability). Every week, FaceTec improves its Liveness & Security AI, and every 2-4 weeks, FaceTec releases significantly upgraded or brand new Security Layers to Detect & Reject a broad spectrum of Attack Vectors, as well as numerous improvements to Usability & Compatibility.
Important Note: For FaceTec Partners, this means that you must make your own Device SDK or Device Code, with updated FaceTec Device SDKs, available to your Customers within the 90 day window. We do not require that your Customers install it, but it must be available to them.
If you are using FaceTec SDKs free in Development Mode, FaceTec may at any time, and without warning, revoke Key validation if your application is using a version of FaceTec SDKs that FaceTec deems as outdated. If you are using FaceTec SDKs in Development Mode, please stay up-to-date with your version of FaceTec SDKs to ensure your applications continue to function while you are developing.
SDK Upgrade Process
Before you begin, please make sure to review Device SDK and FaceTec Server Compatibility information.
Important Note: Please make sure to always update the FaceTec Server first, then the Device SDK. Never update the Device SDKs without first updating the FaceTec Server.
To update the Device SDKs, see the Updating the Device SDK (Android, iOS, Browser) Guides.
To update the FaceTec Server, see the Updating the FaceTec Server Guide.
The Latest Version of FaceTec SDKs
It is imperative that applications stay up-to-date with FaceTec SDKs. FaceTec strongly encourages all applications be on the Latest Version of FaceTec Device SDKs & FaceTec Server for optimal Security & Usability.
Just as Android, iOS, the Web, platform tooling, hardware capabilities, and the security landscape are constantly evolving, so too is the FaceTec SDK product.
FaceTec's goal is to strike a balance between platform stability with constant improvements we are making in the areas of:
- Security
- Algorithmic Accuracy (Liveness, Matching, Quality, etc.)
- Usability
- Compatibility
- Performance
- New Features
- Reliability
- Developer Experience
- Ease of Integration
Security as the Primary Motivator
At FaceTec, SECURITY is the #1 priority, and our Update Policy is derived from this philosophy.
FaceTec is constantly innovating in the area of security. This not only includes improving and strengthening our already highly robust algorithms, but also adding features like webcam bypass detection, replay attack detection, FaceMap tamper detection, and much more. FaceTec Partners & Customers must be ready and willing to adapt, so we can stay ahead of the fraudsters and the competition.
For these security reasons, we cannot provide older SDKs to our customers. We thank you in advance for your understanding.
NIST & OWASP Guidance
NIST and OWASP produce a few commonly-accepted guidance on security best practices. Patch management and staying up-to-date with software, especially security software, is a top best practice that is highly recommended.
OWASP 2019 Top Ten - "Security misconfiguration is the most commonly seen behavior... Not only must all operating systems, frameworks, libraries, and applications be securely configured, but they must be patched/upgraded in a timely fashion."
NIST Guide to Enterprise Patch Management - "Patch management is the process for identifying, acquiring, installing, and verifying patches for products and systems. Patches correct security and functionality problems in software and firmware... it is still important for all organizations to carefully consider patch management in the context of security because patch management is so important to achieving and maintaining sound security. "
Release Notifications
FaceTec sends out periodic update emails to all FaceTec Developer Account emails, but we do not send mail for each and every update. Please check the Download Page to ensure you have the latest version!
Updating Your Apps
We make our best effort to ensure upgrades are easy and don't break your Apps or impact your Users. Please check out the Release Practices Guide for more information.
New Features
Added or removed APIs, new behaviors, new features, removed features, and other major functionality changes are noted in our Release Notes, where possible.
Frequently Asked Questions
What Version Am I On?
On each platform, there is a .version property or .version() function on the main FaceTecSDK object.
What is the Current Version of the FaceTec SDKs?
Check out our Download Page for more information!
What are "Miscellaneous Bug Fixes"?
Sometimes, FaceTec Release Notes for a given update include an unspecific note that the release contains "Miscellaneous Bug Fixes". As a closed-source security product, FaceTec often includes improvements to the FaceTec SDK libraries that relate to features and internal functionality that we consider trade secrets, and oftentimes relate to the security or algorithmic accuracy of security-related systems inside the FaceTec SDK Engine. Unfortunately, for these reasons, we cannot divulge each and every code change that we make to the product.
Why does FaceTec not have SDK releases on Maven, Cocoapods, Swift (SPM), or other package managers?
FaceTec requires an email signup and confirmation to download the SDKs, so we cannot put the SDKs on a public repository.
Maven, Cocoapods, and most package managers, by design, allow developers to specify specific versions of software to use. FaceTec requires you to use the latest version. Thus, FaceTec hosting the SDKs even in a private repository would be counter-productive to our goals of keeping you on our latest version.
When can I expect new SDK Encryption Keys for my App?
FaceTec issues new SDK Encryption Keys on the 10th of the month prior to the expiration of the current set of SDK Encryption Keys, so Customers & Partners have enough time to plan, rotate the SDK Encryption Keys, and update the SDKs accordingly.
How often should I update the Facetec SDKs?
FaceTec is primarily a Security Product, and new and improved SDKs are released weekly. FaceTec recommends regularly checking the Release Notes and performing frequent updates to the FaceTec Server, Usage Log Server, and Device SDKs for continued up-to-date Security, Compatibility, and Usability.
Where can I check the Expiration Date of my SDK Encryption Keys?
The Expiration Date of Your SDK Encryption Keys can be found on Your Account Page. Since FaceTec is an On-Premises Software, each Customer is responsible for monitoring the Expiration Date and updating the SDK Encryption Keys of their Hosted SDKs and Applications.
Do the SDK Encryption Keys have a Grace Period?
The SDK Encryption Keys may still be able to function after the Expiration Date, but using Expired Keys is not recommended and can lead to a Service Interruption in Your Production Environment. FaceTec recommends updating the FaceTec SDK Encryption Keys immediately after the New Keys are available on Your Account Page.
Do the FaceTec SDKs stop working if not updated?
As mentioned in the FaceTec Update Policy, old SDKs are more likely to experience device, camera, and User compatibility-related behaviors. However, the FaceTec SDKs will continue to work as designed until the SDK Encryption Keys have expired.
What happens if I do not update the FaceTec SDKs?
Not updating the SDKs per the FaceTec Update Policy will result in suboptimal Security and Usability in your environment, limiting the ability of FaceTec to provide support, resulting in FaceTec issuing SDK Encryption Keys with a shorter duration, or in extreme cases, not renewing the SDK Encryption of your App.
Can two different FaceTec Server versions run concurrently?
Running two different versions of the FaceTec Server and Usage Log Server is not supported and can lead to unexpected behaviors. Feature flags, ID Scan Modifiers, OCR Templates, and other features may be introduced in newer versions of the FaceTec Server. If these changes are only present in one of the two FaceTec Servers, then the results of an API Call may differ based on which FaceTec Server processes the request.
Therefore, all instances of the FaceTec Server and Usage Log Server should be the same version.
I Received a SDK Encryption Key Reminder. What should I do?
FaceTec receives Usage Log from your Applications and can occasionally send SDK Encryption Keys Reminders to inform you of one or more SDKs that may not be configured with the latest SDK Encryption Keys issued by FaceTec. When receiving such emails, it is important to review your SDKs to ensure they are configured with the latest available SDK Encryption Keys from your Account Page.