Requirements

What your UniFi Access setup needs

Most communities already running UniFi Access at the gate meet the required items. The optional ones decide which self-service features residents get.

RequiredRecommendedOptional

A typical installation

One community, one UniFi gateway, one entrance. The portal lives in our cloud and never touches the gate directly: your gateway makes a secure, private connection to our service, and the console does the opening. Everything below the dashed line is yours and already there in most communities running UniFi Access, installed and maintained by your integrator, never by us.

A community with several entrances or consoles repeats the lower half once per console; each gets its own connection.

Which reader gives residents which feature

All of it is optional. The portal reads what the console reports and shows residents only what their gate can use.

CredentialHardware at the gateWhat residents do in the portal
PINAny UniFi keypad: UA Hub Gate, UA Intercom or a UniFi readerGenerate or choose their own PIN; a shared visitor PIN per address
License plateUniFi Protect AI camera with license plate recognition, linked to AccessAdd, change and remove plates; visitor plates with dates
NFC card or fobA UniFi reader or intercomTap to enroll at a reader the manager allows; relabel or remove later
Toll-tag transponderWiegand transponder reader on a UA Hub Gate or Retrofit HubDrive up once, then claim the recent read in the portal
Gate remote or legacy cardWiegand receiver or reader on a hubRegister the number printed on it, or claim the recent read
Mobile appUniFi Identity Endpoint on the resident's phoneInvitation sent by the portal; unlock from the phone; intercom calls ring the app
Intercom backup phoneUA Intercom with a call list organised by addressSet the number the intercom rings when nobody answers the app

The access control system

The portal talks to UniFi Access and nothing else. If your gate runs on a different system, we cannot connect to it. Your gate must already work: we connect software to it, and your gate service provider keeps it working.

  • UniFi Access on a UniFi OS console

    Required

    A Dream Machine (UDM Pro, UDM SE, UDM Pro Max), Cloud Gateway, Cloud Key Gen2 Plus, Network Video Recorder or Enterprise Fortress Gateway running the Access application.

    • Access 4.x is what we test against. License plate support needs Access 3.3.10 or later; user search needs 3.1.30 or later.
  • Standard UniFi Access, not Identity Enterprise

    Required

    Ubiquiti disables the Access API when a console is upgraded to Identity Enterprise. Stay on standard UniFi Access.

  • An API token with limited scopes

    Required

    Created once per console under Access → Settings → General → Advanced → API Token. The portal needs People & Groups (edit), Credentials (edit), Visitor (edit), Device (view) and System Log (view). It never needs door-unlock, policy, device-edit or webhook scopes.

    • The token is shown once. You paste it into the portal, where it is stored encrypted; we never see it in email or chat.
    • Tokens expire on the schedule you pick when creating them. The portal warns the manager when a console starts rejecting its token.
  • Residents' email addresses in UniFi Access

    Required

    Residents sign in with the email on their Access user record. A person without an email cannot sign in until the manager adds one.

  • One user group per address

    Recommended

    Create a user group per home, named with the house number first (for example “12003 Oak Ridge Ct”), and attach your gate access policy to the groups. The portal reads the group as the resident's address, which is what makes household and visitor features work.

    • Communities that already use one flat list of users still get PIN, plates, cards and app invitations; address features switch on once groups exist.

Reaching the console

UniFi Access only answers on the console's own network; it is not reachable through unifi.ui.com or the Site Manager cloud. The portal therefore uses a secure, private connection to each console, and your gateway makes it.

  • A current UniFi gateway

    Required

    Any current UniFi Cloud Gateway or Dream Machine. The portal provides a connection profile for your console; you import it under the gateway's VPN settings and the gateway connects out to our service. One connection per console. We assume the current UniFi Network and Access releases throughout.

    • Nothing needs to be opened or forwarded at the community, and a changing ISP address does not matter: the gateway connects to us, never the other way round. Works behind a provider's modem, a mesh router or carrier-grade NAT.
    • Only the portal's own traffic uses the connection; none of the community's traffic passes through us.
  • One firewall rule on the gateway

    Required

    The gateway's default rules block the connection until one allow rule exists for it. Two minutes on either the classic or the zone-based firewall, and the portal shows the exact values for your console.

  • A fixed address for a console that is not the gateway

    Required

    When Access runs on a Cloud Key or NVR rather than on the gateway, that device needs a static LAN IP or DHCP reservation so the portal always finds it.

Readers and cameras at the gate

What residents can do for themselves depends on what is installed. Everything here is optional; the portal adapts to what the console reports.

  • A UniFi reader or intercom for PIN entry

    Optional

    UA Hub Gate, UA Intercom or any UniFi reader with a keypad: residents' PINs work wherever the console accepts PINs today. The portal learns the PIN length your console enforces.

  • License plate recognition

    Optional

    A UniFi Protect AI camera with license plate recognition linked to Access, so a plate added in the portal opens the gate.

  • Card, fob, remote and transponder readers

    Optional

    UniFi readers enroll cards by tap. Wiegand devices wired to a UA Hub Gate or Retrofit Hub (gate remote receivers, legacy card readers, toll-tag transponder readers) work too; the portal reads the raw frame and shows residents the number printed on their credential.

    • The manager picks which readers residents may enroll on and can switch self-enrollment off per gate.
    • Toll-tag style transponders are read as the car approaches; residents claim the read instead of pairing live.
  • Intercom directory

    Optional

    If the UA Intercom's call list is organised by address, residents can set the backup phone the intercom rings when nobody answers the app. This uses the console's local administrator login, which you create for the portal with local-only access.

On your side

A few things only the community can provide.

  • Someone with administrator access to the console

    Required

    To create the API token and import the connection profile. Half an hour per console, on a video call with us if you like.

  • A community manager

    Required

    At least one person from the managers or the board who will own the resident list, approve removals and answer residents' questions. They get the management console and a passkey.

  • A way to tell residents

    Recommended

    An email or newsletter announcing the portal. We supply a one-page printable guide and a step-by-step walkthrough you can link to.

Not sure what you have?

Tell us the console model, the Access version shown under Settings → System, and what is at the gate. We will say whether it fits and what setup would involve. No commitment.