Overview

A key bin is an isolated compartment designed to securely store a single set of keys. The bin door automatically opens when a key is being picked up or dropped off.

Bin objects provide information about:

  • The current status of the bin
  • The key stored inside the bin (if any)

The API supports operations to:

  • Retrieve information about individual bins or lists of bins
  • Manually add or remove keys from bins to adjust inventory, which can be useful if the recorded inventory becomes out of sync with the physical state of the SmartBox.

For more information, refer to Managing Key Bin Inventory.