Introduction

Cams Biometric Gateway — Web API 3.0

The Cams Biometric Gateway is the universal Biometric API that connects any biometric attendance or access control machine with your application — ERP, HRMS, payroll, school management, custom software, or AI/automation workflow. It supports all major device brands and provides a standardised JSON-over-HTTP Biometric API regardless of the hardware.

38 Operations — 11 Callback APIs (Device → Server) and 27 RESTful APIs (Server → Device). All payloads are raw JSON over HTTP/HTTPS.
All biometric machines are supported. Cams machines, verified devices, and third-party brands (ZKTeco, Suprema, Hikvision, Anviz, Morpho/IDEMIA, Virdi, Mantra, Nitgen, Realtime/Startek, Biomax, Secugen, eSSL, Matrix COSEC, and more). Choose the connection mode suitable for your setup.

How It Works

The Biometric Gateway consists of:

Gateway ServerCloud-hosted platform that includes the Cams Protocol Engine (protocol translation, data normalization, offline caching, authentication) and the Standardised API layer that delivers a consistent interface to your application.
Protocol EngineThe core engine within the Gateway Server that communicates with biometric devices, translates vendor-specific protocols, and handles secure data transaction logging and identity management.
Protocol Engine LiteAn on-premise version installable on your own server (Windows/Linux) for LAN-only or self-hosted environments. Same API, deployed locally.

Integrates With

OdooERPNextSAPMicrosoft Dynamics ZohoBitrix24 OrangeHRMBayZatPalmHRuKnowva FedenaTeachmintEduBricz RazorPayPayruler n8nMakeZapier Claude (MCP)GeminiChatGPT Custom Web Apps
Your Application
ERP HRMS Payroll School ERP AI Workflow (n8n, Zapier) MCP — Claude · Gemini · ChatGPT Custom Apps
↑ Callback API Gateway → Your Server (Push)
↓ RESTful API Your Server → Gateway (Command)
Biometric Gateway
Protocol Engine
Secure Auth Processing Data Transaction Logging Protocol Translation Offline Cache & Queue AES-256 Encryption · Auth Token Validation
Standardised API Layer
Identity Management AI / MCP Integration Callback Dispatcher REST Command Router Data Normalization · Multi-brand Protocol Support
Internet
Fingerprint · Face Recognition · Palm Vein · RFID Card · PIN · QR / Barcode · GPS Tracking
Biometric Devices — All Brands Supported
Cams ZKTeco Suprema Hikvision Anviz Morpho / IDEMIA Virdi Mantra Nitgen Realtime Biomax Secugen eSSL Matrix + Many More
All communication is JSON over HTTP/HTTPS  ·  Optional AES-256 encryption  ·  www.camsbiometrics.com
API TypeDirectionLatencyUse Case
Callback APIDevice → Your ServerReal-time / zero latencyReceive attendance punches, user sync events
RESTful APIYour Server → Device~15 secondsAdd/delete users, load logs, enroll biometrics
Introduction

Getting Started

Integrate in three steps. Your server needs a publicly reachable URL to receive callbacks.

1

Configure your Callback URL

Log in to the API Monitor portal. Set your server's public HTTPS URL as the Callback URL for your device(s). The API engine will POST biometric events to this endpoint in real time.

2

Receive attendance punches

Your endpoint receives a POST with a raw JSON body — no query parameters needed for Callback APIs. Validate the AuthToken, parse the punch data, and respond with {"status":"done"}.

3

Call RESTful APIs to manage users & devices

POST a JSON command to the RESTful endpoint URL provided in your API Monitor account, with your stgid (Service Tag ID) as a query parameter. The engine queues the command and the device acknowledges within ~15 seconds.

Endpoint Format

API TypeMethodHow to send
Callback API (inbound) POST Device posts to your configured URL. Raw JSON body; no parameters.
RESTful API (outbound) POST You POST to the RESTful endpoint URL (found in your API Monitor account) with ?stgid=YOUR_SERVICE_TAG_ID and raw JSON body.
Always respond to Callback requests immediately. Your server must return {"status":"done"} (HTTP 200) to acknowledge receipt. Do not perform heavy processing before responding — queue it.
Documentation

API documentation

The reference is split by topic. Start with device compatibility, then the callback and REST operations.

Supported devices and connection modesWhich machines the Gateway supports, how each one connects (Native Push or Hybrid Push), and which API operations are available in each mode. API reference: architecture, fields and status codesThe building blocks shared by every operation: request flow, common JSON fields, template types, status codes, ports and payload encryption. Callback APIs: real-time events from the device to your serverEvery event a device sends to your callback URL, with the JSON your server receives and the response it must return. RESTful APIs: commands from your server to the deviceCommands your server sends to a device through the Gateway, with request and response JSON for each one. Testing the API locallyHow to receive device callbacks on a development machine and test REST commands with Postman before you deploy. PHP example: store biometric attendance in MySQLA working PHP callback handler that stores attendance punches in MySQL, in three steps. AI code-generator promptsCopy a prompt into your AI assistant to generate integration code for your own stack. FAQ, SDK and costCommon questions from integrators, plus how the SDK and API pricing work.
Additional Information

Contact Us

For API support, device compatibility, or sales enquiries:

Sales & Support

Emailsales@camsbiometrics.com
WhatsApp+91-98-409-81006 (Support)
Sales+91-98-409-41006

Developer Resources

Forumforum.camsbiometrics.com
Devicesdeveloper.camsbiometrics.com
Productscamsbiometrics.com/product

Cams Biometrics (Dheeram Innovations Pvt Ltd) — No: 2/98D, 2nd Floor, Cams Biometrics Building, Opposite to Satyabama University, Semmancheri, OMR, Chennai – 600119, India.

Used for

Cashless canteenIdentify every diner by face or fingerprint, deduct the meal subsidy automatically and stop buddy-meals.See the solution →Construction sitesContactless attendance that copes with dust and gloves, feeding your ERP and payroll.See the solution →Fleet, transport and driversVerify driver identity at the depot or in the cab and keep a duty-hour log for your TMS and payroll.See the solution →Forklift and material handlingOnly certified operators can start the vehicle. Every start and every refusal is logged.See the solution →Gyms, clubs and fitnessHands-free member check-in, membership validated, turnstile or door opened.See the solution →Visitor managementFace check-in at reception with access that expires automatically and a full audit log.See the solution →Schools, colleges and campusHands-free student and staff attendance, synced to your school software in real time.See the solution →Events, festivals and stadiumsFace or wristband entry wired to turnstiles and barriers, with a live headcount per gate.See the solution →