The Access Method Object

The access_method Object

Properties
Warnings
Events
Endpoints

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
Mobile Key Access Method
PIN Code Access Method

A card access method resource.

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

A mobile key access method resource.

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

A PIN code access method resource.

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

Properties

access_method_id 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 Datetime Date and time at which the access method was created.

customization_profile_id 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_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_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 Datetime Date and time at which the access method was issued.

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

pending_mutations List of Objects Pending mutations for the access method. Indicates operations that are in progress. The specific structure of each object in this list depends on the value of its mutation_code field. Variants:

warnings List of Objects Warnings associated with the access method. The specific structure of each object in this list depends on the value of its warning_code field. Variants:

workspace_id UUID ID of the Seam workspace associated with the access method.

Warnings

being_deleted Indicates that the access method is being deleted.

pulled_backup_access_code Indicates that all attempts to create an access code on this device before the start time failed and a backup access code was used to ensure access was provided in time.

updating_access_times Indicates that the access times for this access method are being updated.

Events

access_method.issued An access method was issued.

access_method.revoked An access method was revoked.

access_method.card_encoding_required An access method representing a physical card requires encoding.

access_method.deleted An access method was deleted.

access_method.reissued An access method was reissued.

access_method.created An access method was created.

Endpoints

/access_methods/delete Deletes an access method. /access_methods/encode Encodes an existing access method onto a plastic card placed on the specified encoder. /access_methods/get Gets an access method. /access_methods/get_related Gets all related resources for one or more Access Methods. /access_methods/list Lists all access methods, usually filtered by Access Grant.