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 Name | Key Description | Validity Period | Created By | How is it uploaded? |
|---|---|---|---|---|
| deviceKeyIdentifier | A unique Private Key for initializing the FaceTec Device SDK and FaceTec Server. | Permanent | FaceTec | Automatically via Configuration Wizard |
| serverKey | A unique Private Key for initializing the FaceTec Server. | Permanent | FaceTec | Automatically via Configuration Wizard |
| productionKeyText | Digitally-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 days | FaceTec | Automatically 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). | Permanent | Your Team | Manually by Your Team |
| httpsApiKey | A unique Private Key for initializing the FaceTec Usage Log Server. | Permanent | Facetec | Automatically via Configuration Wizard |
| faceMapExportPublicKeyForReEncryption | An API used for Exporting (Re-Encrypting) FaceMaps (Learn More). | NA | NA | NA |
Database Type Configuration
| Configuration Field Key | Description | Value Type |
|---|---|---|
| database | Select the type of database you want to use. | The following options are available:
|
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 Key | Description | Value Type |
|---|---|---|
| uri | The 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/ |
| databaseName | The name of the MongoDB Database to use. | String |
| saveOriginalSessionRequests | A 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 Key | Description | Value Type |
|---|---|---|
| url | The 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> |
| user | The name of the PostgreSQL User. | String |
| password | The password of the PostgreSQL User. | String |
| saveOriginalSessionRequests | A 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 Key | Description | Value Type |
|---|---|---|
| bucketName | The S3 Bucket to store the FaceMap and AuditTrailImage data. | String |
| region | The region the S3 bucket is in. Default is "us-west-2" | String |
| faceMapsDirectory | The name of the directory that will contain the FaceMaps. | String |
| auditTrailImagesDirectory | The 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 Key | Description | Value Type |
|---|---|---|
| serverBaseURL | Specifies 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 |
| serverPort | Specifies 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 Key | Description | Value 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 |
| enableFraudListSearchOnNewEnrollments | Search 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 |
| enableAccountDeDuplicationSearchOnNewEnrollments | Search 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 |
| search3D3DDatabaseRootDirectory | Specifies the Directories to load/store the Search 3D:3D Databases. | String |
| search3D3DDatabaseExportRootDirectory | Specifies the Directories to export the Search Groups to when using the Export Search Database APIs. Required if using Export Search Database APIs. | String |
| search3D3DAccessibilityDatabaseRootDirectory | This 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 |
| search3D2DFacePortraitDatabaseRootDirectory | Specifies the Directories to load/store the Search 3D:2D Face Portrait Databases. | String |
| search3D2DKioskPOSDatabaseRootDirectory | Specifies the Directories to load/store the Search 3D:2D Kiosk POS Databases. | String |
| search2D2DIDScanPhotoDatabaseRootDirectory | Specifies the Directories to load/store the Search 2D:2D ID Scan Photo Databases. | String |
| maxSearchResults | Max 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 Key | Description | Value 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 Key | Description | Value Type |
|---|---|---|
| usageLogServerUri | Specifies 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 Key | Description | Value Type |
|---|---|---|
| ocrTemplatesRootDirectory | Specifies 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 Key | Description | Value 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 Key | Description | Value 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 |