Getting Started

Prerequisites

Before you begin, you'll need:

• A PunchConnect account (sign up)
• A ZKTeco-protocol biometric device
• Your device's serial number

How It Works

PunchConnect is a REST API. You interact with it using HTTP requests — no SDK required. Use Postman, cURL, or any HTTP client in your language of choice (PHP, Python, Node.js, etc.).

List Your Devices

Once your devices are registered through the dashboard, use the API to list them and start interacting.

curl https://api.punchconnect.com/api/v2/zk/devices \
  -H "X-CLIENT-ID: your_client_id" \
  -H "X-CLIENT-SECRET: your_client_secret" \
  -H "Accept: application/json"

Authentication

All API requests are authenticated using two headers: your client ID and client secret. Get these from the PunchConnect dashboard.

Error Codes

PunchConnect uses standard HTTP status codes. All errors return a consistent JSON body.

{
  "error": {
    "code": "device_not_found",
    "message": "No device found with serial CZKT2024099",
    "status": 404
  }
}