Skip to main content

​
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:
  1. Credential creation Configure the access parameters for the credential.
  2. 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/low-level-apis/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.
workspace_id UUID ID of the workspace that contains the encoder.

​
Events

acs_encoder.added An access system encoder was added.
acs_encoder.removed An access system encoder was removed.

​
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 /acs/encoders/get Returns a specified encoder. /acs/encoders/list Returns a list of all encoders. /acs/encoders/scan_credential Scans an encoded acs_credential from a plastic card placed on the specified encoder.