Home / API reference

The Biometric Gateway API

One contract for every device. 38 operations across five capability groups, available as synchronous REST calls and real-time Callback webhooks.

🌐

Base URL

All REST calls are made to a single versioned host.

https://api.camsunit.com/v3/

🔑

Authentication

Every request carries an AuthToken scoped to your account and device. Keys are issued from the developer portal.

📦

Format

Form-encoded or JSON requests. Responses are JSON with predictable fields and error codes.

Two ways to integrate

REST when you ask. Callback when it happens.

REST

Request / response

You call the gateway and get an immediate answer. Perfect for fetching attendance, listing users, enrolling someone or opening a door on demand.

  • Synchronous & predictable
  • Great for syncs, reports and admin actions
  • Works from any language or cURL
CALLBACK

Real-time webhooks

Register a URL and the gateway pushes events to you the instant a device reports them — no polling, with automatic retries on failure.

  • Instant attendance & status events
  • No cron jobs, no missed punches
  • Retries until your endpoint acknowledges

Operations

All 38 operations

Grouped by what they do. Names map 1:1 to the underlying gateway endpoints.

📊

Attendance · 8

GET
GetAttendanceByDate

All punches within a date range across the account.

GET
GetAttendanceByEmployee

Logs for a single employee code over a period.

GET
GetAttendanceByDevice

Punches captured by one device serial number.

GET
GetAttendanceSummary

Per-day, per-employee summary (in/out, hours).

GET
GetFirstInLastOut

First-in / last-out pair per employee per day.

GET
GetTodayAttendance

Live snapshot of today's punches.

GET
GetAttendancePhoto

Capture photos attached to a punch, where supported.

GET
ExportAttendance

Bulk export for payroll & reconciliation.

👤

Users & enrolment · 12

POST
AddUser

Create a user on one or more devices.

POST
UpdateUser

Edit name, role, validity or privileges.

POST
DeleteUser

Remove a user from a device.

GET
FindUser

Look up a user by code, with optional credentials.

GET
ListUsers

Enumerate everyone enrolled on a device.

GET
ListUserDevices

Show which devices a user exists on.

POST
EnrollFingerprint

Push a fingerprint template to the device.

POST
EnrollFace

Register a face template where supported.

POST
EnrollCard

Assign an RFID / proximity card to a user.

POST
SetUserPassword

Set or change a device PIN / password.

POST
CopyUsers

Clone users & templates between devices.

POST
ResendUser

Re-deliver a user's data to a device queue.

🔒

Access control · 5

POST
OpenDoor

Trigger a door relay remotely in real time.

POST
LockDoor

Lock / hold a door under your control.

GET
GetDoorStatus

Read the current open / closed state.

POST
SetAccessSchedule

Define time-based access windows.

GET
GetAccessEvents

Entry / exit and door events log.

📡

Device management · 8

GET
ListDevices

Inventory of every connected device.

GET
GetDeviceInfo

Model, firmware, capacity and counters.

GET
CheckDeviceHealth

Online state, last-seen and queue depth.

GET
PingConnection

Confirm reachability of a device now.

POST
SyncDeviceTime

Align device clock with the server.

POST
RebootDevice

Restart a device remotely.

POST
ResetDeviceQueue

Clear stuck commands from the queue.

GET
GetCommandStatus

Track the state of a queued command.

🔌

Real-time, callback & system · 5

POST
RegisterCallback

Subscribe a webhook URL for live events.

PUSH
attendance.new

Fired on every punch, in real time.

PUSH
device.status

Online / offline & health transitions.

PUSH
enrollment.update

Confirmation when a template lands on a device.

GET
MigrationStatus

Track bulk device / data migration progress.

Predictable responses

Status codes you can switch on

CodeMeaningWhat to do
200SuccessProcess the JSON payload.
401Invalid or missing AuthTokenCheck the API key and device pairing.
404Device or user not foundVerify the serial number / employee code.
409Device offline / queuedCommand is queued; poll GetCommandStatus.
429Rate limitedBack off and retry with jitter.

Ready to call your first endpoint?

The quickstart walks you from API key to your first attendance log in minutes.