> ## Documentation Index
> Fetch the complete documentation index at: https://docs.seam.co/llms.txt
> Use this file to discover all available pages before exploring further.

# The Access Grant Object

> Learn how the access_grant object grants a user identity access to spaces, entrances, and devices through mobile keys, plastic cards, and PIN codes.

## 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.

<ResponseExample>
  ```json Access Grant theme={null}
  {
    "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"
  }
  ```
</ResponseExample>

***

## Properties

<ResponseField name="access_grant_id" type="String (UUID)">
  ID of the Access Grant.
</ResponseField>

<ResponseField name="access_grant_key" type="String">
  Unique key for the access grant within the workspace.
</ResponseField>

<ResponseField name="access_method_ids" type="Array">
  IDs of the access methods created for the Access Grant.
</ResponseField>

<ResponseField name="client_session_token" type="String">
  Client Session Token. Only returned if the Access Grant has a mobile\_key access method.
</ResponseField>

<ResponseField name="created_at" type="String (ISO 8601)">
  Date and time at which the Access Grant was created.
</ResponseField>

<ResponseField name="customization_profile_id" type="String (UUID)">
  ID of the customization profile associated with the Access Grant.
</ResponseField>

<ResponseField name="display_name" type="String">
  Display name of the Access Grant.
</ResponseField>

<ResponseField name="ends_at" type="String (ISO 8601)">
  Date and time at which the Access Grant ends.
</ResponseField>

<ResponseField name="errors" type="Array">
  Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
</ResponseField>

<ResponseField name="instant_key_url" type="String">
  Instant Key URL. Only returned if the Access Grant has a single mobile\_key access\_method.
</ResponseField>

<ResponseField name="location_ids" type="Array" deprecated>
  The location ids.
</ResponseField>

<ResponseField name="name" type="String">
  Name of the Access Grant. If not provided, the display name will be computed.
</ResponseField>

<ResponseField name="pending_mutations" type="Array">
  List of pending mutations for the access grant. This shows updates that are in progress.
</ResponseField>

<ResponseField name="requested_access_methods" type="Array">
  Access methods that the user requested for the Access Grant.
</ResponseField>

<ResponseField name="reservation_key" type="String">
  Reservation key for the access grant.
</ResponseField>

<ResponseField name="space_ids" type="Array">
  IDs of the spaces to which the Access Grant gives access.
</ResponseField>

<ResponseField name="starts_at" type="String (ISO 8601)">
  Date and time at which the Access Grant starts.
</ResponseField>

<ResponseField name="user_identity_id" type="String (UUID)">
  ID of user identity to which the Access Grant gives access.
</ResponseField>

<ResponseField name="warnings" type="Array">
  Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
</ResponseField>

<ResponseField name="workspace_id" type="String (UUID)">
  ID of the Seam workspace associated with the Access Grant.
</ResponseField>