Encoders
The acs_encoder Object
Represents a hardware device that encodes credential data onto physical cards within an access control system.
Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
Credential creation Configure the access parameters for the credential.
Card encoding Write the credential data onto the card using a compatible card encoder.
Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
See Working with Card Encoders and Scanners.
To verify if your access control system requires a card encoder, see the corresponding system integration guide.
An access system encoder resource.
{
"acs_encoder_id": "681da2d6-4ac6-4b33-8c03-86281b761325",
"acs_system_id": "c85406d2-214f-4e11-8000-a2e5b5a362a4",
"connected_account_id": "1b9a3e0d-443f-4063-b619-4ca7e2a97750",
"created_at": "2025-06-16T16:54:17.946527Z",
"display_name": "Encoder 1",
"errors": [],
"workspace_id": "f863ac85-2c4e-49ae-8679-3ec2417f1d62"
}Properties
acs_encoder_id UUID
ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.
acs_system_id UUID
ID of the access control system that contains the encoder.
connected_account_id UUID
ID of the connected account that contains the encoder.
created_at Datetime
Date and time at which the encoder was created.
display_name String
Display name for the encoder.
errors List of Objects
Errors associated with the encoder.
Child Object Properties
created_at Datetime
Date and time at which Seam created the error.
error_code Enum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
message String
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
workspace_id UUID
ID of the workspace that contains the encoder.
Events
acs_encoder.added
An access system encoder was added.
Properties
acs_encoder_id UUID
ID of the affected encoder.
acs_system_id UUID
ID of the access system.
connected_account_id UUID
ID of the connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: acs_encoder.added
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
acs_encoder.removed
An access system encoder was removed.
Properties
acs_encoder_id UUID
ID of the affected encoder.
acs_system_id UUID
ID of the access system.
connected_account_id UUID
ID of the connected account.
created_at Datetime
Date and time at which the event was created.
event_id UUID
ID of the event.
event_type Enum
Value: acs_encoder.removed
occurred_at Datetime
Date and time at which the event occurred.
workspace_id UUID
ID of the workspace associated with the event.
Endpoints
/acs/encoders/encode_credential
Encodes an existing credential onto a plastic card placed on the specified encoder. Either provide an acs_credential_id or an access_method_id
Returns a specified encoder.
Returns a list of all encoders.
Scans an encoded acs_credential from a plastic card placed on the specified encoder.
Last updated
Was this helpful?