---
title: "MicroKey integration"
slug: "microkey-integration"
updated: 2023-04-14T09:22:29Z
published: 2023-04-14T09:22:29Z
canonical: "support.reconeyez.com/microkey-integration"
---

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

# MicroKey integration

MicroKey integration is implemented by using XML Micro Key Driver ver 1.8. Message data format supported: Contact ID. Supervision messages are dispatched to the default account identification.

**Information necessary to set up integration:**

- Server IP address and port
- Default account identification:
  - Reciever number (RN) (length 0-6)
  - Line number (LN) (length 0-6)
  - Account (ACC) (length 3-16)
  - Area (A) () (length 0-2)
  - Physical Zone (PZ) (length 0-3)
- In case TLS used:
- SSL certificate (if self-signed cert used)

**Description field format:**

Microkey:<Rrcvr><Lline>#<Account><|area><-zone>

where: <Rrcvr> optional, limited to 'R' + 0-6 characters <Lline> optional, limited to 'L' +0-6 characters <Account> mandatory and limited to 3-16 characters <|area> optional, limited to '|' + 0-2 characters <-zone> optional, limited to '-' + 0-3 characters

Examples: # Full account identification including receiver and line numbers and account ID in addition to account and zone: *Microkey:R123456L123456* #1234567890123456|12-123# Account identification with account ID '9999' and zone ID '1': *Microkey:#9999-1* # Only account identification specified: *Microkey:#9999*

Description field siteID will overwrite the default siteID. In case no default siteID is provided, alarms will be forwarded only after the Description field siteID is saved for the device in the Reconeyez cloud.

**Supported event types:**

| **Reconeyez** | **MicroKey** |
| --- | --- |
| SystemStarted | - |
| SystemStopped | - |
| PersonDetected | E130 Burglar alarms |
| VehicleDetected | E130 Burglar alarms |
| MovementDetected | E130 Burglar alarms |
| RoutineControl | E602 Periodic test report |
| Tamper | E137 Tamper |
| Armed | R400 Restore open/close |
| Disarmed | E400 New open/close |
| ConnectionLost | E350 Communication Trouble |
| DeviceConnected | R350 Restore communication trouble |
| BatteryLow | E302 Low system battery |
| BatteryRestored | R302 Restore Low system bat |
| CriticalBatteryShutdown | E308 System shutdown |
| BatteryRemoved | E311 Battery missing dead |
| LidOpened | E137 Tamper |
| AuxPowerLost | E301 AC loss |
| AuxPowerFound | R301 AC loss restoral |
| IntBatChargingFault | - |
| IntBatChargingNormal | - |
| Snapshot | - |
| GenericAlarm | - |