API Call List


Device SDK APIs

API Name
FaceTec Method/Class
Description
Core Inputs
Core Outputs
FaceTec InitializationinitializeWithSessionRequest
Initializes FaceTec and validates keys.
  • Device Key Identifier
  • Session Request Processor
  • Callback Method (optional)
  • Success (or Status)
Session Request Processor
FaceTecSessionRequestProcessor
Handles requests from the FaceTec Device SDK that need a response from the FaceTec Server.
  • isInitializeRequest (Boolean)
  • Response Blob
Start 3D Liveness
start3DLiveness
Starts a 3D Liveness Session on the Device SDK. Declaring an externalDatabaseRefID is required for Enrollment.
  • Liveness Result
Start 3D:3D Re-Verificationstart3DLivenessThen3DFaceMatch
Starts a 3D:3D Re-Verification Session on the Device SDK.
  • Liveness Result
  • Match Level
Start 3D:2D Photo ID Matching
start3DLivenessThen3D2DPhotoIDMatch, startIDScanThen3D2DMatch
Starts a 3D:2D Photo ID Matching Session on the Device SDK.
  • Document Data
  • Match Level
Start ID ScanningstartIDScanOnly
Starts an ID Scanning Session on the Device SDK.
  • Document Data
FaceTec Customization
setCustomization
Configures the UI/UX Customizations for the FaceTec Device SDK.
  • FaceTec Customization Object
N/A

FaceTec Server APIs

API Name
HTTPS API
Description
Core Inputs
Core Outputs
FaceTecServer Status
Retrieves important information about the FaceTec Server.N/A
  • Running Status Boolean
  • Success Boolean
  • Server Information (e.g. Version, Type, Mode)
Process Request
Processes and performs one of FaceTec's Core Features (3D Liveness, 3D:3D Re-Verification, 3D:2D Photo ID Matching, and ID Scanning).
3D:2D Face Portrait Matching
Processes high-quality, 1st generation 2D Image against a previously-processed 3D FaceMap.
  • Success Boolean
  • Match Level
  • Image Processing Status
3D:2D 3rd Party ID Photo Matching
Processes a 2D Image of an ID Photo of unknown source against a previously-processed 3D FaceMap.
  • Success Boolean
  • Match Level
  • Image Processing Status
3D:2D 3rd Party ID Photo Matching - Using Low Quality Images
Same as /match3D_2D_3rdparty_idPhoto, but allows smaller and lower quality images = higher error rates.
  • Success Boolean
  • Match Level
  • Image Processing Status
3D:2D Profile Pic Matching
Matches a 3D FaceMap to a 2D Profile Pic
  • Success Boolean
  • Match Level
  • Image Processing Status
2D Liveness Check
Processes a 2D Image for Liveness.
  • 2D Image
  • Success Boolean
  • 2D Liveness Result
2D:2D Matching
Matches a 2D Image to a 2D Image.
  • 2D Image (First Image)
  • 2D Image (Second Image)
  • Minimum Match Level
  • Success Boolean
  • Match Level
  • Image Processing Status (First Image)
  • Image Processing Status (Second Image)
3D Age Estimation
Performs Age Estimation on 3D FaceMap.
  • Success Boolean
  • Age Group 
3D Age Checks
Performs Age Check on 3D FaceMap.
  • Success Boolean
2D Age Estimation
Performs Age Estimation on 2D Image.
  • 2D Image
  • Success Boolean
  • Age Group
2D Age Check
Performs Age Check on 2D Image.
  • 2D Image
  • Age Group
  • Success Boolean
FaceMap Metadata
Gets data out of 3D FaceMap.
  • 3D FaceMap
  • Success Boolean
  • Audit Image
  • Date Created
  • Date Processed
3D-DB Enrollment
Enrolls 3D FaceMap into 3D-DB.
  • Success Boolean
3D-DB Search
Searches the 3D-DB with a 3D FaceMap.
  • Success Boolean
  • Search Results (Match Levels & Identifiers)
3D-DB Delete
Removes a 3D FaceMap from a 3D-DB search group.
  • Success Boolean
3D-DB Get
Checks if the 3D FaceMap exists in the 3D-DB.
  • Success Boolean
SDK Initialization, Production Mode
N/A, uses config file.
Initializes and validates PRODUCTION KEYS.
  • Production Keys
  • Success (or Status)