Skip to content

Remote Enrollment

Enrollment (Remote Start)

You can remotely initiate the credential enrollment process on a device. The device will provide real-time feedback.

Enroll Fingerprint

  1. Start Enrollment:
    • Topic: <company-code>/<serial-number>/enrollfingerprint/start
    • Message: { "user_id": "101", "finger": "RightIndex" }
  2. Listen for Events:
    • Topic: <company-code>/<serial-number>/fingerprintenrollmentevent
    • Event Message: Provides real-time status like PlaceFinger, RemoveFinger, Success, or Failure.
      {
        "fingerprint_enrollment_event": "Success",
        "step": 3,
        "fingerprint": {
          "user_id": "101",
          "finger": "RightIndex",
          "template": "Rk1SACAyMAAHkQA1ABcAAAEEA"
        },
        "failure_reason": "None"
      }
      
  3. Stop Enrollment (Optional):
    • Topic: <company-code>/<serial-number>/enrollfingerprint/stop