Sign UpSupported Devices

Scan a Credential

POST /acs/encoders/scan_credential ⇒ { action_attempt }

Scans an encoded acs_credential from a plastic card placed on the specified encoder.

Authentication Methods

  • API key

  • Personal access token Must also include the seam-workspace header in the request.

Request Parameters

acs_encoder_id

Type: string Required: Yes

ID of the acs_encoder to use for the scan.

Return Type

action_attempt

SCAN_CREDENTIAL

Reading credential data from physical encoder.

action_attempt_id

Format: UUID

The ID of the action attempt.

action_type

Format: String

error

Format: Object

message Format: String

type Format: Enum

Possible enum values:

  • uncategorized_error

  • action_attempt_expired

  • no_credential_on_encoder

result

Format: Object

acs_credential_on_encoder Format: Object

Snapshot of credential data read from physical encoder.

acs_credential_on_encoder.card_number Format: String

A number or string that physically identifies the card associated with the credential.

acs_credential_on_encoder.created_at Format: Datetime

Date and time at which the credential was created.

acs_credential_on_encoder.ends_at Format: Datetime

Date and time at which the credential will stop being usable.

acs_credential_on_encoder.is_issued Format: Boolean

acs_credential_on_encoder.starts_at Format: Datetime

Date and time at which the credential becomes usable.

acs_credential_on_encoder.visionline_metadata Format: Object

Visionline-specific metadata for the credential.

acs_credential_on_encoder.visionline_metadata.cancelled Format: Boolean

Indicates whether the card associated with the credential is cancelled.

acs_credential_on_encoder.visionline_metadata.card_format Format: Enum

Format of the card associated with the credential.

Possible enum values:

  • TLCode

  • rfid48

acs_credential_on_encoder.visionline_metadata.card_holder Format: String

Holden of the card associated with the credential.

acs_credential_on_encoder.visionline_metadata.card_id Format: String

Card ID for the Visionline card associated with the credential.

acs_credential_on_encoder.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID

IDs of the common entrances for the credential.

acs_credential_on_encoder.visionline_metadata.discarded Format: Boolean

Indicates whether the card associated with the credential is discarded.

acs_credential_on_encoder.visionline_metadata.expired Format: Boolean

Indicates whether the card associated with the credential is expired.

acs_credential_on_encoder.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID

IDs of the guest entrances for the credential.

acs_credential_on_encoder.visionline_metadata.number_of_issued_cards Format: Number

Number of issued cards associated with the credential.

acs_credential_on_encoder.visionline_metadata.overridden Format: Boolean

Indicates whether the card associated with the credential is overridden.

acs_credential_on_encoder.visionline_metadata.overwritten Format: Boolean

Indicates whether the card associated with the credential is overwritten.

acs_credential_on_encoder.visionline_metadata.pending_auto_update Format: Boolean

Indicates whether the card associated with the credential is pending auto-update.

acs_credential_on_seam Format: Object

Matching acs_credential currently encoded on this card.

acs_credential_on_seam.access_method Format: Enum

Access method for the credential. Supported values: code, card, mobile_key.

Possible enum values:

  • code

  • card

  • mobile_key

acs_credential_on_seam.acs_credential_id Format: UUID

ID of the credential.

acs_credential_on_seam.acs_credential_pool_id Format: UUID

acs_credential_on_seam.acs_system_id Format: UUID

ID of the access control system that contains the credential.

acs_credential_on_seam.acs_user_id Format: UUID

ID of the ACS user to whom the credential belongs.

acs_credential_on_seam.assa_abloy_vostio_metadata Format: Object

Vostio-specific metadata for the credential.

acs_credential_on_seam.assa_abloy_vostio_metadata.door_names Format: List Item format: String

acs_credential_on_seam.assa_abloy_vostio_metadata.endpoint_id Format: String

acs_credential_on_seam.assa_abloy_vostio_metadata.key_id Format: String

