Access Methods
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.
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"
}
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.
issued_at
Datetime
Date and time at which the access method was issued.
mode
Enum
Access method mode. Supported values: code
, card
, mobile_key
.
workspace_id
UUID
ID of the Seam workspace associated with the access method.
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 due to an Access Grant update.
Endpoints
Deletes an access method.
Encodes an existing access method onto a plastic card placed on the specified encoder.
Gets an access method.
Gets all related resources for one or more Access Methods.
Lists all access methods, usually filtered by Access Grant.
Last updated
Was this helpful?