Error Codes

Error CodeDescription
key.notFoundThe key could not be found.
key.search.forbiddenThe action is only available to authenticated users.
key.already.unlinkedThe key doesn’t have a fob attached that can be unlinked.
key.serialNumber.takenThe serial number provided is linked to a fob already in a Keycafe location.
key.requiredThe key ID was not included in the request.
key.retire.deniedThe key could not be retired. It must first be picked up from the Keycafe location.
key.error.deniedYou are unable to create a new key. Please ensure you have provided a phone number in your account.
key.name.requiredThe key name was not included in the request.
key.description.maxSize.exceededThe key description exceeded the maximum character limit.
key.serialNumber.invalidNo fob with that serial number was found.
key.notes.maxSize.exceededThe key notes exceeded the maximum character limit.
key.pickupNote.maxSize.exceededThe key pickup notes exceeded the maximum character limit.
key.homeLocation.invalidThe specified home location ID is not valid.
key.homeLocation.noAvailableBinsAll bins at the selected home location are full. Another home location should be selected.
key.homeLocation.requiredThe home location ID must be specified if the current user is specified.
key.currentUser.notFoundThe specified current user ID is not valid.
key.currentUser.email.invalidThe specified current user’s email is not valid.
key.currentUser.mobile.invalidThe specified current user’s phone number is not valid.
key.exchange.error.deniedYou do not have permission to exchange this key.
key.exchange.error.inactiveThe key needs to be activated before it can be exchanged.
key.exchange.error.disabledKey exchange testing is disabled.
key.exchange.error.locationThe key must be removed from its current location before it can be tested.
key.exchange.error.fullThe key exchange sandbox location is full.
key.already.linkedThere was an attempt to change the key’s fob assignment while the key, or the new fob, is still checked in.
key.code.not.numericKey codes should be numeric.
key.code.invalid.lengthPlease make sure the key code is between 4 and 16 digits in length.
key.code.takenThis key code is already taken. Please provide a valid key code.
key.code.disabledPlease enable the "Key Codes" setting to use key codes and allow virtual keys.
key.not.virtualA key code can only be added to a virtual key.
key.virtual.checked.inPlease pick up the key before attempting to disable key codes.
key.fob.virtualA key cannot be explicitly linked to a virtual fob.