acs_credential_on_seam.assa_abloy_vostio_metadata.key_issuing_request_id Format: String

acs_credential_on_seam.assa_abloy_vostio_metadata.override_guest_acs_entrance_ids Format: List Item format: String

acs_credential_on_seam.card_number Format: String

Number of the card associated with the credential.

acs_credential_on_seam.code Format: String

Access (PIN) code for the credential.

acs_credential_on_seam.created_at Format: Datetime

Date and time at which the credential was created.

acs_credential_on_seam.display_name Format: String

Display name that corresponds to the credential type.

acs_credential_on_seam.ends_at Format: String

Date and time at which the credential validity ends, in ISO 8601 format. Must be a time in the future and after starts_at.

acs_credential_on_seam.errors Format: List Item format: Object

Errors associated with the credential.

  • error_code Format: String

  • message Format: String

acs_credential_on_seam.external_type Format: Enum

Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.

Possible enum values:

  • pti_card

  • brivo_credential

  • hid_credential

  • visionline_card

  • salto_ks_credential

  • assa_abloy_vostio_key

  • salto_space_key

acs_credential_on_seam.external_type_display_name Format: String

Display name that corresponds to the brand-specific terminology for the credential type.

acs_credential_on_seam.is_issued Format: Boolean

Indicates whether the credential has been encoded onto a card.

acs_credential_on_seam.is_latest_desired_state_synced_with_provider Format: Boolean

Indicates whether the latest state of the credential has been synced from Seam to the provider.

acs_credential_on_seam.is_managed Format: Boolean

acs_credential_on_seam.is_multi_phone_sync_credential Format: Boolean

Indicates whether the credential is a multi-phone sync credential.

acs_credential_on_seam.is_one_time_use Format: Boolean

Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.

acs_credential_on_seam.issued_at Format: Datetime

Date and time at which the credential was encoded onto a card.

acs_credential_on_seam.latest_desired_state_synced_with_provider_at Format: Datetime

Date and time at which the state of the credential was most recently synced from Seam to the provider.

acs_credential_on_seam.parent_acs_credential_id Format: UUID

ID of the parent credential.

acs_credential_on_seam.starts_at Format: String

Date and time at which the credential validity starts, in ISO 8601 format.

acs_credential_on_seam.visionline_metadata Format: Object

Visionline-specific metadata for the credential.

acs_credential_on_seam.visionline_metadata.auto_join Format: Boolean

acs_credential_on_seam.visionline_metadata.card_function_type Format: Enum

Possible enum values:

  • guest

  • staff

acs_credential_on_seam.visionline_metadata.card_id Format: String

acs_credential_on_seam.visionline_metadata.common_acs_entrance_ids Format: List Item format: UUID

acs_credential_on_seam.visionline_metadata.credential_id Format: String

acs_credential_on_seam.visionline_metadata.guest_acs_entrance_ids Format: List Item format: UUID

acs_credential_on_seam.visionline_metadata.is_valid Format: Boolean

acs_credential_on_seam.visionline_metadata.joiner_acs_credential_ids Format: List Item format: UUID

acs_credential_on_seam.warnings Format: List Item format: Object

Warnings associated with the credential.

  • created_at Format: Datetime

Date and time at which Seam created the warning.

  • message Format: String

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

  • warning_code Format: Enum

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

Possible enum values:

  • waiting_to_be_issued

  • schedule_externally_modified

  • schedule_modified

  • being_deleted

  • unknown_issue_with_acs_credential

  • needs_to_be_reissued

acs_credential_on_seam.workspace_id Format: UUID

ID of the workspace that contains the credential.

warnings Format: List Item format: Object

  • warning_code Format: Enum

Possible enum values:

  • acs_credential_on_encoder_out_of_sync

  • acs_credential_on_seam_not_found

  • warning_message Format: String

status

Format: Enum

Possible enum values:

  • success

  • pending

  • error

PreviousList EncodersNextEncoder Simulations

Last updated

Was this helpful?

Revision created

ci: Generate docs