Type Alias AcsCredential

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.

type AcsCredential = {
    access_method: "code" | "card" | "mobile_key" | "cloud_key";
    acs_credential_id: string;
    acs_credential_pool_id?: string;
    acs_system_id: string;
    acs_user_id?: string;
    assa_abloy_vostio_metadata?: {
        auto_join?: boolean;
        door_names?: string[];
        endpoint_id?: string;
        key_id?: string;
        key_issuing_request_id?: string;
        override_guest_acs_entrance_ids?: string[];
    };
    card_number?: string
    | null;
    code?: string | null;
    connected_account_id: string;
    created_at: string;
    display_name: string;
    ends_at?: string;
    errors: { created_at: string; error_code: string; message: string }[];
    external_type?:
        | "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";
    external_type_display_name?: string;
    is_issued?: boolean;
    is_latest_desired_state_synced_with_provider?: boolean
    | null;
    is_managed: boolean;
    is_multi_phone_sync_credential?: boolean;
    is_one_time_use?: boolean;
    issued_at?: string | null;
    latest_desired_state_synced_with_provider_at?: string | null;
    parent_acs_credential_id?: string;
    starts_at?: string;
    user_identity_id?: string;
    visionline_metadata?: {
        auto_join?: boolean;
        card_function_type?: "guest" | "staff";
        card_id?: string;
        common_acs_entrance_ids?: string[];
        credential_id?: string;
        guest_acs_entrance_ids?: string[];
        is_valid?: boolean;
        joiner_acs_credential_ids?: string[];
    };
    warnings: (
        | {
            created_at: string;
            message: string;
            warning_code: "waiting_to_be_issued";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "schedule_externally_modified";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "schedule_modified";
        }
        | { created_at: string; message: string; warning_code: "being_deleted" }
        | {
            created_at: string;
            message: string;
            warning_code: "unknown_issue_with_acs_credential";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "needs_to_be_reissued";
        }
    )[];
    workspace_id: string;
}

Properties

access_method

access_method: "code" | "card" | "mobile_key" | "cloud_key"

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

acs_credential_id

acs_credential_id: string

ID of the credential.

`Optional`acs_credential_pool_id

acs_credential_pool_id?: string

ID of the credential pool to which the credential belongs.

acs_system_id

acs_system_id: string

ID of the access control system that contains the credential.

`Optional`acs_user_id

acs_user_id?: string

ID of the ACS user to whom the credential belongs.

`Optional`assa_abloy_vostio_metadata

assa_abloy_vostio_metadata?: {
    auto_join?: boolean;
    door_names?: string[];
    endpoint_id?: string;
    key_id?: string;
    key_issuing_request_id?: string;
    override_guest_acs_entrance_ids?: string[];
}

Vostio-specific metadata for the credential.

Type Declaration

Optionalauto_join?: boolean

Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
Optionaldoor_names?: string[]

Names of the doors to which to grant access in the Vostio access system.
Optionalendpoint_id?: string

Endpoint ID in the Vostio access system.
Optionalkey_id?: string

Key ID in the Vostio access system.
Optionalkey_issuing_request_id?: string

Key issuing request ID in the Vostio access system.
Optionaloverride_guest_acs_entrance_ids?: string[]

IDs of the guest entrances to override in the Vostio access system.

`Optional`card_number

card_number?: string | null

Number of the card associated with the credential.

`Optional`code

code?: string | null

Access (PIN) code for the credential.

connected_account_id

connected_account_id: string

ID of the connected account to which the credential belongs.

created_at

created_at: string

Date and time at which the credential was created.

display_name

display_name: string

Display name that corresponds to the credential type.

`Optional`ends_at

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

errors: { created_at: string; error_code: string; message: string }[]

Errors associated with the credential.

Type Declaration

created_at: string

Date and time at which Seam created the error.
error_code: string
message: string

`Optional`external_type

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

`Optional`external_type_display_name

external_type_display_name?: string

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

`Optional`is_issued

is_issued?: boolean

Indicates whether the credential has been encoded onto a card.

`Optional`is_latest_desired_state_synced_with_provider

is_latest_desired_state_synced_with_provider?: boolean | null

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

is_managed

is_managed: boolean

Indicates whether Seam manages the credential.

`Optional`is_multi_phone_sync_credential

is_multi_phone_sync_credential?: boolean

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

`Optional`is_one_time_use

is_one_time_use?: boolean

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

`Optional`issued_at

issued_at?: string | null

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

`Optional`latest_desired_state_synced_with_provider_at

latest_desired_state_synced_with_provider_at?: string | null

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

`Optional`parent_acs_credential_id

parent_acs_credential_id?: string

ID of the parent credential.

`Optional`starts_at

starts_at?: string

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

`Optional`user_identity_id

user_identity_id?: string

ID of the user identity to whom the credential belongs.

`Optional`visionline_metadata

visionline_metadata?: {
    auto_join?: boolean;
    card_function_type?: "guest" | "staff";
    card_id?: string;
    common_acs_entrance_ids?: string[];
    credential_id?: string;
    guest_acs_entrance_ids?: string[];
    is_valid?: boolean;
    joiner_acs_credential_ids?: string[];
}

