Hello Fingerprint World

If you are seeing this page, it means the fingerprint client and engine are running successfully

Fingerprint API Documentation

POST /enroll

Request

token (string) - Authentication token
data:
- pre_enrolled_index_finger (array of pre_enrolled_finger_data)
- pre_enrolled_middle_finger (array of pre_enrolled_finger_data)

Response

success (bool)
data:
- enrolled_index_finger (string)
- enrolled_middle_finger (string)

POST /is_duplicate

Request

token (string) - Authentication token
data:
- pre_enrolled_finger_data (string)
- enrolled_fingers_data (array of objects)

Response

success (bool)
is_duplicate (bool)

POST /verify

Request

token (string) - Authentication token
data:
- pre_enrolled_finger_data (string)
- enrolled_fingers_data (array of objects)

Response

success (bool)
is_match (bool)
user (enrolled_user_properties, optional)

Types

{
  "token": string,
  "data": {
    "pre_enrolled_finger_data": string,
    "enrolled_fingers_data": [
      {
        "enrolled_index_finger": string,
        "enrolled_middle_finger": string,
        "enrolled_user_properties": object (optional)
      },
      {
        "enrolled_index_finger": string,
        "enrolled_middle_finger": string,
        "enrolled_user_properties": object (optional)
      },
      ...
    ],
    "pre_enrolled_index_finger": [string, string, string, string],
    "pre_enrolled_middel_finger": [string, string, string, string],
    "enrolled_index_finger": string,
    "enrolled_middle_finger": string
  }
}