Create an Access Grant

await seam.accessGrants.create({
  user_identity_id: "e3d736c1-540d-4d10-83e5-9a4e135453b4",
  device_ids: ["6ba7b811-9dad-11d1-80b4-00c04fd430c8"],
  requested_access_methods: [{ mode: "code" }],
  starts_at: "2025-06-16T16:54:17.946606Z",
  ends_at: "2025-06-18T16:54:17.946606Z",
});

/*
{
  "access_grant_id": "ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b",
  "access_method_ids": [
    "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"
  ],
  "created_at": "2025-06-16T16:54:17.946606Z",
  "display_name": "My Access Grant",
  "ends_at": "2025-06-18T16:54:17.946606Z",
  "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"
      ]
    }
  ],
  "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": {
    "access_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_method_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "display_status": "<string>",
    "ends_at": "2023-11-07T05:31:56Z",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "error_code": "cannot_create_requested_access_methods",
        "message": "<string>",
        "missing_device_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    ],
    "name": "<string>",
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "from": {
          "device_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ]
        },
        "message": "<string>",
        "mutation_code": "updating_spaces",
        "to": {
          "device_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ],
          "common_code_key": "<string>"
        }
      }
    ],
    "requested_access_methods": [
      {
        "created_access_method_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "display_name": "<string>",
        "mode": "code",
        "code": "<string>",
        "instant_key_max_use_count": 123
      }
    ],
    "space_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "starts_at": "2023-11-07T05:31:56Z",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "warning_code": "being_deleted"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_grant_key": "<string>",
    "client_session_token": "<string>",
    "customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "instant_key_url": "<string>",
    "reservation_key": "<string>"
  }
}

POST

access_grants

create

await seam.accessGrants.create({
  user_identity_id: "e3d736c1-540d-4d10-83e5-9a4e135453b4",
  device_ids: ["6ba7b811-9dad-11d1-80b4-00c04fd430c8"],
  requested_access_methods: [{ mode: "code" }],
  starts_at: "2025-06-16T16:54:17.946606Z",
  ends_at: "2025-06-18T16:54:17.946606Z",
});

/*
{
  "access_grant_id": "ef83cca9-5fdf-4ac2-93f3-c21c5a8be54b",
  "access_method_ids": [
    "a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"
  ],
  "created_at": "2025-06-16T16:54:17.946606Z",
  "display_name": "My Access Grant",
  "ends_at": "2025-06-18T16:54:17.946606Z",
  "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"
      ]
    }
  ],
  "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": {
    "access_grant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_method_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "display_status": "<string>",
    "ends_at": "2023-11-07T05:31:56Z",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "error_code": "cannot_create_requested_access_methods",
        "message": "<string>",
        "missing_device_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    ],
    "name": "<string>",
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "from": {
          "device_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ]
        },
        "message": "<string>",
        "mutation_code": "updating_spaces",
        "to": {
          "device_ids": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ],
          "common_code_key": "<string>"
        }
      }
    ],
    "requested_access_methods": [
      {
        "created_access_method_ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "display_name": "<string>",
        "mode": "code",
        "code": "<string>",
        "instant_key_max_use_count": 123
      }
    ],
    "space_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "starts_at": "2023-11-07T05:31:56Z",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "warning_code": "being_deleted"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_grant_key": "<string>",
    "client_session_token": "<string>",
    "customization_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "instant_key_url": "<string>",
    "reservation_key": "<string>"
  }
}

Creates a new Access Grant. Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using device_ids) and access control systems (using acs_entrance_ids or space_ids), and can issue PIN codes, key cards, and mobile keys through a single request.

Authorizations

Authorization

string

header

required

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

Body

application/json

requested_access_methods

object[]

required

Show child attributes

access_grant_key

string

Unique key for the access grant within the workspace.

acs_entrance_ids

string<uuid>[]

Set of IDs of the entrances to which access is being granted.

customization_profile_id

string<uuid>

ID of the customization profile to apply to the Access Grant and its access methods.

device_ids

string<uuid>[]

Set of IDs of the devices to which access is being granted.

ends_at

string | null

Date and time at which the validity of the new grant ends, in ISO 8601 format. Must be a time in the future and after starts_at.

name

string | null

Name for the access grant.

reservation_key

string

Reservation key for the access grant.

space_ids

string<uuid>[]

Set of IDs of existing spaces to which access is being granted.

space_keys

string[]

Set of keys of existing spaces to which access is being granted.

starts_at

string

Date and time at which the validity of the new grant starts, in ISO 8601 format.

user_identity

object

When used, creates a new user identity with the given details, and grants them access.

Show child attributes

user_identity_id

string<uuid>

ID of user identity for whom access is being granted.

Response

200 - application/json

access_grant

object

required

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. See the access_grant object.

Show child attributes

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Create an Access Grant

Authorizations

Body

Response