diff --git a/mintlify-docs/images/instant-key-embed-link-button.png b/mintlify-docs/images/instant-key-embed-link-button.png new file mode 100644 index 000000000..09bd6a21c Binary files /dev/null and b/mintlify-docs/images/instant-key-embed-link-button.png differ diff --git a/mintlify-docs/images/instant-key-share-with-link.png b/mintlify-docs/images/instant-key-share-with-link.png new file mode 100644 index 000000000..64e2fd98f Binary files /dev/null and b/mintlify-docs/images/instant-key-share-with-link.png differ diff --git a/mintlify-docs/images/instant-key-unlock-flow.png b/mintlify-docs/images/instant-key-unlock-flow.png new file mode 100644 index 000000000..6b53fd593 Binary files /dev/null and b/mintlify-docs/images/instant-key-unlock-flow.png differ diff --git a/mintlify-docs/images/instant-keys-hero.png b/mintlify-docs/images/instant-keys-hero.png new file mode 100644 index 000000000..d7dca8c21 Binary files /dev/null and b/mintlify-docs/images/instant-keys-hero.png differ diff --git a/mintlify-docs/use-cases/granting-access/using-instant-keys.mdx b/mintlify-docs/use-cases/granting-access/using-instant-keys.mdx index 315cf23d8..172e0bb44 100644 --- a/mintlify-docs/use-cases/granting-access/using-instant-keys.mdx +++ b/mintlify-docs/use-cases/granting-access/using-instant-keys.mdx @@ -1,12 +1,16 @@ --- -title: "Using Instant Keys" -description: "Learn how to deliver Instant Keys — shareable unlock links that work without an app download — through Access Grants." +title: 'Using Instant Keys' +description: 'Learn how to deliver Instant Keys — shareable unlock links that work without an app download — through Access Grants.' --- +![Seam Instant Keys — no app, no account, just tap to unlock.](/images/instant-keys-hero.png) + Instant Keys are the fastest way to give someone mobile access. When you create an Access Grant with a `mobile_key` access method, Seam automatically generates an Instant Key URL. Share this URL with your user through text, email, or your app. When they tap the link, they can unlock the door immediately — no app download required. Instant Keys use iOS App Clips and Android Instant Apps to provide a native unlock experience without requiring your user to install anything. +![Your user opens the App Clip from the link, views their key, and unlocks the door — no app download required.](/images/instant-key-unlock-flow.png) + Instant Keys are ideal for: - **Guest access** — Send a link to a short-term guest (hotel, vacation rental, coworking space). @@ -26,7 +30,8 @@ To use Instant Keys, you need: - An entrance that supports mobile keys (`can_unlock_with_mobile_key` is `true`) - Instant Keys are generated automatically when you create a mobile key access method. You do not need to request them separately. + Instant Keys are generated automatically when you create a mobile key access + method. You do not need to request them separately. --- @@ -41,9 +46,7 @@ Create an [Access Grant](/use-cases/granting-access/index) specifying `mobile_ke const accessGrant = await seam.accessGrants.create({ user_identity_id: '22222222-2222-2222-2222-222222222222', acs_entrance_ids: ['f74e4879-5991-4e2f-a368-888983dcfbfc'], - requested_access_methods: [ - { mode: 'mobile_key' } - ], + requested_access_methods: [{ mode: 'mobile_key' }], starts_at: '2025-07-13T15:00:00.000Z', ends_at: '2025-07-16T11:00:00.000Z', }) @@ -165,7 +168,7 @@ curl -X 'POST' \ ## Step 2: Share the Instant Key URL -Once the access method is created, list the access methods for the Access Grant to get the `instant_key_url`. +Once the access method is created, list the access methods for the Access Grant to get the `instant_key_url`. Deliver the `instant_key_url` to your user. Common delivery methods include: @@ -174,8 +177,12 @@ Deliver the `instant_key_url` to your user. Common delivery methods include: - **In-app link** — Embed the URL in your web or mobile app. - **QR code** — Generate a QR code from the URL for physical signage. +![Share an Instant Key with just a link — the App Clip opens right from the text message.](/images/instant-key-share-with-link.png) + When your user taps the link on their phone, the Instant Key opens as an iOS App Clip or Android Instant App. They can unlock the door immediately — no app store download needed. +![Embed the Instant Key link in a button in your own app for a native mobile key experience.](/images/instant-key-embed-link-button.png) + ```javascript JavaScript @@ -259,8 +266,7 @@ curl -X 'POST' \ Use the `client_session_id` to look up the client session token, then pass it to the Seam mobile SDK to initialize your user's mobile app. For the complete mobile SDK integration guide, see [Mobile Access](/capability-guides/mobile-access/index). - - + --- @@ -336,4 +342,4 @@ curl -X 'POST' \ - [Instant Keys](/capability-guides/instant-keys/index) — Deep dive into how Instant Keys work, site setup, and advanced delivery options. - [Delivering Instant Keys](/capability-guides/instant-keys/delivering-instant-keys) — Detailed guide for sharing Instant Keys with your users. -- [Using Mobile Keys](/use-cases/granting-access/using-mobile-keys) — Build a native mobile app experience with the Seam mobile SDKs. \ No newline at end of file +- [Using Mobile Keys](/use-cases/granting-access/using-mobile-keys) — Build a native mobile app experience with the Seam mobile SDKs.