# Credentials

## The acs\_credential Object

* [Properties](#properties)
* [Errors](#errors)
* [Warnings](#warnings)
* [Events](#events)
* [Endpoints](#endpoints)

Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).

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.

{% tabs %}
{% tab title="JSON" %}

```json
{
  access_method: [example value],
  acs_credential_id: [example value],
  acs_credential_pool_id: [example value],
  acs_system_id: [example value],
  acs_user_id: [example value],
  assa_abloy_vostio_metadata: [example value],
  card_number: [example value],
  code: [example value],
  created_at: [example value],
  display_name: [example value],
  ends_at: [example value],
  errors: [example value],
  external_type: [example value],
  external_type_display_name: [example value],
  is_issued: [example value],
  is_latest_desired_state_synced_with_provider: [example value],
  is_managed: [example value],
  is_multi_phone_sync_credential: [example value],
  is_one_time_use: [example value],
  issued_at: [example value],
  latest_desired_state_synced_with_provider_at: [example value],
  parent_acs_credential_id: [example value],
  starts_at: [example value],
  visionline_metadata: [example value],
  warnings: [example value],
  workspace_id: [example value]
}
```

{% endtab %}
{% endtabs %}

***

## Properties

**`access_method`** *Enum*

Access method for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.

<details>

<summary>Enum values</summary>

* `code`
* `card`
* `mobile_key`

</details>

***

**`acs_credential_id`** *UUID*

ID of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

***

**`acs_credential_pool_id`** *UUID*

***

**`acs_system_id`** *UUID*

ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

***

**`acs_user_id`** *UUID*

ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) belongs.

***

**`assa_abloy_vostio_metadata`** *Object*

Vostio-specific metadata for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

<details>

<summary>Child Properties</summary>

* **`auto_join`** *Boolean*
* **`door_names`** *List* *of Strings*
* **`endpoint_id`** *String*
* **`key_id`** *String*
* **`key_issuing_request_id`** *String*
* **`override_guest_acs_entrance_ids`** *List* *of Strings*

</details>

***

**`card_number`** *String*

Number of the card associated with the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

***

**`code`** *String*

Access (PIN) code for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

***

**`created_at`** *Datetime*

Date and time at which the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was created.

***

**`display_name`** *String*

Display name that corresponds to the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) type.

***

**`ends_at`** *String*

Date and time at which the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.

***

**`errors`** *List* *of Objects*

Errors associated with the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

<details>

<summary>Child Object Properties</summary>

**`error_code`** *String*

**`message`** *String*

</details>

***

**`external_type`** *Enum*

Brand-specific terminology for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.

<details>

<summary>Enum values</summary>

* `pti_card`
* `brivo_credential`
* `hid_credential`
* `visionline_card`
* `salto_ks_credential`
* `assa_abloy_vostio_key`
* `salto_space_key`
* `latch_access`

</details>

***

**`external_type_display_name`** *String*

Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) type.

***

**`is_issued`** *Boolean*

Indicates whether the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) has been encoded onto a card.

***

**`is_latest_desired_state_synced_with_provider`** *Boolean*

Indicates whether the latest state of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.

***

**`is_managed`** *Boolean*

***

**`is_multi_phone_sync_credential`** *Boolean*

Indicates whether the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).

***

**`is_one_time_use`** *Boolean*

Indicates whether the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) 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](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was encoded onto a card.

***

**`latest_desired_state_synced_with_provider_at`** *Datetime*

Date and time at which the state of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.

***

**`parent_acs_credential_id`** *UUID*

ID of the parent [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

***

**`starts_at`** *String*

Date and time at which the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.

***

**`visionline_metadata`** *Object*

Visionline-specific metadata for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

<details>

<summary>Child Properties</summary>

* **`auto_join`** *Boolean*
* **`card_function_type`** *Enum*
* **`card_id`** *String*
* **`common_acs_entrance_ids`** *List* *of UUIDs*
* **`credential_id`** *String*
* **`guest_acs_entrance_ids`** *List* *of UUIDs*
* **`is_valid`** *Boolean*
* **`joiner_acs_credential_ids`** *List* *of UUIDs*

</details>

***

[**`warnings`**](#warnings) *List* *of Objects*

Warnings associated with the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

The specific structure of each object in this list depends on the value of its `warning_code` field.

Variants:

<details>

<summary><code>waiting_to_be_issued</code></summary>

Indicates that the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) is waiting to be issued.

**`created_at`** *Datetime*

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`** *Enum*

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

Enum values:

```
- <code>waiting_to_be_issued</code>
```

</details>

<details>

<summary><code>schedule_externally_modified</code></summary>

Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials)'s children was modified externally.

**`created_at`** *Datetime*

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`** *Enum*

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

Enum values:

```
- <code>schedule_externally_modified</code>
```

</details>

<details>

<summary><code>schedule_modified</code></summary>

Indicates that the schedule of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.

**`created_at`** *Datetime*

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`** *Enum*

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

Enum values:

```
- <code>schedule_modified</code>
```

</details>

<details>

<summary><code>being_deleted</code></summary>

Indicates that the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) is being deleted.

**`created_at`** *Datetime*

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`** *Enum*

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

Enum values:

```
- <code>being_deleted</code>
```

</details>

<details>

<summary><code>unknown_issue_with_acs_credential</code></summary>

An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.

**`created_at`** *Datetime*

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`** *Enum*

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

Enum values:

```
- <code>unknown_issue_with_acs_credential</code>
```

</details>

<details>

<summary><code>needs_to_be_reissued</code></summary>

Access permissions for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.

**`created_at`** *Datetime*

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`** *Enum*

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

Enum values:

```
- <code>needs_to_be_reissued</code>
```

</details>

***

**`workspace_id`** *UUID*

ID of the [workspace](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

***

## Warnings

**`waiting_to_be_issued`**

Indicates that the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) is waiting to be issued.

***

**`schedule_externally_modified`**

Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials)'s children was modified externally.

***

**`schedule_modified`**

Indicates that the schedule of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.

***

**`being_deleted`**

Indicates that the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) is being deleted.

