Skip to main content
POST
/
user_identities
/
generate_instant_key
await seam.userIdentities.generateInstantKey({
  user_identity_id: "d92e0c7b-72a1-4063-9ee8-2acefc240358",
  max_use_count: 10,
});

/*
{
  "client_session_id": "bfe3b1c6-fb9e-48b1-9b5b-c762b2983af6",
  "created_at": "2025-06-14T16:54:17.946559Z",
  "expires_at": "2025-06-16T16:54:17.946559Z",
  "instant_key_id": "1d05c2f6-5b6f-4a9c-b80d-1eca26be12b9",
  "instant_key_url": "https://ik.seam.co/ABCXYZ",
  "user_identity_id": "d92e0c7b-72a1-4063-9ee8-2acefc240358",
  "workspace_id": "4d1c24b2-781e-4d1a-8d77-15249ad57c8a"
}
*/
{
  "instant_key": {
    "client_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "instant_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "instant_key_url": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customization": {
      "logo_url": "<string>",
      "primary_color": "<string>",
      "secondary_color": "<string>"
    },
    "customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "ok": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
user_identity_id
string<uuid>
required

ID of the user identity for which you want to generate an instant key.

​
customization_profile_id
string<uuid>
​
max_use_count
number<float>
default:1

Maximum number of times the instant key can be used. Default: 1.

Response

OK

​
instant_key
object
required

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.

​
ok
boolean
required