FaceTec Server Configuration Option Reference Guide

The FaceTec Device SDKs and FaceTec Server provide a variety of configuration options in their respective Configuration Files. This Reference Guide explains each of these options and their functionality.


FaceTec Key Types & APIs

Key NameKey DescriptionValidity PeriodCreated ByHow is it uploaded?
deviceKeyIdentifierA unique Private Key for initializing the FaceTec Device SDK and FaceTec Server.PermanentFaceTecAutomatically via Configuration Wizard
serverKeyA unique Private Key for initializing the FaceTec Server.PermanentFaceTecAutomatically via Configuration Wizard
productionKeyTextDigitally-Signed Production Key Text that is cryptographically verified against the Device and Server Keys during initialization. This Production Key Text allows the FaceTec SDKs to operate without making network calls to the FaceTec Servers.90 daysFaceTecAutomatically via Configuration Wizard
faceMapEncryptionKey

A unique Public-Private Key Pair that is generated by Your Team. This Key Pair is part of 3D FaceScan, 3D FaceMap, and IDScan Encryption and Decryption, so it must be appropriately configured in both the FaceTec Device SDKs and FaceTec Server (Learn More).

PermanentYour TeamManually by Your Team
httpsApiKey

A unique Private Key for initializing the FaceTec Usage Log Server.

PermanentFacetecAutomatically via Configuration Wizard
faceMapExportPublicKeyForReEncryption

An API used for Exporting (Re-Encrypting) FaceMaps (Learn More).

NANANA

Database Type Configuration

Configuration Field KeyDescriptionValue Type
databaseSelect the type of database you want to use.

The following options are available:

  • in_memory_ephemeral_non_persistent_db
  • mongodb
  • postgresql
  • aws_s3_basic_v8_compatible

MongoDB Database Configuration

The Configuration Options for connecting to a MongoDB Database can be found under mongodb: in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
uriThe Mongo Database connection string. This URI must be accessible from Your Container and/or Host.String, Example: mongodb+srv://<USERNAME>:<PASSWORD>@<CLUSTER_NAME>.<YOUR_URI>.mongodb.net/
databaseNameThe name of the MongoDB Database to use.String
saveOriginalSessionRequestsA Configuration Option for saving the FaceTec Session Requests made in Your Application. When set to true, the Original Session Request will be added to the Session History Data.Boolean

PostgreSQL Database Configuration

The Configuration Options for connecting to a PostgreSQL Database can be found under postgreSQL: in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
urlThe JDBC Connection String. This URL must be accessible from Your Container and/or Host.String, Example: jdbc:postgresql://<YOUR_PG_ADDRESS.<YOUR_COMPANY>.com:5432/<YOUR_DATABASE_NAME>
userThe name of the PostgreSQL User.String
passwordThe password of the PostgreSQL User.String
saveOriginalSessionRequestsA Configuration Option for saving the FaceTec Session Requests made in Your Application. When set to true, the Original Session Request will be added to the Session History Data.Boolean

AWS S3 Basic V8 Compatible Database Configuration

The Configuration Options for connecting to a PostgreSQL Database can be found under aws_s3_basic_v8_compatible: in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
bucketNameThe S3 Bucket to store the FaceMap and AuditTrailImage data.String
regionThe region the S3 bucket is in. Default is "us-west-2"String
faceMapsDirectoryThe name of the directory that will contain the FaceMaps.String
auditTrailImagesDirectoryThe name of the directory that will contain the AuditTrailImages.String

FaceTec Server Configuration