Visionline-specific metadata for the credential.

Type Declaration

Optionalauto_join?: boolean

Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
Optionalcard_function_type?: "guest" | "staff"

Card function type in the Visionline access system.
Optionalcard_id?: string

ID of the card in the Visionline access system.
Optionalcommon_acs_entrance_ids?: string[]

Common entrance IDs in the Visionline access system.
Optionalcredential_id?: string

ID of the credential in the Visionline access system.
Optionalguest_acs_entrance_ids?: string[]

Guest entrance IDs in the Visionline access system.
Optionalis_valid?: boolean

Indicates whether the credential is valid.
Optionaljoiner_acs_credential_ids?: string[]

IDs of the credentials to which you want to join.

warnings

warnings: (
    | {
        created_at: string;
        message: string;
        warning_code: "waiting_to_be_issued";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "schedule_externally_modified";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "schedule_modified";
    }
    | { created_at: string; message: string; warning_code: "being_deleted" }
    | {
        created_at: string;
        message: string;
        warning_code: "unknown_issue_with_acs_credential";
    }
    | {
        created_at: string;
        message: string;
        warning_code: "needs_to_be_reissued";
    }
)[]

Warnings associated with the credential.

Type Declaration

{ created_at: string; message: string; warning_code: "waiting_to_be_issued" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "waiting_to_be_issued"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "schedule_externally_modified";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "schedule_externally_modified"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "schedule_modified" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "schedule_modified"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "being_deleted" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "being_deleted"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at: string;
    message: string;
    warning_code: "unknown_issue_with_acs_credential";
}
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "unknown_issue_with_acs_credential"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at: string; message: string; warning_code: "needs_to_be_reissued" }
- created_at: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "needs_to_be_reissued"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

workspace_id

workspace_id: string

ID of the workspace that contains the credential.

Type Alias AcsCredential

Index

Properties

Properties

access_method

acs_credential_id

Optionalacs_credential_pool_id

acs_system_id

Optionalacs_user_id

Optionalassa_abloy_vostio_metadata

Type Declaration

Optionalauto_join?: boolean

Optionaldoor_names?: string[]

Optionalendpoint_id?: string

Optionalkey_id?: string

Optionalkey_issuing_request_id?: string

Optionaloverride_guest_acs_entrance_ids?: string[]

Optionalcard_number

Optionalcode

connected_account_id

created_at

display_name

Optionalends_at

errors

Type Declaration

created_at: string

error_code: string

message: string

Optionalexternal_type

Optionalexternal_type_display_name

Optionalis_issued

Optionalis_latest_desired_state_synced_with_provider

is_managed

Optionalis_multi_phone_sync_credential

Optionalis_one_time_use

Optionalissued_at

Optionallatest_desired_state_synced_with_provider_at

Optionalparent_acs_credential_id

Optionalstarts_at

Optionaluser_identity_id

Optionalvisionline_metadata

Type Declaration

Optionalauto_join?: boolean

Optionalcard_function_type?: "guest" | "staff"

Optionalcard_id?: string

Optionalcommon_acs_entrance_ids?: string[]

Optionalcredential_id?: string

Optionalguest_acs_entrance_ids?: string[]

Optionalis_valid?: boolean

Optionaljoiner_acs_credential_ids?: string[]

warnings

Type Declaration

created_at: string

message: string

warning_code: "waiting_to_be_issued"

created_at: string

message: string

warning_code: "schedule_externally_modified"

created_at: string

message: string

warning_code: "schedule_modified"

created_at: string

message: string

warning_code: "being_deleted"

created_at: string

message: string

warning_code: "unknown_issue_with_acs_credential"

created_at: string

message: string

warning_code: "needs_to_be_reissued"

workspace_id

Settings

On This Page

`Optional`acs_credential_pool_id

`Optional`acs_user_id

`Optional`assa_abloy_vostio_metadata

`Optional`auto_join?: boolean

`Optional`door_names?: string[]

`Optional`endpoint_id?: string

`Optional`key_id?: string

`Optional`key_issuing_request_id?: string

`Optional`override_guest_acs_entrance_ids?: string[]

`Optional`card_number

`Optional`code

`Optional`ends_at

`Optional`external_type

`Optional`external_type_display_name

`Optional`is_issued

`Optional`is_latest_desired_state_synced_with_provider

`Optional`is_multi_phone_sync_credential

`Optional`is_one_time_use

`Optional`issued_at

`Optional`latest_desired_state_synced_with_provider_at

`Optional`parent_acs_credential_id

`Optional`starts_at

`Optional`user_identity_id

`Optional`visionline_metadata

`Optional`auto_join?: boolean

`Optional`card_function_type?: "guest" | "staff"

`Optional`card_id?: string

`Optional`common_acs_entrance_ids?: string[]

`Optional`credential_id?: string

`Optional`guest_acs_entrance_ids?: string[]

`Optional`is_valid?: boolean

`Optional`joiner_acs_credential_ids?: string[]