Minop Web API: JSON Reference

Programmatically manage enrollment, logs, and configuration. All commands should be sent as POST requests to your device's unique API endpoint.

Start Free Trial View API Docs
Developer Integration Note:

Base URL: https://{device_ip_or_cloud_url}/api/v1/execute

Headers: Content-Type: application/json | Authorization: Bearer {your_token}

Data Type Legend

Before executing commands, refer to these standardized integer mappings used across the API:

UserTypeMeaning
1Standard Employee
14Device Administrator
0Guest / Temp
InputTypeMeaning
1Fingerprint
15Face Recognition
4RFID Card

1. User Management Operations ( On request)

Use these commands to sync your HRMS/ERP database with physical biometric terminals.

1.1 Add a User (Basic)

Creates a user profile on the terminal without biometric templates.

{
    "CommandName": "Add",
    "CommandEntity": "User",
    "OperationData": {
        "UserID": "123",
        "FirstName": "John",
        "LastName": "Doe",
        "UserType": "1"
    }
}

Expected Response: {"status": "done"}

1.2 Add User with Face Template

Enroll a user remotely by sending pre-captured Base64 biometric data.

{
    "CommandName": "Add",
    "CommandEntity": "User",
    "OperationData": {
        "UserID": "123",
        "FaceTemplate": "BASE64_ENCODED_FACE_DATA"
    }
}

2. Delete Operations ( On request)

Warning: These operations are destructive and cannot be undone via API.

2.1 Delete a Specific User

{
    "CommandName": "Delete",
    "CommandEntity": "User",
    "OperationData": {
        "UserID": "123"
    }
}

2.2 Clear Attendance Logs

Deletes logs within a specific date range to free up device memory.

{
    "CommandName": "Delete",
    "CommandEntity": "AttendanceLog",
    "OperationData": {
        "StartDate": "2026-01-01",
        "EndDate": "2026-01-31"
    }
}

3. Real-Time Callbacks (Webhook) ( On request)

Configure your listener URL in the Minop Dashboard to receive these automated "Push" events from the device.

3.1 Real-Time Punch Log (Device to Server)

The device will POST this payload to your server the moment a user scans.

{
  "stgid": "device001",
  "UserID": "123",
  "LogTime": "2026-01-08 17:30:00",
  "Type": "1",
  "Temperature": "36.5",
  "FaceMask": "1"
}

Required Server Response: "ok"

4. Access Control ( On request)

Manage physical security and door-unlock permissions.

4.1 Update User Access Schedule

{
    "CommandName": "Update",
    "CommandEntity": "AccessTime",
    "OperationData": {
        "UserID": "123",
        "AccessStartTime": "08:00:00",
        "AccessEndTime": "18:00:00",
        "AccessDays": "1,2,3,4,5"
    }
}

Note: Custom APIs can be developed on a chargeable basis. For detailed requirements, feasibility, and pricing, please connect with our sales team for further clarification. Please note that some API features are subject to device capabilities and limitations.

Technical Support & Sandbox Access

Contact Us