ZoOm Getting-Started Guide for Developers 

A Guide for Technical Teams to Get Up and Running with ZoOm​®​ ASAP! 
Updated March 6th, 2019 
 
Welcome to the ZoOm SDK Getting-Started Guide. This guide is meant to provide tailored, directed instructions for those 
looking to get started with ZoOm as fast as possible. 
 

Docs Home
 
Our documentation is quite extensive, and our dev site is the hub for all information about integrating ZoOm. 
 
Docs Home - h
​ ttps://dev.zoomlogin.com/zoomsdk/#/  
 

Read the Glossary

 
We have made integrating robust, certified, 3D Liveness Detection and Matching very easy, but it is still important that 
you understand terminology that will be used throughout the integration, commercial, and support process. 
 
ZoOm Glossary - ​https://dev.zoomlogin.com/zoomsdk/#/glossary 
 

Read the FAQ

 
We have added answers to the most common questions here: 
 
ZoOm FAQ - ​https://dev.zoomlogin.com/zoomsdk/#/faq  
 

Download & Run Each of the Device SDKs

 
Each SDK ZIP contains a Basic/Minimal Sample App. This app ​only requires a 1-line change to run.​ Just insert your 
License Key Identifier (App Token), save, and run the App. The apps are also extremely small, straightforward, and most 
of the code has been inlined for clarity. This step will give you the best understanding of the core implementation work 
that will be needed for your application. The video on our Docs Home demonstrates getting up and running with the 
Browser SDK in less than 90 seconds — iOS and Android are about the same. 
 
Docs Home & Integration video - h ​ ttps://dev.zoomlogin.com/zoomsdk/#/docs 
Direct Link for Integration video - h
​ ttps://www.youtube.com/watch?v=HoZ5zoUhDzw  
Download the SDKs - h ​ ttps://dev.zoomlogin.com/zoomsdk/#/downloads 
 

Important Notes on the Sample App Configuration

 
The Sample Apps for Browser, iOS, and Android are pre-configured with all the code necessary to capture the ZoOm 3D 
Biometric FaceMap on the device side, and send the FaceMap to the FaceTec Managed REST API for processing (i.e. 
Liveness Detection, Enrollment, and/or Authentication). 
 
FaceMap Guide - h​ ttps://dev.zoomlogin.com/zoomsdk/#/zoom-facemap-guide  
 

Confidential - 2019 - FaceTec, Inc. All Rights Reserved. 

The FaceTec Managed REST API is our own deployed instance of the ZoOm Server SDK. We host our own version of the 
ZoOm Server SDK in order to make the initial implementation and testing of the Sample Apps dead simple. Most 
customers will eventually want to deploy their own instance/cluster of ZoOm Server to own the entire infrastructure, and 
for privacy and security reasons. 
 
FaceTec Managed REST API Docs - ​https://dev.zoomlogin.com/zoomsdk/#/webservice-guide  
 
The Sample Apps are preconfigured to use a common public encryption key. ​This key should not be changed at all 
unless you have deployed your own version of ZoOm Server (later in the integration process). If you modify the key at 
all, you will get decryption errors when calling the FaceTec Managed REST API. 
 

ZoOm Audit Trail Images

 
It is extremely easy to retrieve actual image data from each and every ZoOm Session. You may desire to capture and 
store images from every session for security, auditing, traceability, or a myriad of other reasons. Each Device SDK allows 
you to access up to six high quality images from every ZoOm Session performed. 
 
ZoOm Audit Trail Images Doc -- ​https://dev.zoomlogin.com/zoomsdk/#/retrieving-images-guide  

Test the Complete/Connected App and Experiment with Customizations

 
Once you have looked at the Basic/Minimal ZoOm Sample Apps, you should look at the other samples in each SDK 
package. Sample Apps like the Complete/Connected Apps show more “full” implementations that add nice/fancy UI/UX, 
better error handling, examples of custom integration paths, enrollment and authentication, as well as the ability to 
toggle interface and behavior customizations via very easy toggles and sliders. This step will give you a good sense of 
what is possible when integrating and customizing ZoOm. 
 
More on Interface Customizations -- ​https://drive.google.com/file/d/1TSgGesPlXKXlK-w0-jvUHAWE0jmEORUz/view 
 

Integrate and Test

 
At this point, we recommend you fully implement the Device SDKs into your actual application. Continue to use the 
FaceTec Managed REST API during this phase. When ZoOm is integrated into your application, perform all necessary 
interface/behavior configurations, UX testing, spoof testing, performance testing, and compatibility testing before 
continuing on to the ZoOm Server implementation.   
 
If you have any issues during the Device/Client implementation, we can very easily help you by looking at the usage logs 
for your application.   
 

Deploying ZoOm Server to Your Infrastructure

 
Most customers will want to control their own security and privacy story, and not allow user data to be processed and/or 
stored by FaceTec Servers.   
 
The ZoOm Server SDK is designed to allow customers to easily deploy the backend component to their own 
infrastructure. When the ZoOm Device SDKs and ZoOm Server SDKs are configured properly, and with the issuance of a 
ZoOm License that does not require an HTTPS connection to validate, ​absolutely zero data will leave your network 
and/or touch FaceTec Servers. 
 
The ZoOm AWS SDK wraps the ZoOm Server SDK, and allows you to quickly deploy your own version of the FaceTec 
Managed REST API to AWS via either Elastic Beanstalk, Lambda, or EC2. 
 
