Encoders

The acs_encoder Object

• Properties

• Errors

• Warnings

• Events

• Endpoints

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.

---

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.

---

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 ACS 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 ACS 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_access_method

Encodes an existing access method onto a plastic card placed on the specified encoder.

/acs/encoders/encode_credential

Encodes an existing credential onto a plastic card placed on the specified encoder.

/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.