Skip to main content

​
The access_grant Object

Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity while creating the new Access Grant. 
{
  "access_grant_id": "ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b",
  "access_method_ids": [
    "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d",
    "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
    "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
  ],
  "created_at": "2025-06-16T16:54:17.946606Z",
  "display_name": "My Access Grant",
  "ends_at": "2025-06-18T16:54:17.946606Z",
  "instant_key_url": "https://ik.seam.co/ABCXYZ",
  "requested_access_methods": [
    {
      "display_name": "PIN Code Credential",
      "mode": "code",
      "created_at": "2025-06-16T16:54:17.946606Z",
      "created_access_method_ids": [
        "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"
      ]
    },
    {
      "display_name": "Card Credential",
      "mode": "card",
      "created_at": "2025-06-16T16:54:19.946606Z",
      "created_access_method_ids": [
        "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"
      ]
    },
    {
      "display_name": "Mobile Key Credential",
      "mode": "mobile_key",
      "created_at": "2025-06-16T16:54:21.946606Z",
      "created_access_method_ids": [
        "c7d8e9f0-1a2b-3c4d-5e6f-7a8b9c0d1e2f"
      ]
    }
  ],
  "space_ids": [
    "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "7f8e9d0a-1b2c-3d4e-5f6a-7b8c9d0e1f2a"
  ],
  "starts_at": "2025-06-16T16:54:17.946606Z",
  "user_identity_id": "e3d736c1-540d-4d10-83e5-9a4e135453b4",
  "workspace_id": "750fc0bc-4450-4356-8d9f-18c6a3a6b2c7"
}

​
Properties

​
access_grant_id
String (UUID)
ID of the Access Grant.
​
access_grant_key
String
Unique key for the access grant within the workspace.
​
access_method_ids
Array
IDs of the access methods created for the Access Grant.
​
client_session_token
String
Client Session Token. Only returned if the Access Grant has a mobile_key access method.
​
created_at
String (ISO 8601)
Date and time at which the Access Grant was created.
​
customization_profile_id
String (UUID)
ID of the customization profile associated with the Access Grant.
​
display_name
String
Display name of the Access Grant.
​
ends_at
String (ISO 8601)
Date and time at which the Access Grant ends.
​
errors
Array
Errors associated with the access grant.
​
instant_key_url
String
Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
​
location_ids
Array
deprecated
The location ids.
​
name
String
Name of the Access Grant. If not provided, the display name will be computed.
​
pending_mutations
Array
List of pending mutations for the access grant. This shows updates that are in progress.
​
requested_access_methods
Array
Access methods that the user requested for the Access Grant.
​
reservation_key
String
Reservation key for the access grant.
​
space_ids
Array
IDs of the spaces to which the Access Grant gives access.
​
starts_at
String (ISO 8601)
Date and time at which the Access Grant starts.
​
user_identity_id
String (UUID)
ID of user identity to which the Access Grant gives access.
​
warnings
Array
Warnings associated with the access grant.
​
workspace_id
String (UUID)
ID of the Seam workspace associated with the Access Grant.