Fingerspot Developer API
Welcome to the Fingerspot Developer API — a REST API for controlling Fingerspot biometric devices (fingerprint, face, palm vein) from any HTTP client.
Response Pattern
Synchronous operations (get_attlog, get_device) return the full
payload directly in the HTTP response body.
Asynchronous operations return an immediate confirmation
{"success": true, "trans_id": "..."} and deliver the actual result later
via an HTTP POST callback in JSON format to the webhook URL configured for the
target device. The trans_id value in the callback is always the same as the
trans_id sent in the initial request, allowing the client to correlate the
callback with the corresponding request.
Webhook URL
Each device has a webhook URL registered on the platform. Callbacks for
asynchronous operations are delivered via POST to that URL. The webhook URL
is returned in the get_device response and can be updated via the customer
portal.
| Property | Value |
|---|---|
| Base URL | https://developer.fingerspot.io |
| Format | application/json |
| Authentication | Bearer Token |
| Webhook Retry | Configurable |
Real-time Attlog Push
In addition to command-response callbacks, the platform continuously sends
real-time attendance scan events (type: "attlog") to each device's webhook
URL whenever a device sends a scan result — independent of any API call.
Webhook Event Types
The webhook sends callbacks for all asynchronous operations, not just attlog:
| Event Type | Description |
|---|---|
attlog | Real-time attendance event (fingerprint/face/vein scan) |
get_userinfo | Result of a user info query from the device |
get_userid_list | Result of a registered user ID list query |
set_time | Confirmation of device time sync |
set_userinfo | Confirmation of user info add/update |
delete_userinfo | Confirmation of user deletion from the device |
Every callback has a type field describing the event kind, a cloud_id
for device identification, and a trans_id for correlating with the
original request.