AccessCodes

Create access codes

POST

/v1/bookings/{id}/accesscode

Generates an access code on each smart lock configured for the property. Codes are valid from the booking's arrival time until its departure time. Partial failures are reported in failed_smartlocks rather than failing the request. Restricted to owners and managers; staff and contractors are rejected.

Create access codes › path Parameters

id

string · required

Booking id

Create access codes › Responses

Access codes created. failed_smartlocks lists any locks the provider rejected.

KeysResponse

accessCode

string · required

BookingAccessCode[] · required

SmartLockInfo[] · required

POST/v1/bookings/{id}/accesscode

curl /v1/bookings/:id/accesscode \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "accessCode": "accessCode",
  "accessCodes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "vendor_code_id": "vendor_code_id",
      "code_start_datetime": "code_start_datetime",
      "code_end_datetime": "code_end_datetime",
      "created_at": "created_at",
      "updated_at": "updated_at",
      "deleted_at": "deleted_at",
      "smartlock": {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name",
        "property_id": "00000000-0000-0000-0000-000000000000",
        "nuki_smartlock": {
          "id": "00000000-0000-0000-0000-000000000000",
          "nuki_smartlock_id": "nuki_smartlock_id"
        },
        "unifi_smartlock": {
          "floor_id": "floor_id",
          "door_id": "door_id",
          "name": "name",
          "assigned_property": {
            "property_id": "00000000-0000-0000-0000-000000000000",
            "property_name": "property_name",
            "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
          }
        },
        "lock_state": 0,
        "battery_level": 0,
        "battery_charging": true,
        "offline": true
      }
    }
  ],
  "failedSmartlocks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ]
}

json

application/json

Delete access code

DELETE

/v1/accesscodes/{id}

Revokes the access code: deletes it from Kasify and from the smart-lock provider (e.g. Nuki, Unifi). Restricted to owners and managers; staff and contractors are rejected.

Delete access code › path Parameters

id

string · required

Access code id

Delete access code › Responses

Access code revoked

No data returned

Account

Kasify API

AccessCodes

Create access codes

POST

/v1/bookings/{id}/accesscode

Create access codes › path Parameters

id

string · required

Booking id

Create access codes › Responses

Access codes created. failed_smartlocks lists any locks the provider rejected.

KeysResponse

accessCode

string · required

BookingAccessCode[] · required

SmartLockInfo[] · required

POST/v1/bookings/{id}/accesscode

curl /v1/bookings/:id/accesscode \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "accessCode": "accessCode",
  "accessCodes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "vendor_code_id": "vendor_code_id",
      "code_start_datetime": "code_start_datetime",
      "code_end_datetime": "code_end_datetime",
      "created_at": "created_at",
      "updated_at": "updated_at",
      "deleted_at": "deleted_at",
      "smartlock": {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name",
        "property_id": "00000000-0000-0000-0000-000000000000",
        "nuki_smartlock": {
          "id": "00000000-0000-0000-0000-000000000000",
          "nuki_smartlock_id": "nuki_smartlock_id"
        },
        "unifi_smartlock": {
          "floor_id": "floor_id",
          "door_id": "door_id",
          "name": "name",
          "assigned_property": {
            "property_id": "00000000-0000-0000-0000-000000000000",
            "property_name": "property_name",
            "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
          }
        },
        "lock_state": 0,
        "battery_level": 0,
        "battery_charging": true,
        "offline": true
      }
    }
  ],
  "failedSmartlocks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ]
}

json

application/json

Delete access code

DELETE

/v1/accesscodes/{id}

Revokes the access code: deletes it from Kasify and from the smart-lock provider (e.g. Nuki, Unifi). Restricted to owners and managers; staff and contractors are rejected.

Delete access code › path Parameters

id

string · required

Access code id

Delete access code › Responses

Access code revoked

No data returned

Account