Encoders

The acs_encoder Object

Represents a hardware device that encodes data onto physical cards within an .

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 .

To verify if your access control system requires a card encoder, see the corresponding .

{
  acs_encoder_id: [example value],
  acs_system_id: [example value],
  created_at: [example value],
  display_name: [example value],
  errors: [example value],
  workspace_id: [example value]
}

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

created_at Datetime

display_name String

errors List of Objects

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

Events

acs_encoder.added

Properties

acs_encoder_id UUID

acs_system_id UUID

connected_account_id UUID

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

acs_encoder.removed

Properties

acs_encoder_id UUID

acs_system_id UUID

connected_account_id UUID

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

Endpoints

PreviousList Accessible Entrances NextEncode a Credential

Last updated 2 days ago

Was this helpful?