Create custom landing pages

On top of customizing emails, you might also want to design a custom page that presents the available doors to the user, e.g. add your own logo, colors, or render the door buttons based on your company's design guidelines.

To achieve this, you can fetch a list of all doors that the link provides access to, and use this information to create your own custom doors overview page.

info

Users with a digital credential can unlock doors associated with the link without having to sign in. Also, Geofence restrictions and Reader proximity restrictions do not apply to digital credentials, allowing remote door opening from any location. To ensure secure usage, please follow our recommended access link best practices.

1. Generate the access link or QR code as shown in Send digital credentials via customized emails
2. Copy the secret value that is returned upon link creation
3. In a new request, change the Authorization header value to KISI-GROUP-LINK
4. Paste the secret value right after KISI-GROUP-LINK
5. Send a GET request to the Fetch locks endpoint, as shown below

Example

curl --request GET \
  --url https://api.kisi.io/locks \
  --header 'Authorization: KISI-GROUP-LINK <secret>  ' \
  --header 'Content-Type: application/json'

Response

If your request was successful, you'll receive a 200 OK response with a list of doors that the respective link provides access to.

Unlock doors with the access link

Once a user selects a door to unlock from the list, you can unlock it using the access link credential. The unlock process works the same as cloud unlocks, but uses the KISI-GROUP-LINK authorization instead of KISI-LOGIN:

1. Use the same Authorization header format: KISI-GROUP-LINK <secret>
2. Send a POST request to the Unlock lock endpoint
3. Include the lock_id of a chosen door in the request URL

Example

curl --request POST \
  --url https://api.kisi.io/locks/{lock_id}/unlock \
  --header 'Authorization: KISI-GROUP-LINK <secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "context": {
    "location": {
      "longitude": 0,
      "latitude": 0
    }
  },
  "lock": {
    "proximity_proof": null
  }
}'

info

A digital credential is always associated to a group. This means, the link provides access to the same doors its associated group provides access to.