The Access Grant Object

{
  "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"
}

{
  "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"
}

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

String (UUID)

required

ID of the Access Grant.

String

Unique key for the access grant within the workspace.

Array of Strings (UUID)

required

IDs of the access methods created for the Access Grant.

String

Client Session Token. Only returned if the Access Grant has a mobile_key access method.

String (ISO 8601)

required

Date and time at which the Access Grant was created.

String (UUID)

ID of the customization profile associated with the Access Grant.

String

required

Display name of the Access Grant.

String

required

Human-readable sentence answering whether the user can currently get in, for example Active, Awaiting issuance, or Upcoming. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read starts_at, ends_at, errors, and the access methods’ own fields.

String (ISO 8601) or null

required

Date and time at which the Access Grant ends.

Array of Objects

required

Errors associated with the access grant.

Show properties

Enum (String)

required

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values

cannot_create_requested_access_methods
access_not_provisioned

String

required

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

String (ISO 8601)

required

Date and time at which Seam created the error.

String

Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.

String or null

required

Name of the Access Grant. If not provided, the display name will be computed.

Array of Objects

required

List of pending mutations for the access grant. This shows updates that are in progress.

Show mutation_code: updating_spaces

Seam is in the process of updating the devices/spaces associated with this access grant.

String (ISO 8601)

required

Date and time at which the mutation was created.

Object

required

Previous location configuration.

Show properties

Array of Strings (UUID)

required

Previous device IDs where access codes existed.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of updating the spaces (devices) associated with this access grant.

Enum values

updating_spaces

Object

required

New location configuration.

Show properties

String or null

Common code key to ensure PIN code reuse across devices.

Array of Strings (UUID)

required

New device IDs where access codes should be created.

Show mutation_code: updating_access_times

Seam is in the process of updating the access times for this access grant.

Array of Strings (UUID)

required

IDs of the access methods being updated.

String (ISO 8601)

required

Date and time at which the mutation was created.

Object

required

Previous access time configuration.

Show properties

String (ISO 8601) or null

required

Previous end time for access.

String (ISO 8601) or null

required

Previous start time for access.

String

required

Detailed description of the mutation.

Enum (String)

required

Mutation code to indicate that Seam is in the process of updating the access times for this access grant.

Enum values

updating_access_times

Object

required

New access time configuration.

Show properties

String (ISO 8601) or null

required

New end time for access.

String (ISO 8601) or null

required

New start time for access.

Array of Objects

required

Access methods that the user requested for the Access Grant.

Show properties

String

Specific PIN code to use for this access method. Only applicable when mode is ‘code’.

Array of Strings (UUID)

required

IDs of the access methods created for the requested access method.

String (ISO 8601)

required

Date and time at which the requested access method was added to the Access Grant.

String

required

Display name of the access method.

Integer

Maximum number of times the instant key can be used. Only applicable when mode is ‘mobile_key’. Defaults to 1 if not specified.

Enum (String)

required

Access method mode. Supported values: code, card, mobile_key, cloud_key.

Enum values

code
card
mobile_key
cloud_key

String

Reservation key for the access grant.

Array of Strings (UUID)

required

IDs of the spaces to which the Access Grant gives access.

String (ISO 8601)

required

Date and time at which the Access Grant starts.

String (UUID)

required

ID of user identity to which the Access Grant gives access.

Array of Objects

required

Warnings associated with the access grant.

Show properties

Enum (String)

required

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values

being_deleted
underprovisioned_access
overprovisioned_access
updating_access_times
requested_code_unavailable
device_does_not_support_access_codes
device_time_constraints_violated
access_revoked

String

required

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

String (ISO 8601)

required

Date and time at which Seam created the warning.

String (UUID)

required

ID of the Seam workspace associated with the Access Grant.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The Access Grant Object

The access_grant Object

Properties