> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/verkada-integration-setup.md).

# Verkada Integration Setup

### Getting Started

Use this guide to connect Verkada to your BalkanID tenant. You will need credentials from Verkada Command and access to the Integrations section in BalkanID.

{% hint style="info" %}
Only Verkada Organization Admins can create API keys, and an organization can hold a maximum of 10 keys. The key is displayed only once, when you generate it.
{% endhint %}

#### Requirements:

Before you begin, collect the following values from Verkada:

* **API Key**
* **API Region (us, oh, eu, au or gov)**

### Configure Verkada within your BalkanID tenant

1. To find the API Key, sign in to Verkada Command as an Organization Admin.
2. Navigate to Organization Settings > Verkada API.
3. Click **+ New API Key**, give the key a name, and set an expiration.
4. Under Permissions, enable the scopes listed in [Integration Scopes](#integration-scopes) below, then click **Generate Key**.
5. Copy the key and store it somewhere safe. Verkada displays it only at this moment and it cannot be retrieved later.
6. Note the region your Verkada organization was created in. A credential is bound to one region and cannot be moved, so a region that does not match will fail to authenticate.
7. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FrnhphS79Lr8yHaFvpYSF%2Fverkada-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Integrations</p></figcaption></figure></div>

8. Search for Verkada, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2F6G4xjTe9syaDmziRv6wG%2Fverkada-connect-new-application.png?alt=media" alt="The Connect a new application step with Verkada searched for and selected"><figcaption><p>Connect a new application</p></figcaption></figure></div>

9. Set the Primary application owner and, optionally, a Description and Secondary application owner(s).
10. Under **Select Extraction Type**, keep **Direct Configuration** selected and paste your values into **API Region (us, oh, eu, au or gov)** and **API Key**, then click **Next.**

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FMozhqYhf6gVHoxY9GHdT%2Fverkada-direct-configuration.png?alt=media" alt="The Direct Configuration fields showing API Region and API Key"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

11. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step showing Reviewer Settings and fulfillment options"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

12. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### Integration Scopes

Verkada API keys are scoped per product. Grant both of the scopes below when you generate the key: a key with only Access Control returns users and groups, but no access levels.

| Read Only Scopes                                                                           | Lifecycle Management Scopes |
| ------------------------------------------------------------------------------------------ | --------------------------- |
| **Access Control (Read-only)** — access users, access groups, and group membership         | N/A                         |
| **Door Access Management (Read-only)** — access levels, and the doors and sites they grant | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/verkada-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.