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. For granting a person access to a space, Access Grants are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.

Properties

Enum (String)
required
Access method for the credential. Supported values: code, card, mobile_key, cloud_key.
  • code
  • card
  • mobile_key
  • cloud_key
String (UUID)
required
ID of the credential.
String (UUID)
ID of the credential pool to which the credential belongs.
String (UUID)
required
ID of the access control system that contains the credential.
String (UUID)
ID of the ACS user to whom the credential belongs.
Object
Akiles-specific metadata for the credential.
Object
Vostio-specific metadata for the credential.
String or null
Number of the card associated with the credential.
String or null
Access (PIN) code for the credential.
String (UUID)
required
ID of the connected account to which the credential belongs.
String (ISO 8601)
required
Date and time at which the credential was created.
String
required
Display name that corresponds to the credential type.
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.
Array of Objects
required
Errors associated with the credential.
Enum (String)
Brand-specific terminology for the credential type. Supported values: pti_card, brivo_credential, hid_credential, visionline_card.
  • pti_card
  • brivo_credential
  • hid_credential
  • visionline_card
  • salto_ks_credential
  • assa_abloy_vostio_key
  • salto_space_key
  • latch_access
  • dormakaba_ambiance_credential
  • hotek_card
  • salto_ks_tag
  • avigilon_alta_credential
  • kisi_credential
  • akiles_credential
String
Display name that corresponds to the brand-specific terminology for the credential type.
Boolean
Indicates whether the credential has been encoded onto a card.
Boolean or null
Indicates whether the latest state of the credential has been synced from Seam to the provider.
Boolean (Always true)
required
Indicates whether Seam manages the credential.
Boolean
Indicates whether the credential is a multi-phone sync credential.
Boolean
Indicates whether the credential can only be used once. If true, the code becomes invalid after the first use.
String (ISO 8601) or null
Date and time at which the credential was encoded onto a card.
String (ISO 8601) or null
Date and time at which the state of the credential was most recently synced from Seam to the provider.
String (UUID)
ID of the parent credential.
String
Date and time at which the credential validity starts, in ISO 8601 format.
String (UUID)
ID of the user identity to whom the credential belongs.
Object
Visionline-specific metadata for the credential.
Array of Objects
required
Warnings associated with the credential.
String (UUID)
required
ID of the workspace that contains the credential.