Encoders
acs_encoder
acs_encoder
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.
acs_encoder_id
acs_encoder_id
Format: UUID
ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.
acs_system_id
acs_system_id
Format: UUID
ID of the access control system that contains the encoder.
created_at
created_at
Format: Datetime
Date and time at which the encoder was created.
display_name
display_name
Format: String
Display name for the encoder.
errors
errors
Format: List
Item format: Object
Errors associated with the encoder.
workspace_id
workspace_id
Format: UUID
ID of the workspace that contains the encoder.
Endpoints
Encodes an existing credential onto a plastic card placed on the specified encoder.
Returns a list of all encoders.
Scans an encoded acs_credential from a plastic card placed on the specified encoder.
Events
acs_encoder.added
acs_encoder.added
An ACS encoder was added.
acs_encoder.removed
acs_encoder.removed
An ACS encoder was removed.
Last updated
Was this helpful?