***

**`unknown_issue_with_acs_credential`**

An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.

***

**`needs_to_be_reissued`**

Access permissions for the [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.

***

## Events

**`acs_credential.deleted`**

An [ACS credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was deleted.

<details>

<summary>Properties</summary>

**`acs_credential_id`** *UUID*

ID of the affected credential.

**`acs_system_id`** *UUID*

ID of the access system.

**`connected_account_id`** *UUID*

ID of the connected account.

**`created_at`** *Datetime*

Date and time at which the event was created.

**`event_id`** *UUID*

ID of the event.

**`event_type`** *Enum*

Value: `acs_credential.deleted`

**`occurred_at`** *Datetime*

Date and time at which the event occurred.

**`workspace_id`** *UUID*

ID of the workspace associated with the event.

</details>

***

**`acs_credential.issued`**

An [ACS credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was issued.

<details>

<summary>Properties</summary>

**`acs_credential_id`** *UUID*

ID of the affected credential.

**`acs_system_id`** *UUID*

ID of the access system.

**`connected_account_id`** *UUID*

ID of the connected account.

**`created_at`** *Datetime*

Date and time at which the event was created.

**`event_id`** *UUID*

ID of the event.

**`event_type`** *Enum*

Value: `acs_credential.issued`

**`occurred_at`** *Datetime*

Date and time at which the event occurred.

**`workspace_id`** *UUID*

ID of the workspace associated with the event.

</details>

***

**`acs_credential.reissued`**

An [ACS credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was reissued.

<details>

<summary>Properties</summary>

**`acs_credential_id`** *UUID*

ID of the affected credential.

**`acs_system_id`** *UUID*

ID of the access system.

**`connected_account_id`** *UUID*

ID of the connected account.

**`created_at`** *Datetime*

Date and time at which the event was created.

**`event_id`** *UUID*

ID of the event.

**`event_type`** *Enum*

Value: `acs_credential.reissued`

**`occurred_at`** *Datetime*

Date and time at which the event occurred.

**`workspace_id`** *UUID*

ID of the workspace associated with the event.

</details>

***

**`acs_credential.invalidated`**

An [ACS credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) was invalidated. That is, the credential cannot be used anymore.

<details>

<summary>Properties</summary>

**`acs_credential_id`** *UUID*

ID of the affected credential.

**`acs_system_id`** *UUID*

ID of the access system.

**`connected_account_id`** *UUID*

ID of the connected account.

**`created_at`** *Datetime*

Date and time at which the event was created.

**`event_id`** *UUID*

ID of the event.

**`event_type`** *Enum*

Value: `acs_credential.invalidated`

**`occurred_at`** *Datetime*

Date and time at which the event occurred.

**`workspace_id`** *UUID*

ID of the workspace associated with the event.

</details>

***

## Endpoints

[**`/acs/credentials/assign`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/assign)

Assigns a specified [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).

[**`/acs/credentials/create`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/create)

Creates a new [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).

[**`/acs/credentials/delete`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/delete)

Deletes a specified [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

[**`/acs/credentials/get`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/get)

Returns a specified [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

[**`/acs/credentials/list`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/list)

Returns a list of all [credentials](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).

[**`/acs/credentials/list_accessible_entrances`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/list_accessible_entrances)

Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.

[**`/acs/credentials/unassign`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/unassign)

Unassigns a specified [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).

[**`/acs/credentials/update`**](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/acs/credentials/update)

Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/capability-guides/access-systems/managing-credentials).