Registration flag and pending commands

GET

/device/sync

Called on every button press. Returns whether to start enrolling a fingerprint and any
commands waiting for the device. Read-only: commands stay pending until their result arrives.
Run commands first, then enrol if register is true.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠404UnknownDevice

🟠429RateLimited

Request Example

Shell

JavaScript

Java

Swift

curl --location '/device/sync?device_id=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - enrolAndCommands

{
    "register": true,
    "expires_at": "2026-10-06T13:12:32Z",
    "display_name": "Ada Obi",
    "commands": [
        {
            "id": "c-1a2b3c4d5e6f",
            "type": "delete_uid",
            "uid": 12
        },
        {
            "id": "c-6f5e4d3c2b1a",
            "type": "delete_all"
        }
    ]
}

Modified at 2026-10-07 14:49:40

WebhookDelivery

Report the result of a fingerprint enrolment