Skip to main content

Accessing doors

Doors are the physical structures that allow us to enter or exit a place. To unlock a door, you need to have Kisi already set up, which includes having already created a lock to unlock.

Create a lock#

Create a new lock sending a POST message to the API, containing at least the place_id and the name of the new lock. You can add also a description, latitude and longitude, which restrictions should be applied, the order, floor or integration ids if they apply, and if it's saved as a favorite lock.

Unlock a lock#

To unlock a lock, a POST call to locks/[lock_id]/unlock has to be made. If the lock doesn't have any restrictions, the request body can be void, but if it has restrictions, you will have to provide specific proof that you are complying with the requirements of the restriction, for instance, setting a parameter proximity_proof with a valid value for that restriction.

If you want to unlock one of your locks, you can use the lock_id:

curl -X POST 'https://api.kisi.io/locks/{lock_id}/unlock' \
-H 'Accept: application/json' \
-H 'Authorization: KISI-LOGIN authentication_token'

To know your lock_id, you can query all your locks:

curl 'https://api.kisi.io/locks/?offset=0&limit=10&place_id=9749&favorite=*&sort=favorite' \
-H 'Accept: application/json' \
-H 'Authorization: KISI-LOGIN authentication_token'