ID Scan: Logic & Behavior Customization

Learn how to customize the default logic and behavior of FaceTec's ID Scans.

Default Logic & Behavior

Listed below is the default logic and behavior of a FaceTec ID Scan:

1. After one or more Retries, a FaceTec ID Scan Session may be able to proceed, even if some checks are not passing or a Matching OCR Template has not been found. The number of Retries that are required depends on the specific checks that are not passing.
2. A Retry is triggered the first time Face Tampering or Text Tampering is detected. By default, neither of these will trigger a Retry more than once.
3. A Retry is triggered if the MRZ or Barcode Check does not succeed. By default, neither of these will trigger a Retry more than two times.
4. A Retry is triggered if a Photo ID Face Image is not found (when one is expected) or the Photo ID Face Image does not match the 3D FaceMap (3D:2D ID Photo Matching only). By default, neither of these will trigger a Retry more than three times.
5. A Retry is triggered if Unexpected Media (image from a monitor, image on plain paper, etc.) is detected. By default, this will not trigger a Retry more than three times.
6. A Retry is triggered if an Expected Watermark or Hologram is not detected. By default, this will not trigger a Retry more than once.
7. NFC Scans are performed based on the matching OCR Template's Settings. However, if multiple NFC Scans fail, then the FaceTec ID Scan Session will still proceed.
8. The User Confirmation Screen is shown when a Barcode or NFC Chip is not specified by the OCR Template, there is a problem reading the Barcode or NFC chip, or the NFC Step is skipped by the User.
9. The Additional Review Required Screen is shown if anything unusual is detected by the FaceTec SDK.

Customized Logic & Behavior

To customize the logic and behavior of FaceTec's ID Scans, the proper Retry & Rejection Modifier or Logic Flow Modifier needs to be used. There are two methods for applying these modifiers to FaceTec's ID Scans:

1. Updating the FaceTec Server's config.yaml (FaceTec Standard/Custom Server)
2. Updating the FaceTec Server's Java Classes (FaceTec Custom Server only)

For both of these cases, 3D:2D Photo ID Matching and FaceTec ID Scan are separate customizations. Therefore, different Retry and Behavior Logic can be defined for each of these FaceTec Features. To ensure the same Retry and Behavior Logic, both features will need to be updated to use the proper Retry & Rejection Modifier or Logic Flow Modifier.

3D:2D Photo ID Matching and ID Scan Only - Logic & Behavior Customizations

Method 1 (with config.yaml):

To enable Global Advanced Behavior Customizations, uncomment the selected modifiers for the relevant APIs in the FaceTec Server's config.yaml, as listed below:

#  - IGNORE_TEXT_TAMPERING
#  - IGNORE_FACE_TAMPERING
#  - IGNORE_MATCHING
#  - IGNORE_FACE_NOT_FOUND
#  - IGNORE_MRZ_CHECK
#  - IGNORE_BARCODE_CHECK
#  - IGNORE_IDSPOOF
#  - PREVENT_PROCEEDING_DESPITE_CHECKS_FAILING
#  - PREVENT_UNIVERSAL_ID_MODE
#  - SKIP_ARR
#  - SKIP_NFC
#  - FORCE_USER_CONFIRMATION
#  - SKIP_USER_CONFIRMATION
#  - SKIP_BACK_SCAN

Use the match3D2DIDScanBehaviorOverrides field for 3D:2D Photo ID Matching (i.e. when the User performs a 3D FaceScan, followed by an ID Scan) and the idScanOnlyBehaviorOverrides field for Standalone ID Scans.

Important Note: Proper Indentation is necessary for the modifiers to take effect. Two whitespaces should be used before the dash (the "-") underneath the idScanOnlyBehaviorOverrides or match3D2DIDScanBehaviorOverrides field.

Method 2 (with Java Class Changes):

For finer control, the Behavior Modifiers can also be modified directly within the FaceTec Server's Java Classes.

To change the Behavior Modifiers for 3D:2D Photo ID Matching (i.e. when the User performs a 3D FaceScan, followed by an ID Scan), update match3D2DIDScanBehaviorOverrides in FaceTecSDK-custom-server-9.X.X\src\main\java\com\facetec\customserver\processors\Match3D2DIDScanProcessor.java as demonstrated below:

Replace:

FaceTecBehaviorOverrides[] match3D2DIDScanBehaviorOverrides = FaceTecServerState.ServerConfig.match3D2DIDScanBehaviorOverrides;
...
Match3D2DIDScanResponse match3D2DIDScanResponse = new Match3D2DIDScanResponse(metadata, additionalSessionData,
    externalDatabaseRefID, match3D2DIDScanResult, match3D2DIDScanBehaviorOverrides);

With:

FaceTecBehaviorOverrides[] match3D2DIDScanBehaviorOverrides = new FaceTecBehaviorOverrides[]{<MODIFIER_1>, <MODIFIER_2>, <MODIFIER_3>,...});
...
Match3D2DIDScanResponse match3D2DIDScanResponse = new Match3D2DIDScanResponse(metadata, additionalSessionData,
    externalDatabaseRefID, match3D2DIDScanResult, match3D2DIDScanBehaviorOverrides);

To change the Behavior Modifiers for Standalone ID Scans, update idScanBehaviorOverrides in FaceTecSDK-custom-server-9.X.X\src\main\java\com\facetec\customserver\processors\PhotoIDScanProcessor.java as demonstrated below:

Replace:

FaceTecBehaviorOverrides[] idScanBehaviorOverrides = FaceTecServerState.ServerConfig.idScanOnlyBehaviorOverrides;
...
PhotoIDScanResponse photoIDScanResponse = new PhotoIDScanResponse(success, metadata, additionalSessionData,
    photoIDScanResult, idScanSecurityChecks, idScanBehaviorOverrides);

With:

FaceTecBehaviorOverrides[] idScanBehaviorOverrides = new FaceTecBehaviorOverrides[]{<MODIFIER_1>, <MODIFIER_2>, <MODIFIER_3>,...});
...
PhotoIDScanResponse photoIDScanResponse = new PhotoIDScanResponse(success, metadata, additionalSessionData,
    photoIDScanResult, idScanSecurityChecks, idScanBehaviorOverrides);

Important Note: Developers are responsible for understanding how Java Class Behavior Modifiers are implemented and writing their own Custom Code to determine ID Scan experience according to their Business Logic.

Retry & Rejection Modifiers

Logic Flow Modifiers

Important Note: Developers are responsible for understanding all modifiers listed above, examining the API flags returned, and determining if the ID Scan was successful according to their Business Logic.

Important Note: FaceTec does not recommend Skipping the OCR Confirmation Screen, as it provides an interface where Users can perform small corrections, such as in cases where they change their legal name or address. This data is also useful to help catch potential fraudsters who subvert or abuse this feature by intentionally altering names, dates, and other fields, allowing Customers and Partners to add more layers of security to their process.