Introduction
Developer Docs

Introduction

Everything you need to integrate RFID attendance, access control, and device management into your application.

REST + WebhooksHMAC-signedMulti-tenantJSON API

Welcome

Thanks for building with us

Our API gives you programmatic access to everything you can do in the dashboard — manage devices, users, RFID cards, gate passes, and track attendance in real time. Whether you're building a custom front-end, syncing data to your HR system, or automating workflows, this is the place to start.

Fast to start

Make your first API call in under 5 minutes

Secure by default

HMAC-signed webhooks, JWT auth, and tenant isolation

Multi-tenant

Every request is scoped to your organization

What is this API?

A REST API for attendance & access control

This is a REST API that exposes your organization's attendance, device, and access control data. It speaks JSON over HTTPS and uses JWT bearer tokens for authentication.

Alongside the API you get webhooks — real-time HTTP callbacks when things happen (a user checks in, a device goes offline, an RFID card request is approved).

Base URL
https://api.yourapp.com/v1
Format
application/json
Auth
Bearer JWT
Rate limit
1000 req / 15 min

What you can build

A quick tour of the surface area

How it fits together

A quick architecture overview

Your app talks to our REST API to read and write data. In parallel, our webhook service POSTs events to your server whenever something happens — so you never have to poll.

┌──────────────┐       HTTPS/JSON        ┌──────────────────┐
│  Your App    │ ─────────────────────►  │   REST API       │
│ (Server/SPA) │ ◄─────────────────────  │  /v1/*           │
└──────┬───────┘                         └────────┬─────────┘
       │                                          │
       │                                          │
       │       HTTPS/JSON (webhook)               │
       │ ◄──────────────────────┐                 │
       │                        │                 │
       │                 ┌──────┴──────┐   ┌──────┴─────────┐
       │                 │  Webhooks   │   │   Database     │
       └────────────────►│  Service    │◄──│  (MongoDB)     │
                         └──────┬──────┘   └────────────────┘
                                │
                                │ subscribes to events
                                ▼
                         ┌──────────────┐
                         │  Event Bus   │
                         └──────────────┘
Synchronous

REST calls for CRUD operations

Asynchronous

Webhooks push events to you

Multi-tenant

Every request scoped to your tenant

Conventions

Things that are true across the whole API

Base URL

All REST endpoints live under a single versioned base path.

https://api.yourapp.com/v1

Authentication

Every request must include a bearer JWT in the Authorization header.

Authorization: Bearer <your_token>

Request format

Send JSON with the Content-Type header on any request with a body.

Content-Type: application/json

Success responses

All successful responses follow a consistent envelope.

{ "success": true, "data": { ... } }

Error responses

Errors always include success: false and a human-readable message.

{ "success": false, "error": "..." }

Dates & times

All timestamps are ISO 8601 in UTC.

2026-01-15T10:30:45.123Z

IDs

Entity IDs are MongoDB ObjectIds represented as 24-character hex strings.

507f1f77bcf86cd799439011

Need help?

We're here to help