> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zerv

> Connect Zerv to KODE OS for access control data

> Connect Zerv to KODE OS for access control data integration

## Overview

Use this integration to connect Zerv smart-lock and reader environments to KODE OS. You can discover devices and points, then monitor access status, mobile credentials, and related operational data across your sites.

| Property            | Value          |
| ------------------- | -------------- |
| **System Type**     | Access Control |
| **Communication**   | REST           |
| **Collection**      | Pull           |
| **Collection Mode** | SNAPSHOT       |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Non-Sensor Data

## Prerequisites

* An active account with Zerv and access to their API or developer portal
* Username and password credentials for the Zerv system
* KODE OS environment with access to Data Sources

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Zerv**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field        | Required | Type     | Description                                              |
| ------------ | -------- | -------- | -------------------------------------------------------- |
| **Room**     | No       | text     | The specific room this connector is associated with      |
| **URL**      | Yes      | text     | The base URL or IP address of the external system        |
| **Username** | Yes      | text     | The username for authenticating with the external system |
| **Password** | Yes      | password | The password for authenticating with the external system |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Zerv system and return a list of available devices and their data points.

Review the discovered items and select the devices you want to register in KODE OS.

For more details on the discovery process, see the [Discovery guide](/products/integrations/capabilities/discovery).

## Devices and Points

When you discover devices from Zerv, KODE OS maps them to the following device types and data points:

### doorLock

Canonical Type: `doorLock`

| # | Point    | Description                                                    | Unit | Writable | Collection |
| - | -------- | -------------------------------------------------------------- | ---- | -------- | ---------- |
| 1 | `Active` | **True** -- device is active / **False** -- device is inactive | --   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including Active, collected at regular intervals from connected devices

### Audit Logs

Access and security event records including badge swipes, door access events, person identification, timestamps, and access results

KODE OS maps the collected data to these standard fields:

| KODE Field          | Description                                     |
| ------------------- | ----------------------------------------------- |
| **ID**              | Unique log entry identifier                     |
| **Description**     | Event description                               |
| **Person Name**     | Name of the person involved                     |
| **Credential ID**   | Badge or credential identifier used             |
| **Credential Type** | Type of credential (e.g., Card, PIN, Biometric) |
| **Role**            | Access role or clearance level                  |
| **Type**            | Event type (e.g., Entry, Exit, Denied)          |
| **Result**          | Access result (Granted, Denied, Error)          |
| **Access Point**    | Door or access point name                       |
| **Location**        | Physical location of the access point           |
| **Access Time**     | Timestamp of the access event                   |
| **Created At**      | Timestamp when the log was recorded             |

### Polling Schedule

* **Point History** -- Default polling: 1 days (min: 1 days, max: 1 days)
* **Audit Log** -- Default polling: 1 hours (min: 1 hours, max: 1 days)

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Use Cases

Once connected, this integration enables you to:

* Centralize access event monitoring across all entry points and zones
* Generate audit trails for security compliance and investigation
* Correlate access patterns with occupancy and energy data for building optimization

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Verify the username and password are correct and the account has not been locked in the Zerv system.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Zerv system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="Data collection stops or gaps appear">
    Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Zerv API.
  </Accordion>
</AccordionGroup>