Unloc API v2 is now live

Unloc API v2 has now been released. Take a look at the updated guide and api reference. Suggestions and feedback are welcome. There might be minor changes done in the next few weeks if we find anything is wrong or missing.

Unloc API V2 preview

We have decided to release preview documentation of version 2.0 of the Unloc API. Guides and recipes are not ready yet, but feel free to poke around in the API references.

Request a Key is deprecated

We have decided to deprecate the "Request a Key" feature in the Service Provider Api. If you are interested in why or you want to know what we recommend as an alternative, please contact us.

Batch Create Keys

We now have a new endpoint for batch-creating keys. The endpoint accepts an array of key data, formatted in the same way as the regular create key endpoint, and returns a job ID that can be checked using the new async job status endpoint.


Key Duration

  • The create-key endpoint now accept durationMinutes. This means that you can set a start and duration for a key, instead of having to calculate end time yourself.
  • We also fixed a bug where it was not possible to remove address from a lock.

Two new endpoints


Lock Holder Events, format phone number endpoint, and more


New Vendor Connections with the same credentials no longer overwrite existing ones

Creating a new Vendor Connection that reuses the credentials of an existing Vendor Connection no longer disconnects the existing one. Instead, a 409 error is returned.


Get a single Key & Prefetch Keys

  • The Integrator API now includes a Get a single Key endpoint.

  • Service Providers can take advantage of a new App Switch URL: prefetchkeys. Using it will make the Unloc app download all the Keys associated with a user beforehand, instead at the time of opening a Lock. This improves performance by having all the Keys immediately available, and, covers the case where a Lock might be located at a place with poor or no internet coverage whatsoever.


Custom Key metadata

You can now embed custom metadata on Keys you create using the Integrator API.