Encoders

acs_encoder

Represents a hardware device that encodes credential data onto physical cards within an access control system. See also Working with Card Encoders and Scanners.

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

Format: UUID

ID of the access control system that contains the encoder.

---

created_at

Format: Datetime

Date and time at which the encoder was created.

---

display_name

Format: String

Display name for the encoder.

---

errors

Format: List

Item format: Object

Errors associated with the encoder.

created_at Format: Datetime

Date and time at which Seam created the error.

error_code Format: String

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

message Format: String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

---

workspace_id

Format: UUID

ID of the workspace that contains the encoder.

---

Endpoints

/acs/encoders/encode_credential

Encodes an existing credential onto a plastic card placed on the 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.

---

Events

acs_encoder.added

An ACS encoder was added.

acs_encoder_id Format: UUID

ID of the ACS encoder.

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---

acs_encoder.removed

An ACS encoder was removed.

acs_encoder_id Format: UUID

ID of the ACS encoder.

acs_system_id Format: UUID

ID of the ACS system.

connected_account_id Format: UUID

ID of the connected account.

created_at Format: Datetime

Date and time at which the event was created.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---