Biometrics & Credentials

Biometrics & Credentials

This section covers fingerprints, faces, cards, irises, and user photos. The API pattern is very similar for each.

Fingerprints

• Object:

  {
    "user_id": "string",
    "finger": "RightIndex" | "LeftThumb" | ...,
    "template": "base64-encoded-ansi/iso-template"
  }
  

• Topics:
  • Save to one device: <company-code>/server/<serial-number>/fingerprints/save
  • Save to all devices for a user: <company-code>/server/<user-id>/fingerprints/save
  • Delete specific fingerprints for a user: <company-code>/server/<user-id>/fingerprints/delete (Message: ["RightIndex", "LeftThumb"])
  • Clear all for a user: <company-code>/server/<user-id>/fingerprints/clear
  • Clear all from one device: <company-code>/<serial-number>/fingerprints/clear

Faces

• Object:

  {
    "user_id": "string",
    "index": 0,
    "template": "base64-encoded-roc-template",
    "thumbnail": "base64-encoded-image"
  }
  

• Topics: (Follow the same pattern as Fingerprints, using /faces/ in the topic path).

Cards

• Object:

  {
    "user_id": "string",
    "facility_code": 1,
    "card_number": 1
  }
  

• Topics: (Follow the same pattern as Fingerprints, using /cards/ in the topic path).

Irises

• Object:

  {
    "user_id": "string",
    "left_template": "base64-string",
    "right_template": "base64-string"
  }
  

• Topics: (Follow the same pattern as Fingerprints, using /iris/ in the topic path).

User Photos

• Object:

  {
    "user_id": "string",
    "user_photo": "base64-encoded-png"
  }
  

• Note: Image must be under 2MB.
• Topics: (Follow the same pattern as Fingerprints, using /userphotos/ in the topic path).