Confidential - 2019 - FaceTec, Inc. All Rights Reserved. 
Unless you have specific infrastructure requirements, deploying the ZoOm AWS SDK via Elastic Beanstalk is the 
recommended approach to creating your own backend ZoOm Server infrastructure. 
 
ZoOm AWS SDK Guide -- h ​ ttps://dev.zoomlogin.com/zoomsdk/#/zoom-aws-lambda-eb-ec2-guide  
Download the ZoOm Server and/or AWS SDKs -- ​https://dev.zoomlogin.com/zoomsdk/#/downloads 
ZoOm Server SDK -- ​https://dev.zoomlogin.com/zoomsdk/#/zoom-server-guide  
 

ZoOm Server Specifications

 
The FaceTec Managed REST API uses the Elastic Beanstalk ZoOm Server/AWS deployment path. 
 
Please see the following document for more information about a good baseline AWS configuration and performance, 
and throughput and cost metrics. In short, we show that with extremely modest hardware (~$1,000/year) you can 
support over 1,000,000 transactions per year. Server EB Configuration Doc --  
 

Matching -- 2D to 3D & 1:N

 
Often, applications have use cases using ZoOm to perform 1:1 matching or 1:N matching using a combination of 2D 
Images and ZoOm 3D FaceMaps. These use cases include: 
 
1. Onboarding/KYC — ZoOm is an integral part of automated KYC flows that include document verification or 
verification against previously stored and authenticated photos. Fake account creation can be prevented by 
requiring that your users prove liveness as a part of the onboarding process, and by matching the user’s ZoOm 
3D FaceMap to their identity document photo. 
2. Duplicate Account Detection — You can prevent multiple accounts from being created by the same person by 
performing a 1:N Search across your database of FaceMaps when an account is created. This way, you can see 
if someone is attempting to open up multiple accounts. 
3. Fraud/Scam Accounts — If you have a set of photos of users you would like to be notified if they ever interact 
with your system, you can configure ZoOm to search a database on images or ZoOm 3D FaceMaps with every 
ZoOm Session that is performed. 
 
More information on how to use 2D Images and perform 1:N Searches: 
 
Using 2D Images (FaceTec Managed REST API) -- 
https://dev.zoomlogin.com/zoomsdk/#/webservice-guide?link=Creating%202D%20Single%20Image%20Facemaps 
Authenticating 3D-to-3D, 2D-to-3D, or 2D-to-2D (FaceTec Managed REST API) -- 
https://dev.zoomlogin.com/zoomsdk/#/webservice-guide?link=3D%20Face%20Authentication 
1:N Search (FaceTec Managed REST API) -- 
https://dev.zoomlogin.com/zoomsdk/#/webservice-guide?link=Face%20Search  
Using 2D Images (ZoOm Server SDK) -- 
https://dev.zoomlogin.com/zoomsdk/#/zoom-server-guide?link=Generating%20FaceMaps  
Authenticating 3D-to-3D, 2D-to-3D, or 2D-to-2D (ZoOm Server SDK) -- 
https://dev.zoomlogin.com/zoomsdk/#/zoom-server-guide?link=Authentication  
1:N Search (ZoOm Server SDK) --  
https://dev.zoomlogin.com/zoomsdk/#/zoom-server-guide?link=Search  

Licensing

The two different licensing models are covered in the ZoOm Glossary. By default, and to start, you will use your Device 
License Key identifier to initialize the ZoOm SDK. This makes an HTTPS (networked) call to verify that you are allowed to 
use the ZoOm SDK. The Server SDK has the same concept. 
 
A common question is​: “How can we initialize ZoOm without requiring a network connection to FaceTec Servers?” 
 

Confidential - 2019 - FaceTec, Inc. All Rights Reserved. 

The answer​: Once a commercial agreement (see below) is in place, and once you have integrated ZoOm and fully tested 
your integration, we will issue ​ZoOm License Keys in SFTP Usage Log Mode.​ This means that initialization of ZoOm for 
both Device and Server will not require a network connection to validate. These license keys will have expiration dates 
and will be tied to particular Application IDs and/or Domain Names. 
 
ZoOm Glossary - ​https://dev.zoomlogin.com/zoomsdk/#/glossary 
Your Account -- ​https://dev.zoomlogin.com/zoomsdk/#/account  

Usage Logs
 
When we issue ZoOm License keys that allow SFTP Usage Log Mode, we will still require that you send your Usage Logs. 
The ZoOm Server SDK outputs logs for every transaction it processes. These logs do not contain private/user 
information, but they do contain information about the transaction, like the type, date, and result. 
 
It is mandatory that you create an automated, daily process that sends a ​ ll​ usage logs to your FaceTec Customer SFTP 
Account - no exceptions. Since this process exists in your infrastructure, you may configure this process however you 
choose. 
 
Your FaceTec Customer SFTP Account is created automatically after commercial agreements and licensing discussions 
are completed. We will need one or more public SSH keys in order to create this. 
 
Sending us usage logs in production - ​https://dev.zoomlogin.com/zoomsdk/#/sftp-usage-event-logs  

Chat With Our Commercial Team

 
Please use our contact form to reach out to our Business Development Team for more information on commercial 
agreements and licensing! 
 
https://quote.zoomlogin.com/#/ 
 

Confidential - 2019 - FaceTec, Inc. All Rights Reserved.