Brivo Integration

HqO integrates with Brivo OnAir, a cloud-based access control platform, so tenants can use their phone as a mobile credential at Brivo-compatible readers through the HqO app.

🔑 Customer-scoped API key: Each HqO customer provides their own Brivo API key. This key is unique to your organization — it is not shared across HqO properties or other customers. You enter it in the Partner Portal when setting up your Brivo instance.

Overview

The integration authenticates HqO against your Brivo account using an API key that belongs to your organization. Once configured, tenants activate a mobile credential through the HqO app and use it to unlock doors by holding their phone near a Brivo reader.

Regional availability: North America

Partner Portal Setup

The Brivo API key is entered in the Partner Portal during instance setup. This is a required field — the integration cannot activate without it.

Generating a Brivo API Key

1. Log into your Brivo OnAir account as an administrator.
2. Navigate to Account > API Keys.
3. Click Create API Key.
4. Give the key a descriptive name (e.g., HqO Integration).
5. Copy the generated API key — you will not be able to view it again after leaving this screen.

⚠️ Store your API key securely. If the key is lost or compromised, revoke it in Brivo and generate a new one, then update it in the Partner Portal.

Entering the API Key in the Partner Portal

1. Open the Partner Portal and navigate to your property's integration settings.
2. Select Brivo from the list of available integrations.
3. In the Brivo API Key field, paste the API key you copied from Brivo OnAir.
4. Complete the remaining instance setup fields.
5. Click Save to activate the integration.

Field	Description	Required
Brivo API Key	Your organization's Brivo API key. Customer-scoped — unique to your account, not shared with other HqO customers.	✅ Yes

💡 One API key per customer: Each HqO customer configures their own Brivo API key. If your organization manages multiple properties, confirm with your HqO Implementation Manager whether each property needs a separate key or whether a single organizational key covers all sites.

Tenant Experience

Activating Mobile Access

1. Open the HqO app and navigate to the Mobile Access utility button.
2. Complete the onboarding flow — location services must be enabled.
3. Tap Activate Card.
4. Your mobile credential appears on screen when activation is complete.

⚠️ Note: Bluetooth must be on for mobile access to work. Location services allow the app to detect nearby Brivo readers.

Using Mobile Access

1. Open the HqO app (the app does not need to be in the foreground on all devices).
2. Hold your phone 3–4 inches in front of the Brivo reader.
3. The door unlocks when access is granted.

The app communicates with readers over Bluetooth — it does not require WiFi. This is useful in low-signal areas like elevators and parking garages.

On-Site Testing

Run an on-site test after setup before launching to tenants.

1. Identify 3–5 test users (property team and security personnel are recommended).
2. HqO permissions the test users to see the Mobile Access utility button.
3. Confirm each test user is entered in Brivo OnAir with the correct access levels.
4. Test for approximately one week across all target readers.
5. Report results to your HqO Implementation Manager.

Frequently Asked Questions

Where do I find my Brivo API key? In Brivo OnAir, go to Account > API Keys. If you don't see this section, contact your Brivo account administrator — you may need elevated permissions.

Can the same Brivo API key be used for multiple HqO instances? This depends on how your Brivo account is structured. Contact your HqO Implementation Manager to confirm the correct scoping for your organization.

What happens if I regenerate my Brivo API key? The old key stops working immediately. Update the Brivo API Key field in the Partner Portal as soon as you generate the new key to avoid an integration outage.

Is the Brivo API key shared with other HqO customers? No. Your Brivo API key is customer-scoped — it belongs to your organization only and is not visible to or shared with any other HqO customer.

Tenants can't activate their credential? Confirm that:

1. The Brivo API Key in the Partner Portal is correct and has not been regenerated in Brivo.
2. The tenant's email exists in Brivo OnAir with a mobile credential assigned.
3. Bluetooth and location services are enabled on the tenant's device.

What device settings are required? Bluetooth must be on. Location services must be enabled — set to Always Allow for the credential to work while the app is in the background.

Need Help?

Contact your HqO Implementation Manager or email appsupport@hqo.co for questions about Brivo setup.

Related

• Mobile Access & Digital Keys — all supported mobile access providers
• HID Integration — HqO's recommended mobile access integration
• Integrations Overview
• Access Control Command Center