> ## 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 Method Object

> Learn how the access_method object describes the modes of access for an Access Grant, such as PIN codes, plastic cards, and mobile keys.

## The access\_method Object

Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.

<ResponseExample>
  ```json Card Access Method theme={null}
  {
    "access_method_id": "27d8ad77-55c2-4e20-b5b3-43555926f0e8",
    "created_at": "2025-06-14T16:54:17.946612Z",
    "display_name": "My Card",
    "is_card_encoding_required": true,
    "issued_at": "2025-06-14T16:54:17.946612Z",
    "mode": "card",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  }
  ```

  ```json Mobile Key Access Method theme={null}
  {
    "access_method_id": "27d8ad77-55c2-4e20-b5b3-43555926f0e8",
    "created_at": "2025-06-14T16:54:17.946612Z",
    "display_name": "My Mobile Key",
    "instant_key_url": "https://ik.seam.co/ABCXYZ",
    "is_card_encoding_required": false,
    "mode": "mobile_key",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  }
  ```

  ```json PIN Code Access Method theme={null}
  {
    "access_method_id": "27d8ad77-55c2-4e20-b5b3-43555926f0e8",
    "created_at": "2025-06-14T16:54:17.946612Z",
    "display_name": "My PIN Code",
    "is_card_encoding_required": false,
    "mode": "code",
    "workspace_id": "661025d3-c1d2-403c-83a8-af153aaedfbc"
  }
  ```

  ```json Cloud Key Access Method theme={null}
  {
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "access_method_id": "00000000-0000-0000-0000-000000000000",
    "display_name": "",
    "mode": "cloud_key",
    "created_at": "2025-01-01T00:00:00.000Z",
    "issued_at": "2025-01-01T00:00:00.000Z",
    "is_issued": false,
    "warnings": [],
    "pending_mutations": []
  }
  ```
</ResponseExample>

***

## Properties

<ResponseField name="access_method_id" type="String (UUID)">
  ID of the access method.
</ResponseField>

<ResponseField name="client_session_token" type="String">
  Token of the client session associated with the access method.
</ResponseField>

<ResponseField name="code" type="String">
  The actual PIN code for code access methods.
</ResponseField>

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

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

<ResponseField name="display_name" type="String">
  Display name of the access method.
</ResponseField>

<ResponseField name="instant_key_url" type="String">
  URL of the Instant Key for mobile key access methods.
</ResponseField>

<ResponseField name="is_assignment_required" type="Boolean">
  Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.
</ResponseField>

<ResponseField name="is_encoding_required" type="Boolean">
  Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.
</ResponseField>

<ResponseField name="is_issued" type="Boolean">
  Indicates whether the access method has been issued.
</ResponseField>

<ResponseField name="is_ready_for_assignment" type="Boolean">
  Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
</ResponseField>

<ResponseField name="is_ready_for_encoding" type="Boolean">
  Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
</ResponseField>

<ResponseField name="issued_at" type="String (ISO 8601)">
  Date and time at which the access method was issued.
</ResponseField>

<ResponseField name="mode" type="Enum (String)">
  Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
</ResponseField>

<ResponseField name="pending_mutations" type="Array">
  Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
</ResponseField>

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

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