Dashboard SDK - Enable Additional Features (fraud lists, de-duplication, delete, etc.)

Guide for enabling additional features for Dashboard SDK that interact with your FaceTec Server instance.

Overview

The Dashboard SDK offers additional Features when connected to your FaceTec Server with Fraud List and Account De-duplication features enabled, such as:

"Add to Fraud List"

  1. Calls <SERVER_BASE_URL>/enroll to enroll the selected enrollment into the "FraudUserSearchList".
  2. Marks isOnFraudList: true in your database.

"Remove from Fraud List"

  1. Calls <SERVER_BASE_URL>/delete to remove the selected enrollment from the "FraudUserSearchList".
  2. Marks isOnFraudList: false in your database. 

"Mark As Twins"

  1. Marks isTwin: true in your database.

"Delete User Info"

  1. Calls <SERVER_BASE_URL>/delete to remove the selected enrollment from the "FraudUserSearchList", and the "AllUserEnrollmentsSearchList".
  2. Removes all records with the selected externalDatabaseRefID from your database if the enrollment was successfully removed from the "AllUserEnrollmentsSearchList". 

Prerequisites

Connect your FaceTec Server to the Dashboard to enable additional features

  1. Add your FaceTec Server's URL to the Dashboard SDK configuration file.
    1. In your Dashboard SDK's config.yaml file, set serverBaseURL to your FaceTec Server's URL.
      # OPTIONAL
      # Specifies the Base URL of the FaceTec Server.
      # When configured, FaceTecServerDashboard will enable additional features that interact with your Server.
      # "Add to Fraud List"
      #   1. Calls serverBaseURL/enroll to enroll the selected enrollment into the "FraudUserSearchList".
      #   2. Marks isOnFraudList: true in your database.
      # "Remove from Fraud List"
      #   1. Calls serverBaseURL/delete to remove the selected enrollment from the "FraudUserSearchList".
      #   2. Marks isOnFraudList: false in your database.
      # "Mark as Twins"
      #   1. Marks isTwin: true in your database.
      # "GDPR Delete"
      #   1. Calls serverBaseURL/delete to remove the selected enrollment from the "FraudUserSearchList", and the "AllUserEnrollmentsSearchList".
      #   2. Removes all records with the selected externalDatabaseRefID from your database.
      serverBaseURL: https://your.server.sdk.url:8080
  2. If your Dashboard SDK is running on the same machine as your FaceTec Server, referencing "localhost" will not work without additional modifications. See this guide for configuring a container to have access to localhost.