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.

Card Access Method

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

---

Properties

access_method_id · String (UUID)

ID of the access method.

client_session_token · String

Token of the client session associated with the access method.

code · String

The actual PIN code for code access methods.

created_at · String (ISO 8601)

Date and time at which the access method was created.

customization_profile_id · String (UUID)

ID of the customization profile associated with the access method.

display_name · String

Display name of the access method.

instant_key_url · String

URL of the Instant Key for mobile key access methods.

is_assignment_required · 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.

is_encoding_required · Boolean

Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.

is_issued · Boolean

Indicates whether the access method has been issued.

is_ready_for_assignment · 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.

is_ready_for_encoding · 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.

issued_at · String (ISO 8601)

Date and time at which the access method was issued.

mode · Enum (String)

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

pending_mutations · Array

Pending mutations for the access method. Indicates operations that are in progress.

warnings · Array

Warnings associated with the access method.

workspace_id · String (UUID)

ID of the Seam workspace associated with the access method.