Send digital credentials via automated emails

In this use case, once you run the request, Kisi will send an automatic email to the defined email address, containing the digital credential. Once clicking on the link, the user will land on a Kisi-branded page with one or more doors they are provided access to.

info

Users with a digital credential can unlock doors associated with the link without having to sign in. Also, Geofence restrictions and Kisi Reader 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.

Access link

1. Send a POST request to the Create group link endpoint, following the example below.

Example

curl --request POST \
  --url https://api.kisi.io/group_links \
  --header 'Authorization: KISI-LOGIN <API_KEY>  ' \
  --header 'Content-Type: application/json' \
  --data '{
  ""group_link": {
    "name": "string",
    "group_id": 0,
    "email": "user@example.com",
    "valid_from": "2021-03-23T05:40:00Z",
    "valid_until": "2021-03-29T05:40:00Z"
  }
}'

• name - the name of the access link
• group_id - the ID of the group the access link will be associated to
• email - the email address the access link will be sent to
• valid_from - the date and time at which the access link becomes valid
• valid_until - the date and time at which the access link ceases to be valid

tip

Make sure to provide a meaningful name (e.g. the name of the user to whom the access link is sent to) to simplify access and unlock events auditing.

Response

If your request was successful, you'll receive a 200 OK response with the access link object, the user by whom it has been issued, and the authentication token associated with this access link.

{
  "id": 0,
  "email": "user@example.com",
  "group_id": 0,
  "name": "string",
  "valid_from": "2021-03-23T05:40:00Z",
  "valid_until": "2021-03-29T05:40:00Z"
  "issued_by": {
    "id": 0,
    "name": "string",
    "email": "user@example.com"
  },
  "secret": "0"
}

QR code

1. Send a POST request to the Create group link endpoint, following the example below. Remember to include quick_response_code_type: online into your call.

Example

curl --request POST \
  --url https://api.kisi.io/group_links \
  --header 'Accept: application/json' \
  --header 'Authorization: 123' \
  --header 'Content-Type: application/json' \
  --data '{
  "group_link": {
    "email": "user@example.com",
    "group_id": 0,
    "name": "string",
    "phone": "string",
    "quick_response_code_type": "online",
    "link_enabled": true,
    "valid_from": "2019-08-24T14:15:22Z",
    "valid_until": "2019-08-24T14:15:22Z"
  }
}'

• name - the name of the QR code
• group_id - the ID of the group the QR code will be associated to
• email - the email address the QR code will be sent to
• quick_response_code_type - will generate a QR code (optionally offline capable) that can be scanned with compatible readers. Will be sent as part of the access link email, if an email address is provided.
• valid_from - the date and time at which the QR code becomes valid
• valid_until - the date and time at which the QR code ceases to be valid

tip

Make sure to provide a meaningful name (e.g. the name of the user to whom the QR code is sent to) to simplify access and unlock events auditing.

Response

If your request was successful, you'll receive a 200 OK response with the QR code image object, the user by whom it has been issued, and the authentication token associated with this QR code.

{
  "id": 0,
  "resource_type": "GroupLink",
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "last_used_at": "2019-08-24T14:15:22Z",
  "link_enabled": true,
  "quick_response_code_type": "online",
  "valid_from": "2019-08-24T14:15:22Z",
  "valid_until": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "group_id": 0,
  "group": {
    "id": 0,
    "resource_type": "Group",
    "name": "string"
  },
  "created_by_type": null,
  "created_by_id": 0,
  "created_by": {
    "id": 0,
    "resource_type": "User",
    "email": "user@example.com",
    "name": "string"
  },
  "issued_by_id": 0,
  "issued_by": {
    "id": 0,
    "resource_type": "User",
    "email": "user@example.com",
    "name": "string"
  },
  "secret": "string",
  "quick_response_code_token": "string",
  "quick_response_code_image": "string"
}

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.