Errors

When the API returns an error response, it usually contains an error code.

  • AccessGroup

    • AccessGroup.StillHasLocks
      The access group still has locks assigned
    • AccessGroup.StillHasUsers
      The access group still has users assigned

  • Authentication

    • Authentication.Failed
      Authentication failed
    • Authentication.UserEmailNotVerified
      Email address requires confirmation
    • Authentication.UserLocked
      Account locked

  • CreditCard

    • CreditCard.CvcIncorrect
      Credit card CVC incorrect
    • CreditCard.CvcInvalid
      Credit card CVC invalid
    • CreditCard.Declined
      Credit card declined
    • CreditCard.Expired
      Credit card expired
    • CreditCard.ExpiryMonthInvalid
      Credit card expiration month invalid
    • CreditCard.ExpiryYearInvalid
      Credit card expiration year invalid
    • CreditCard.NotWorking
    • CreditCard.NumberIncorrect
      Credit card number incorrect
    • CreditCard.NumberInvalid
      Credit card number invalid
    • CreditCard.ZipIncorrect
      Credit card zip code incorrect

  • Device

    • Device.BrowserRequired
      Browser required
    • Device.LimitReached
      The device limit has been reached, please remove a device before adding a new one (only 1 smartphone, 1 smart card and 1 browser is allowed - for managed users other limits may apply, please check your subscription for more information)
    • Device.SmartCardAlreadyAssigned
      Smart card is already assigned to a user
    • Device.SmartCardAlreadyClaimed
      Smart card already added to an organization
    • Device.SmartCardAlreadyExists
      Smart card already exists
    • Device.SmartCardRequired
      Smart card required
    • Device.SmartCardStillAssigned
      Smart card is still assigned to a user
    • Device.SmartCardSwissPassValidationFailed
      SwissPass validation failed
    • Device.SmartCardUidInvalid
      Smart card UID invalid
    • Device.SmartphonePublicKeyRequired
      Public key required
    • Device.SmartphoneRequired
      Smartphone required
    • Device.StatusUnexpected
      Device status unexpected

  • Gateway

    • Gateway.AlreadyClaimed
      Gateway already added to an organization
    • Gateway.FirmwareUpdateFailedAlreadyInProgress
      The gateway is already updating its firmware, which will take a couple of minutes.
    • Gateway.FirmwareUpdateFailedTimeout
      The firmware update failed because it didn't finish in time. Please try again in a couple of minutes.
    • Gateway.FirmwareUpdateFailedUnableToStart
      The firmware update couldn't be started. Please try again in a couple of minutes.
    • Gateway.FirmwareUpdateFailedUnknownError
      The firmware update failed with unknown error. Please try again in a couple of minutes.
    • Gateway.RemoteMethodCallFailedGatewayGenericError
      There was an unknown gateway error
    • Gateway.RemoteMethodCallFailedGatewayNotReady
      The gateway isn't ready. Please try again in a couple of minutes.
    • Gateway.RemoteMethodCallFailedLockAuthenticationError
      The lock authentication has failed
    • Gateway.RemoteMethodCallFailedLockCommandNotSupported
      The lock command isn't supported
    • Gateway.RemoteMethodCallFailedLockInvalidState
      The lock is in an invalid state
    • Gateway.RemoteMethodCallFailedLockMemoryFull
      The lock memory is full
    • Gateway.RemoteMethodCallFailedLockPermissionNotFound
      No permission could be found on the lock
    • Gateway.RemoteMethodCallFailedLockPermissionNotValid
      Your permission isn't valid at the moment
    • Gateway.RemoteMethodCallFailedLockUnknownError
      There was an unknown lock error
    • Gateway.RemoteMethodCallFailedLockWrongCommandData
      The lock command has wrong data
    • Gateway.RemoteMethodCallFailedPeripheralDisconnected
      The lock isn't connected to its gateway
    • Gateway.RemoteMethodCallFailedPeripheralGenericError
      There was an unknown lock error
    • Gateway.RemoteMethodCallFailedPeripheralLinkLimitReached
      The gateway can't be linked with anymore locks
    • Gateway.RemoteMethodCallFailedPeripheralNotLinked
      The lock isn't linked with a gateway
    • Gateway.RemoteMethodCallFailedPeripheralNotReady
      The gateway or the connected lock do not accept commands at the moment. Please try again in a couple of minutes.
    • Gateway.RemoteMethodCallFailedPeripheralTimeout
      The lock couldn't be reached at the moment. Please try again in a couple of minutes.
    • Gateway.RemoteMethodCallFailedUnknownError
      There was an unknown communication error

  • Generic

    • Generic.BadRequest
      The server rejected a bad request
    • Generic.ConcurrentCommandBlocked
      The action failed because the system is currently busy, please wait a moment and try again
    • Generic.Forbidden
      The server rejected a forbidden request
    • Generic.InternalServerError
      There was an unknown error on the server
    • Generic.NotFound
      The requested resource was not found on the server
    • Generic.PaymentServiceError
      There was an unknown payment service error
    • Generic.Unauthorized
      The server rejected an unauthorized request

  • Group

    • Group.AlreadyExists
      Group already exists

  • HubService

    • HubService.RemoteMethodCallFailedIotHubError
      There was an error while communicating with the gateway
    • HubService.RemoteMethodCallTimedOut
      The gateway couldn't be reached at the moment. Please try again in a couple of minutes.

  • Invitation

    • Invitation.PendingInvitationOfThisTypeAlreadyExists
      This user has already been invited. Please cancel the invitation before sending a new one or resend the existing one. To do this, go to Invitations.
    • Invitation.ReceiverAlreadyJoinedOrganization
      This user has already joined the current organization
    • Invitation.ReceiverNotAllowed
      The invitation receiver is not allowed
    • Invitation.StatusChangeNotAllowed
      The invitation status change is not allowed
    • Invitation.StatusPendingExpected
      Invitation status Pending expected

  • Lock

    • Lock.AlreadyClaimed
      Lock already added to an organization
    • Lock.FirmwareUpdateFailedDownloadFailed
      The gateway couldn't download the firmware update. Please try again in a couple of minutes.
    • Lock.FirmwareUpdateFailedTimeout
      The firmware update failed because it didn't finish in time. Please try again in a couple of minutes.
    • Lock.FirmwareUpdateFailedUnknownError
      The firmware update failed with unknown error. Please try again in a couple of minutes.
    • Lock.NotLinkedWithGateway
      Lock not linked with gateway
    • Lock.ReleaseWithAccessGroupsNotAllowed
      The lock has to be removed from all access groups before it can be removed from the organization
    • Lock.ReleaseWithLockActivationLinksNotAllowed
      All guest access has to be revoked for this lock before it can be removed from the organization
    • Lock.ReleaseWithPermissionsNotAllowed
      All permissions have to be revoked for this lock before it can be removed from the organization (also disable guest access for this lock in the organization settings)
    • Lock.TimerConfigurationLimitReached
      The timer configuration contains too many items
    • Lock.TimezoneRequired
      Lock timezone required
    • Lock.TypeNotSupported
      Lock type not supported

  • LockActivationLink

    • LockActivationLink.AlreadyEnabled
    • LockActivationLink.InvalidDeliveryTypeForPermissionTypeAlways
      Permission type Always can't be sent delayed
    • LockActivationLink.InvalidDeliveryTypeForWeeklyTimeProfileWithoutStartDate
      Permission type time profile with weekly repetition but without a start date can't be sent delayed
    • LockActivationLink.LocksNotEnabled
    • LockActivationLink.NotEnabled
    • LockActivationLink.ReceiverEmailOrPhoneNumberRequired
      Receiver requires an email address or phone number

  • Organization

    • Organization.AlreadyExists
      Organization already exists
    • Organization.EmailBannerFileSizeTooLarge
      The email banner file size must not be larger than 64 KB
    • Organization.EmailBannerSizeInvalid
      The email banner size has to be 1140 x 400

  • Partner

    • Partner.TypeSystemIntegratorRequired
      Partner type system integrator required

  • Permission

    • Permission.ActivationModeNotAllowed
      The activation mode is not allowed
    • Permission.ManagedByAccessGroup
      This permission is managed by an access group and can't be modified directly. Please go to the access groups and modify the corresponding group.
    • Permission.ManagedByAnotherAccessGroup
      One ore more permissions are already managed by another access group.
    • Permission.TimeProfileInvalid
      The permission time profile is invalid
    • Permission.TimeProfileItemsLimitReached
      The permission time profile contains too many items
    • Permission.TimeProfileRequired
      The permission time profile is required
    • Permission.TimeProfileWeeklyItemsLimitReached
      The permission time profile contains too many weekly items

  • ProductionOrder

    • ProductionOrder.ProductionLimitReached
      Production limit reached
    • ProductionOrder.VoucherGenerationDisabled
      Voucher generation disabled

  • Role

    • Role.AlreadyExists
      Role already exists
    • Role.GroupsOrUsersRequired
      Role requires at least one group or user

  • Subscription

    • Subscription.UserLimitReached
      Granting permission failed, because the user limit of your plan was reached (Users with permissions and invited users).

      Please subscribe to another plan

  • User

    • User.AlreadyExists
      A user with this email address already exists
    • User.NewEmailExpected
      Please enter another than your current email address
    • User.StillHasPermissions
      The user still has permissions
    • User.StillHasRoles
      The user still has at least one role assigned
    • User.StillHasSmartCardAssigned
      The user still has at least one smart card assigned
    • User.StillIsInAccessGroups
      The user is still in access groups
    • User.TwoFactorAuthenticationAppOrPhoneNumberAndEmailVerificationRequired
      An authenticator app or phone number and an email address need to be verified
    • User.TwoFactorAuthenticationAppVerificationFailed
      Authenticator app verification failed
    • User.TwoFactorAuthenticationEmailHasToBeDifferentFromAccountEmail
      The primary email address has to be different from the two-factor authentication email address
    • User.TwoFactorAuthenticationEmailInvalid
      Email address invalid
    • User.TwoFactorAuthenticationEmailVerificationFailed
      Email verification failed
    • User.TwoFactorAuthenticationPhoneNumberInvalid
      Phone number invalid
    • User.TwoFactorAuthenticationPhoneNumberVerificationFailed
      Phone number verification failed