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

# Verkada

> Sync access control events — badge entries and door activity — to analyze workplace presence and attendance.

Verkada's Access Control API suite lets us pull badge and door activity from your sites — who entered, where, and when — to power reporting on workplace presence and attendance. You'll create an **API Key** in Verkada Command and paste it into our connection form. You'll need **Organization Admin** access in Command to create the key.

<Info>
  **Admin access required.** Only Organization Admins can create API Keys in Command — if you don't see a **Verkada API** tab under Organization Settings, ask your Verkada admin to either create the key or grant you Org Admin access.
</Info>

## Create an API Key in Command

* Log in to [Verkada Command](https://command.verkada.com) and go to **Organization Settings → Verkada API**.
* Click **+ New API Key**.
* Give it a name, e.g. `Human Intelligence Data Sync`.
* Under **Permissions**, grant **Read-only** access to **Access Control Endpoints** only — this is the exact scope Verkada's own docs specify for the Access Events API (see below for what it reaches). Leave every other product line (Cameras, Sensors, Guest, Alarms, etc.) unchecked, and grant no **Critical Endpoint** permissions — those cover things like the Streaming API and Camera Audio API, which a read-only access-events sync never touches.
* Set an **expiration** for the key. Verkada allows up to 20 years, but Verkada's own security guidance recommends no more than 1 year, since rotating keys regularly reduces risk.
* Click **Generate Key** and copy the value immediately.

<Warning>
  **The key is shown only once.** Command displays the full API Key exactly one time, right after you click Generate Key. If you navigate away before copying it, you'll need to generate a new key — API Key permissions also can't be edited after creation, so double-check the scope above before generating.
</Warning>

## What this key gives us

The key you just created is scoped to **Access Control Endpoints, read-only** — it cannot view footage, control doors, or modify anything in your organization. This gives us access events (door entries via keycard, mobile NFC, or BLE unlock, and similar), access users, and door/site metadata, filterable by user, device, and site — the entire dataset behind workplace presence and attendance reporting; without it there is nothing to sync.

## Find your API region

At account creation, Verkada assigns your organization to one of five regions, and your API Key only works against that region's host — pasting the wrong one will make every request fail.

| Region | API Base URL |
| - | - |
| United States (default) | `https://api.verkada.com` |
| Additional US region | `https://api.oh.verkada.com` |
| Europe | `https://api.eu.verkada.com` |
| Australia | `https://api.au.verkada.com` |
| GovCloud | `https://api.verkadagov.com` |

**How to find your region:** Verkada's [Service Regions guide](https://apidocs.verkada.com/reference/service-regions) confirms the region is fixed at account creation and can't be changed, but doesn't expose it in a self-service Command settings page — its own pointer for "recalling" your region leads to a generic getting-started article with no region information in it. The reliable ways to confirm yours:

* Ask whoever originally set up your organization's Verkada account — they'll know which region it was provisioned in.
* Ask your Verkada account manager or [Verkada Support](https://help.verkada.com) to confirm it directly — this is the same detail they'd reference for network/firewall configuration questions.
* If your organization is based in the US and you didn't select a different region at signup, `https://api.verkada.com` (the default) is very likely correct.

## Enter your credentials

* Click **Connect** above to open the connection form.
* Paste your **API Key** into the **API Key** field.
* Paste your region's **API Base URL** from the table above.
* Click **Connect** to save.

## Security and API details

| | |
| - | - |
| Authentication | API Key, automatically exchanged behind the scenes for a short-lived API Token — Verkada's own two-factor scheme |
| API base URL | Region-specific — set at connection time from the table above |
| Data accessed | Access Control Endpoints only (access events, access users, door/site metadata), via Verkada's Access API. No camera footage, audio, or device control. |
| Access | Read-only — no write, unlock, or configuration endpoint is ever called |
| Token lifetime | API Token: 30 minutes per Verkada's API, refreshed automatically behind the scenes so you never re-enter anything. API Key: the expiration you set at creation — Verkada recommends 1 year or less. |
| Credential storage | Encrypted at rest and scoped to your organization; all traffic runs over TLS 1.2/1.3, per Verkada's own security standards. |
| Revoking access | In Command, go to Organization Settings → Verkada API, where an Org Admin can manage your API Keys — or disconnect from Integrations → Verkada here. |

Questions? Contact us at [support@humanintelligence.com](mailto:support@humanintelligence.com).
