@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias InstantKey

    Represents a Seam Instant Key. For issuing Bluetooth mobile keys, Instant Keys are the fastest way to share access. With a single API call, you can create a mobile key and send it through text or email or embed it in your own app.

    There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.

    type InstantKey = {
        client_session_id: string;
        created_at: string;
        customization?: {
            logo_url?: string;
            primary_color?: string;
            secondary_color?: string;
        };
        customization_profile_id?: string;
        expires_at: string;
        instant_key_id: string;
        instant_key_url: string;
        user_identity_id: string;
        workspace_id: string;
    }
    Index
    client_session_id created_at customization? customization_profile_id? expires_at instant_key_id instant_key_url user_identity_id workspace_id
    client_session_id: string

    ID of the client session associated with the Instant Key.

    created_at: string

    Date and time at which the Instant Key was created.

    customization?: {
        logo_url?: string;
        primary_color?: string;
        secondary_color?: string;
    }

    Customization applied to the Instant Key UI.

    Type Declaration

    • Optionallogo_url?: string

      URL of the logo displayed on the Instant Key.

    • Optionalprimary_color?: string

      Primary color used in the Instant Key UI.

    • Optionalsecondary_color?: string

      Secondary color used in the Instant Key UI.

    customization_profile_id?: string

    ID of the customization profile associated with the Instant Key.

    expires_at: string

    Date and time at which the Instant Key expires.

    instant_key_id: string

    ID of the Instant Key.

    instant_key_url: string

    Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app.

    user_identity_id: string

    ID of the user identity associated with the Instant Key.

    workspace_id: string

    ID of the workspace that contains the Instant Key.

    Settings
    Member Visibility

    On This Page
    Properties