Send digital credentials via customized emails

In some cases, you might want to omit the automatic Kisi email and send the digital credential through your own email system instead. This allows you to use your own email templates, branding, and messaging while still providing access through Kisi.

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. Send a POST request to the Create group link endpoint, while omitting the email field. Note: if you want to send a QR code instead of an access link, remember to include quick_response_code_type: online into your call.

Response

If your request was successful, you'll receive a 200 OK response with the access link object. Copy the secret value from the response:

{
  ...
  "issued_by": {
    "id": 0,
    "resource_type": "User",
    "email": "user@example.com",
    "name": "string"
  },
  "secret": "a1b2c3d4e5f6g7h8",
  "quick_response_code_token": "67abc89dfe",
  "quick_response_code_image": "string"
  ...
}

2. Using your own email system, compose an email with your custom template and branding
3. In your email, paste the secret value to the end of https://web.kisi.io/grouplinks/ to create the access link

Example

https://web.kisi.io/grouplinks/a1b2c3d4e5f6g7h8

4. Send the email to your recipient using your email system

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.

Display the QR code in your app

If you created the group link with a quick_response_code_type, the response also includes the QR code image, which you can display directly inside your own app instead of sending it by email. This lets members open your app, show their QR code, and scan it at a compatible Kisi reader.

The QR code is returned in the quick_response_code_image field as a Base64-encoded image. Render this image in your app the same way you would any other Base64 image source.

note

The quick_response_code_image is only returned when the group link is created with a quick_response_code_type of online or offline. Store the image when you create the group link, since it is part of the creation response.