Resources · Integrations

API & third-party integrations

Trigger external actions on check-in — like opening a door — or build your own applications on the NCheck REST API.

Trigger external actions on check-in

NCheck clients can execute an external application or URL on a check-in or check-out event — ideal for access control such as opening doors for authorised personnel.

1

Check-in happens

An employee checks in on an NCheck client; the record is updated on the NCheck server.

2

Configure a peripheral

In the Control Panel, open Device management, create a peripheral configuration and assign it to the device.

3

Action runs

On the event, the device calls the configured executable or URL — opening a door, a barrier, or any other app on the client.

Use the NCheck REST API

Extend NCheck with your own applications that read from and write to the NCheck server.

Get access

Log in to the web Control Panel and create an API access token in Device management. API access requires a username and password.

Available operations

  • Add, list and delete users
  • Update and delete biometrics
  • Get and delete attendance events
  • Get work-hour reports

Developer resources

Full endpoint reference in the API documentation, plus a Postman sample collection.

Developer guideTalk to an integrator

small_c_popup.png

See NCheck in action on your own devices.

Let's talk