Face ID - API Workflow

Facial Identification API and Facial ID Overview

This article will summarize how Facial ID works within our application and provide you with the FID error codes.

Four Parties Involved in Facial ID Cases:

  1. CustomerThis is the person who pays monthly for the subscription service to access hdfleet.net and has requested the add-on service called Facial ID.

  2. HD Fleet ApplicationThis is the application that stores the trip data, provides a graphical interface for customers to interact with, and access to the Facial ID API.

  3. EdgeTensor Facial ID APIThis is an API service that HD Fleet Application interacts with involving Facial ID profiles. No facial ID profiles are stored within the HD Fleet Application, just a Facial ID # that is shared between HD Fleet and EdgeTensor. No driver information is shared with EdgeTensor API, only driver-facing videos, so it can build a unique facial ID profile to videos and convert the videos into unique FID Profiles.

  4. DriverPeople that drive the vehicles, are assigned unique Facial ID profiles, and later linked by the customer to the Facial ID #.

FID Error Codes:

  1. N/A - No response from FID Video Processing Matching Servers.  It must have exceeded the 10-minute wait time we have set for maximum returned results.  No action is needed from the customer, but operations will be notified to review whether the FID Application is functioning.

  2. 116 - The video was not good enough to render a FID Profile #.

  3. 113 - The video was obstructed by something and no FID Profile could be created or matched in the system.

    Note
    This is a Facial ID workflow at a high level

How to Enable Facial ID:

  1. Contact us or your local reseller in your area. We will turn on the feature or enroll you in the Facial ID program for up to 4 weeks.
    Note
    The link to enable FID by reseller is in your secure portal.

  2. To turn it on within our application, go to Settings, then click Customers.



  3. Find the customer you want to enable Facial ID for and click the Edit button.



  4. Check the box that says EdgeTensor API to enable it.



After enabling the API, you have to enroll the vehicles you want to participate in the Facial ID program. The vehicles must have a properly mounted camera and the drivers must sign a 'Facial Release Document' since facial features and measurements will be collected and secured for future Facial ID matching.
Warning
Make sure you are legally allowed to collect data from your employees.

How to Enroll Your Vehicles:

  1. Within our platform, go to Settings, and then Vehicles.


  2. Edit the vehicle you would like to enroll.



  3. Change the slider named Driver ID Enabled to Yes. The other items should default to Enrollment and Disabled.


    Note
    When Driver ID is enabled, the default driver is cleared, if set prior. It is neither unassigned nor unrecognized. It will go blank or state that Facial ID is enabled.

    Now that Facial ID is enabled and your vehicles are enrolled, it's time to review your drivers. It will take a few days for the API to start assigning Facial ID #'s to your active trips, but it will need to match the drivers it sees to the drivers that are on the platform. If you need help creating drivers, check out this article.

How It Works:

  1. All trips for the enrolled vehicles send up to 3 videos per trip to the EdgeTensor API for enrollment and then verification.

  2. The vehicle will stay in the enrollment phase until a Facial ID # is returned for that vehicle.

  3. After a Facial ID # is returned, it moves from Enrollment to Verification status, notifying our platform that the vehicle has met the minimum requirements to acknowledge future drivers.

A report can be run to determine the state of the vehicle's Facial ID status to assist in the deployment and rollout of the program.

Facial ID Report:

  1. From our platform, go to Reports and find Facial ID API Status.

  2. In the Driver ID Enabled column, there are 6 possible states.

  3. Facial ID - Calibrating.
    Note
    In this state, it may take a while for the API to identify the driver. We will attempt to identify the Facial ID # for this trip, however, after 3 attempts, it will move from unrecognized to unassigned and await manual assignment. If a Facial ID # is created while being in the Enrollment State, we will provide a Facial ID # and change the state to Verification. Otherwise, there will be an error code in the FID Code column for review.

  4. Facial ID - Identifying.
    Note
    The system is attempting to identify the driver within the trip, sending 3 videos to the API. If nothing is returned, there will be an error code letting the customer know why a match was not found, and they will have to be manually assigned. If a Facial ID # is returned, then we will attempt to link it to a Driver profile. If there isn't one found, then we will place a link to the Facial Identification Module for future matching to a driver. 

  5. Facial ID #. (It links to the Facial Identification tab)

  6. Driver Name Matched to Facial ID #.

  7. Unrecognized. (It links to the Change Driver pop-up)

  8. Unassigned. (When nothing was able to be linked)
The Cloud AI column contains FID codes and links to the videos that were sent to the EdgeTensor API. The videos may assist you in manually assigning the driver to the trip.

Logic for AI Resolution to Unrecognized Drivers:

  1. All trips that were flagged with Unrecognized Driver would be in your Alert Board and are waiting for manual assignment and marked with a review status as Not Reviewed.



  2. If a trip was identified in the same 24-hour period, then it will assign the same Facial ID for all trips that took place prior with the same ID.
    Note
    The status on the Alert Board will change to Completed and the Driver Assigned will be moved from Unrecognized Driver to the Facial ID #. The same will happen in the Vehicle Pop-up and Reports.

Special Use Cases:

  1. If only 1 Facial ID # was found within the same day, then all previous trips and proceeding trips would be assigned to that Facial ID #.

  2. If 2 or more Facial ID #'s were found on trips throughout the day, then the logic would be all previous trips prior to the Facial ID # being assigned would be assigned to the first facial ID #, and all the proceeding trips would be assigned to the most recent Facial ID #.

  3. If no Facial ID #'s were assigned that day, then the application would keep the trips as unrecognized and is awaiting for them to be assigned manually.

When the Facial Identification module is activated, two alerts are added to the system automatically.

Assigning Facial ID #'s to Drivers:

  1. Alert of Facial ID #'s that need to be matched with Drivers.

  2. Alert for Unrecognized Drivers.
    Note
    Both of these Alerts can be modified to email the end user. We recommend the Facial ID #'s need to be matched to drivers to be notified by email, but not required.

Videos Being Sent to EdgeTensor:

  1. Videos will be sent at 30-second intervals based on ignition on and when the vehicle exceeds 5 mph with a 5-minute gap.

  2. All assignments would be done within 18 minutes at the most.

    • Related Articles

    • Vehicle Pop-Up Overview

      From the vehicle pop-up window, you can view driver snapshots and HD video, live stream your driver's trips, pull up trip history, and check maintenance reminders. View Snapshots and HD Video: Click on either the Snapshots or HD Video tab to pull up ...
    • How to Create a Driver ID QR Code

      These steps will demonstrate how to create a QR code to assign a driver to their respective vehicle within the platform. They will be using the in-cab lens on the dash cam to sign in. Creating a QR Code: To create a QR code for a driver, first login ...
    • Vehicles Help

      The Vehicles page lets you edit vehicle details in your account and access different areas of our tracking interface related to a vehicle's trips. How to Edit a Vehicle's Details Log in to https://hdfleet.net, and click on Settings. From there, ...