Skip to main content

​
The acs_credential Object

Means by which an access control system user gains access at an entrance. The acs_credential object represents a credential that provides an ACS user access within an access control system. An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs. For each acs_credential, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
An access system card credential resource.
{
  "access_method": "card",
  "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
  "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
  "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
  "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
  "card_number": "164d29dc4a09b65f",
  "created_at": "2025-06-16T16:54:17.946514Z",
  "display_name": "Guest Lock 1, Vingcard Lock 2",
  "ends_at": "2025-07-12T16:54:17.946512Z",
  "errors": [],
  "external_type": "visionline_card",
  "external_type_display_name": "Visionline Card",
  "is_issued": true,
  "is_latest_desired_state_synced_with_provider": true,
  "is_managed": true,
  "is_multi_phone_sync_credential": false,
  "issued_at": "2025-06-16T16:54:17.946512Z",
  "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z",
  "starts_at": "2025-07-10T16:54:17.946512Z",
  "visionline_metadata": {
    "card_function_type": "guest",
    "card_id": "5",
    "common_acs_entrance_ids": ["5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"],
    "credential_id": "15",
    "guest_acs_entrance_ids": ["a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"],
    "is_valid": true
  },
  "warnings": [],
  "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd"
}

​
Properties

access_method Enum Access method for the credential. Supported values: code, card, mobile_key, cloud_key.
acs_credential_id UUID ID of the credential.
acs_credential_pool_id UUID
acs_system_id UUID ID of the access control system that contains the credential.
acs_user_id UUID ID of the ACS user to whom the credential belongs.
assa_abloy_vostio_metadata Object Vostio-specific metadata for the credential.
card_number String Number of the card associated with the credential.
code String Access (PIN) code for the credential.
connected_account_id UUID ID of the connected account to which the credential belongs.
created_at Datetime Date and time at which the credential was created.
display_name String Display name that corresponds to the credential type.
ends_at 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.
errors List of Objects Errors associated with the credential.
external_type Enum Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.
external_type_display_name String Display name that corresponds to the brand-specific terminology for the credential type.
is_issued Boolean Indicates whether the credential has been encoded onto a card.
is_latest_desired_state_synced_with_provider Boolean Indicates whether the latest state of the credential has been synced from Seam to the provider.
is_managed Boolean
is_multi_phone_sync_credential Boolean Indicates whether the credential is a multi-phone sync credential.
is_one_time_use Boolean Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.
issued_at Datetime Date and time at which the credential was encoded onto a card.
latest_desired_state_synced_with_provider_at Datetime Date and time at which the state of the credential was most recently synced from Seam to the provider.
parent_acs_credential_id UUID ID of the parent credential.
starts_at String Date and time at which the credential validity starts, in ISO 8601 format.
user_identity_id UUID ID of the user identity to whom the credential belongs.
visionline_metadata Object Visionline-specific metadata for the credential.
warnings List of Objects Warnings associated with the credential. The specific structure of each object in this list depends on the value of its warning_code field. Variants:
workspace_id UUID ID of the workspace that contains the credential.

​
Warnings

being_deleted Indicates that the credential is being deleted.
needs_to_be_reissued Access permissions for the credential have changed. Reissue (re-encode) the credential. This issue may affect the proper functioning of the credential.
schedule_externally_modified Indicates that the schedule of one of the credential’s children was modified externally.
schedule_modified Indicates that the schedule of the credential was modified to avoid creating a credential with a start date in the past.
unknown_issue_with_acs_credential An unknown issue occurred while syncing the state of the credential with the provider. This issue may affect the proper functioning of the credential.
waiting_to_be_issued Indicates that the credential is waiting to be issued.

​
Events

acs_credential.deleted An access system credential was deleted.
acs_credential.issued An access system credential was issued.
acs_credential.reissued An access system credential was reissued.
acs_credential.invalidated An access system credential was invalidated. That is, the credential cannot be used anymore.

​
Endpoints

/acs/credentials/assign Assigns a specified credential to a specified access system user. /acs/credentials/create Creates a new credential for a specified ACS user. /acs/credentials/delete Deletes a specified credential. /acs/credentials/get Returns a specified credential. /acs/credentials/list Returns a list of all credentials. /acs/credentials/list_accessible_entrances Returns a list of all entrances to which a credential grants access. /acs/credentials/unassign Unassigns a specified credential from a specified access system user. /acs/credentials/update Updates the code and ends at date and time for a specified credential.