Error Codes#
These are the errors you may get when calling API endpoints.
Remote Operate#
These are the errors you may get when calling the remote operate endpoint.
| HTTP Error Code | Error Category | What likely happened? | User Message in August App |
|---|---|---|---|
| 408 | LOCK UNAVAILABLE | Some sort of timeout, usually a request was sent to Connect to send to the lock and the server didn’t receive a response in a timely manner. There might be multiple reasons behind this, one of them is if the lock stops functioning (for example no power at all) | Lock Unavailable |
| 409 | CONFLICT | In the case of GET /locks/:lockID/status, this indicates the lock has no bridge. |
|
| 412 | PRECONDITION FAILED | Check the error text for the exact precondition that failed, e.g. Lock does not have a bridge associated with it. | |
| 422 | CONNECT UNAVAILABLE | Connect hasn’t connected to our services in a while (usually 3-5 minutes), means that the Connect is offline. | Connect Unavailable |
| 423 | BRIDGE IN USE | The bridge is currently communicating with the lock | Connect Unavailable |
| 460 | LOCK BUSY | The lock is busy talking over bluetooth to something else like a keypad or August App. | |
| 500 | LOCK UNAVAILABLE | Some server error | Connect Unavailable |
| 530 | LOCK UNAVAILABLE | There was a mechanical timeout, usually indicates a jam | Lock Is Jammed |
| 531 | LOCK UNAVAILABLE | There was a problem detecting the mechanical position of the lock, either an uncalibrated lock or a jam. | Lock Calibration Failure |
| 550 | LOCK UNAVAILABLE | Low battery, usually will return when there isn’t enough power to either Lock or Unlock the door. | Low Battery Failure |
| 551 | LOCK UNAVAILABLE | High temperature | Lock Overheated Failure |
| 560 | LOCK UNAVAILABLE | Unexpected disconnect during communication: while processing a command (status/lock/unlock) the lock disconnected abruptly from Connect. | Lock Disconnected |
PIN Management#
These are the errors you may get when calling the PIN management endpoint.
Note: You may also get remote operate errors when calling this endpoint.
Lock Command Timeout#
A command was sent to your bridge and has not received a response or acknowledgment.
How to fix. * Verify connectivity to your device using a remote operate status command * If applicable, check the wired connection (Assure 1 and 2 series) between the front/back case * Power cycle
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 408 | ERRNO_LOCK_COMMAND_TIMEOUT | Yes |
PIN already exists#
The PIN already exists on the lock.
How to fix.
- Use a different PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_ALREADY_EXISTS | No |
Bad state#
The PIN is in a state in which desired action cannot be applied. It cannot transition into desired state from its current state.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_BAD_STATE | No |
Slot must be a number#
body.slot must be a parseable Number
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_SLOT_MUST_BE_NUMBER | No |
Slot not reserved#
A slot was not reserved on the lock for the PIN or its reservation has expired
How to fix. * If using the bridge to load a new or update pin codes, try again. * If using the SDK or apps to create a pin code, you must reserve a pin/slot prior to making the call.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_SLOT_NOT_RESERVED | YES |
Slot out of range#
The PIN slot is outside of the supported range.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_PIN_SLOT_OUT_OF_RANGE | No |
Cannot use reset code#
The PIN cannot be set because it is the keypad's reset code.
How to fix.
- Use a different PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_CANNOT_SET_RESET_CODE | No |
Bad PIN format#
The PIN is too short, too long, or not-numeric characters.
How to fix.
- Use a PIN that is between 4 and 6 numbers long.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_BAD_PIN_FORMAT | No |
Access type mismatch#
This error can occur when updating or deleting a PIN that is already on a lock. The access type you provided did not match the access type of the PIN.
How to fix.
- Use the list lock PINs endpoint to get the correct access type of the PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_ACCESS_TYPE_MISMATCH | No |
Access times mismatch#
This error can occur when updating or deleting a PIN that is already on a lock. The access times you provided did not match the access times of the PIN.
How to fix.
- Use the list lock PINs endpoint to get the correct access times of the PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_ACCESS_TIMES_MISMATCH | No |
Access recurrence mismatch#
This error can occur when updating or deleting a PIN that is already on a lock. The access recurrence you provided did not match the access recurrence of the PIN.
How to fix.
- Use the list lock PINs endpoint to get the correct access recurrence of the PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_ACCESS_RECURRENCE_MISMATCH | No |
Missing PIN#
No PIN was found in the HTTP request body.
How to fix.
- Pass the
pinproperty in the HTTP request body.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_NEED_A_PIN | No |
Invalid PIN slot user#
The user making the API call does not have permission to set the slot on the lock. For example:
- The master PIN on slot-based locks can only be set by the 'master PIN' system user.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_INVALID_PIN_SLOT_USER | No |
Invalid PIN slot#
This error happens when the 'master PIN' system user tries to set a PIN that isn't the master PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_INVALID_PIN_SLOT | No |
Master PIN not supported#
The lock does not support master PIN.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_MASTER_PIN_NOT_SUPPORTED | No |
No keypad#
The lock does not have a keypad.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_LOCK_DOES_NOT_HAVE_KEYPAD | No |
Access type incompatible#
The access type of the PIN is incompatible with the lock.
- Some locks do not support one-time PINs.
- The first generation August Smart Lock does not support temporary or recurring PINs.
How to fix.
- Use a different access type.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_ACCESS_TYPE_INCOMPATIBLE | No |
Invalid PIN state and action#
The state must be load, delete, disable, enable, or update. The action must be intent or commit.
This is an internal error.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_INVALID_STATE_AND_ACTION | No |
PIN not found#
We can't find the PIN. This error can occur when updating or deleting a PIN that is already on the lock.
How to fix.
- Pass the
pinproperty in the request body. - If you're already passing the
pinproperty, we can't find that PIN on the lock. You should create a new one.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 404 | ERRNO_NO_PIN_GIVEN_OR_NOT_FOUND | No |
All slots used#
The PIN could not be loaded because all slots on the lock are used.
How to fix.
- Delete a PIN first.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 409 | ERRNO_ALL_SLOTS_USED | No |
General Internal Error#
Internal Yale service error code
How to fix. * Retry after 5 minutes. If repeat failures appear, notify Yale developer support * If setting a temporary pin, ensure that your start time is less than your end time.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 500 | ERRNO_INTERNAL | Yes and No |
Keycode Mismatch#
Keycode unlock failed OR 2 or 3 part command to set a credential had a pin mismatch between the first and last commands
How to fix. * Stop issuing pin or remote operate commands * Retry after several minutes with only 1 pin command at a time, and increase as needed.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 501 | ERRNO_WRONG_KEY | Yes |
Unsupported Operation On Slot#
Does not support that operation on the requested slot range
How to fix. * Your current FW may not support this operation. Check for FW updates and upgrade if needed
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 502 | ERRNO_NO_BUFS | No |
Keycode Internal Error#
Firmware generated keycode unknown error.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 520 | ERRNO_KEYCODE_UNKNOWN_ERROR | No |
Keycode Slot Mismatch#
Setting/deleting a pin is multipart packet. Inside the packet both the slot and pin code are passed, but are currently mismatched from the existing pin in that associated slot.
How to fix. * Delete and retry
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 522 | ERRNO_KEYCODE_MISMATCH_SLOT | Yes |
Slot In Use#
Slot in use and cannot be written over
How to fix. * Delete this pin and set it again
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 523 | ERRNO_KEYCODE_SLOT_IN_USE | Yes |
Invalid Access Times#
Firmware on desired lock/module rejected schedule sent
How to fix.
* Delete pin/credential, then re-attempt with a corrected schedule.
* Approximate min/max temporary:
* "accessTimes": DTSTART=1970-01-01T00:00:00.000Z;DTEND=2038-01-19T00:00:00.000Z
* Approximate min/max temporary accessTimes:
* "accessTimes": "STARTSEC=0;ENDSEC=86398"
* "accessRecurrence": "FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA"
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 525 | ERRNO_KEYCODE_INVALID_ACCESS | No |
Keycode collision#
Firmware/lock/module generated error; pin already exists on the device possibly in a different slot or is untracked.
How to fix. * Delete pin for that associated user using the API, sdk, or mobile application. * Using the keypad, remove that specific code, then retry
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 526 | ERRNO_KEYCODE_EXISTING_KEY | No |
Keycode memory full#
Too many pin codes/credentials on the lock, a module swap has occurred, or there are communication issues with the module and hostLock
How to fix. * If the number of pin/credentials is less than that described in your hostLocks device capabilities: * Re-register module using the instructions for that hostLock using the keypad if using Assure 1 * May require a factory reset and re-setup.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 527 | ERRNO_KEYCODE_NOSPACE | No |
Keycode Timeout#
Firmware/lock/module reported error.
How to fix.
- If single transaction was greater than 20 seconds, retry
- Physically power cycle lock (at least 10 seconds powered down)
- Evaluate if any other pin codes can be put on the device using using the api or sdk. If no, re-register the module if using Assure1
- Ensure hardware connectivity to the keypad by using a known valid non-master pin code.
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 528 | ERRNO_KEYCODE_TIMEOUT | Yes/No |
Lock not authorized#
Module has been unseated while powered or no longer authorized by the hostLock for communications (wireless settings mode)
How to fix. * Power cycle * Re-register module according to instructions for that hostLock
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 556 | ERRNO_LOCK_NOT_AUTHORIZED | No |
Unexpected Disconnect#
The request response cycle for BLE communications is specific and ordered. On failure or out of order/invalid commands, the device will terminate the current operation and report this.
How to fix. * Wait several minutes before retrying. Power cycle if continued failure
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 560 | ERRNO_DISCONNECT | Yes |
Key exchange packet failure#
Before performing operations requiring authentication, cryptographic material is exchanged and validate. During the FIRST stage of validation, if the response packet is invalid, this error will be reported by our servers.
How to fix. * Wait several minutes before retrying
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 561 | ERRNO_CRYPTO_M2LKEYEXCHANGEPAKET | Yes |
Handshake failure#
Before performing operations requiring authentication, cryptographic material is exchanged and validate. During the LAST stage of validation, if the response packet is invalid, this error will be reported by our servers.
How to fix. * Wait several minutes before retrying
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 564 | ERRNO_HANDSHAKE_FAILURE | Yes |
Action not implemented#
BLE operations are multipart sometimes requiring multiple requests and responses in sequence, with required signatures for each. This error is reported when an unexpected packet is received.
Occurs typically if multiple commands (lock/unlock/setPin/status...) are sent in or close to parallel. Additionally exacerbated by manual operations
How to fix. * Wait several minutes before retrying
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 565 | ERRNO_NOT_IMPLEMENTED | Yes |
Bad checksum after decryption#
Upon establishing a secure session with the lock/module, the lock/module has sent an invalid packet for that secure session.
How to fix. * Wait several minutes before retrying
| HTTP Status Code | Error Name | Retryable |
|---|---|---|
| 566 | ERRNO_CHECKSUM | Yes |
Lock Must be Upright#
You can get errors if your lock is not properly mounted. Most locks have a lot of sensors in them, including a sense of orientation. If the lock is not mounted on a door or other vertical surface then it can behave in unexpected ways.