Alcatraz Integration Setup

This guide walks through configuring Alcatraz face authentication and managing face credentials.

Updated April 16, 2026

1. Generate API Key (Alcatraz Portal)

  1. Log into the Alcatraz Portal
  2. Generate an API Key
  3. Copy the API key

2. Configure Alcatraz in the Security Management Software

  1. Navigate to:
    Configuration → System Settings
  2. Locate the Alcatraz Configuration section
  3. Paste the API key into the API Key field
  4. Enable the integration:
    • Switch Enabled to ON
  5. Click Save
  6. After a few seconds, a status label will appear next to the API Key, indicating whether the key is valid

3. Assign Card Format

Each access controller connected to an Alcatraz reader must use the correct card format.

  1. Navigate to:
    Hardware Manager
  2. For each applicable controller:
    • Assign the 37-bit IMRON Corporation card format

4. Adding Face Credentials (Per Person)

  1. Navigate to:
    Personnel Manager
  2. Select a person
  3. Click the Credentials tab
  4. Under Credential Commands, select:
    Add Face Credential

Requirements:

  • First Name
  • Last Name
  • Email Address

Once submitted:

  • An email invitation is sent to the user
  • The user completes self-enrollment (takes only a few seconds)

After enrollment:

  • The user can authenticate at any Alcatraz reader in the system

Important:

  • Only one face credential per person is allowed

5. Deleting a Face Credential

  1. Navigate to:
    Personnel Manager
  2. Select the person
  3. Go to the Credentials tab
  4. Locate the face credential
  5. Open the credential menu and select:
    Delete Credential

6. Bulk Add / Delete Face Credentials

Bulk operations are available but should be used carefully.

  1. Navigate to:
    Configuration → System Settings
  2. Go to the Personnel tab
  3. Locate the Alcatraz Configuration section
  4. Use:
    • Bulk Add Face Credentials
    • Bulk Delete Face Credentials

⚠️ Warning:

Bulk commands are typically used only during initial system setup or commissioning.

Use extreme caution, as these actions affect all personnel records.

Summary

  • API Key connects the Security Management Software to Alcatraz
  • Card format must be set correctly (37-bit IMRON)
  • Users enroll via email invite
  • Face authentication is seamless after enrollment
  • Bulk actions should be used sparingly
Was this article helpful?