The FaceTec Server Configuration Options can be found in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
serverBaseURLSpecifies the Base URL that the HTTPS API will be served at. "/" indicates that the HTTPS API will be available at <YOUR_WEB_HOST>:<serverPort> (e.g. https://mycompany.com:<serverPort>). Specifying "/my-subdir/" will serve the HTTPS API at <YOUR_WEB_HOST>:<serverPort>/my-subdir (e.g. https://mycompany.com:<serverPort>/my-subdir).String
serverPortSpecifies the Port on which the HTTPS API will be served. "3000" and indicates that the HTTPS API will be available at <YOUR_WEB_HOST>:3000/ (e.g. https://mycompany.com:3000).Number

1:N Search Configuration

The Configuration Options for the 1:N Search APIs and Search Databases can be found in the FaceTec Server Webservice's config.yaml file. For more details, see the 1:N Search Configuration Guide.

Configuration Field KeyDescriptionValue Type
enableSearch"true" will initialize the Search Database on startup. "false" will not initialize the Search endpoints for this Server Instance. Please read the 1:N Search Guide before starting with the 1:N Search Functionality.Boolean
enableFraudListSearchOnNewEnrollmentsSearch must be enabled before enabling Fraud List Search functionality. "true" will perform a 3D-DB Search vs the Fraud List on every new Enrollment and store the results for use in the FaceTec Server Dashboard. "false" will not perform a 3D-DB Search vs the Fraud List on every new enrollment.Boolean
enableAccountDeDuplicationSearchOnNewEnrollmentsSearch must be enabled before enabling Account De-duplication functionality. "true" will perform a 3D-DB Search vs All Enrolled Users on every new Enrollment and store the results for use in the FaceTec Server Dashboard. "true" will also Enroll each new Enrollment in the 3D DB Account De-duplication 3D-DB. "false" will not perform a 3D-DB Search vs All Enrolled Users and not Enroll each new Enrollment in the 3D-DB Account De-duplication 3D-DB. See the 1:N Search Guide for more details.Boolean
search3D3DDatabaseRootDirectorySpecifies the Directories to load/store the Search 3D:3D Databases.String
search3D3DDatabaseExportRootDirectorySpecifies the Directories to export the Search Groups to when using the Export Search Database APIs. Required if using Export Search Database APIs.String
search3D3DAccessibilityDatabaseRootDirectoryThis specialized DB supports adding both 3D FaceMaps and “Liveness-Not-Proven” 3D FaceScans to help evaluate sessions where there may be Users with Accessibility Concerns.String
search3D2DFacePortraitDatabaseRootDirectorySpecifies the Directories to load/store the Search 3D:2D Face Portrait Databases.String
search3D2DKioskPOSDatabaseRootDirectorySpecifies the Directories to load/store the Search 3D:2D Kiosk POS Databases.String
search2D2DIDScanPhotoDatabaseRootDirectorySpecifies the Directories to load/store the Search 2D:2D ID Scan Photo Databases.String
maxSearchResultsMax search results that can be returned when calling search on a search database.Number

Debug Logging Configuration

The Debug Logging Configuration Options can be found in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
enableDebugLogging"true" will log information useful in viewing and understanding the underlying processes that are taking place, but can hinder performance under heavy load. "false" will disable debug logging. Some logging will still occur.Boolean

Usage Log Server URI Configuration

The Configuration Option for the Usage Log Server URI can be found in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
usageLogServerUriSpecifies the URL of the Usage Log Server that will receive the Usage Log Data.String

OCR Template Directory Configuration

The Configuration Option for the OCR Template Directory can be found in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
ocrTemplatesRootDirectorySpecifies the Directory to load FaceTec OCR Templates from.String

ID Scan Behavior Configuration

The Configuration Option for the OCR Template Directory can be found in the FaceTec Server Webservice's config.yaml file.

Configuration Field KeyDescriptionValue Type
match3D2DIDScanBehaviorOverrides

Match 3D:2D ID Scan Advanced Behavior Customization. For more information on each FaceTecBehaviorOverride, see the List of Retry & Rejection Modifiers and the List of Logic Flow Modifiers.

List of FaceTecBehaviorOverrides
idScanOnlyBehaviorOverrides

ID Scan Only Advanced Behavior Customization. List of Retry & Rejection Modifiers and the List of Logic Flow Modifiers.

List of FaceTecBehaviorOverrides

Postman Configuration

The Configuration Option for initializing the Postman Test Suite with the FaceTec Server can be found in the FaceTec Server Webservice's config.yaml file.

Config Option KeyDescriptionValue Type
initializeForPostmanTestSuiteWithServer

Allows for use with the Postman Test Suite test data. This should be used for Postman testing only. Extended use is limited (Learn More).

Boolean