Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
280 changes: 280 additions & 0 deletions docs/api/acs/encoders/encode_credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,286 @@ Value: `ENCODE_CREDENTIAL`

---

#### `error`

Format: `Object`

<details>

<summary><code>message</code> Format: <code>String</code></summary>
</details>
<details>

<summary><code>type</code> Format: <code>Enum</code></summary>

Possible enum values:
- `uncategorized_error`
- `action_attempt_expired`
- `no_credential_on_encoder`
- `incompatible_card_format`
- `credential_cannot_be_reissued`
</details>
---

#### `result`

Format: `Object`

If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card.

<details>

<summary><code>access_method</code> Format: <code>Enum</code></summary>

Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.

Possible enum values:
- `code`
- `card`
- `mobile_key`
</details>
<details>

<summary><code>acs_credential_id</code> Format: <code>UUID</code></summary>

ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>acs_credential_pool_id</code> Format: <code>UUID</code></summary>
</details>
<details>

<summary><code>acs_system_id</code> Format: <code>UUID</code></summary>

ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>acs_user_id</code> Format: <code>UUID</code></summary>

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

<summary><code>assa_abloy_vostio_metadata</code> Format: <code>Object</code></summary>

Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>assa_abloy_vostio_metadata.door_names</code> Format: <code>List</code> Item format: <code>String</code></summary>
</details>
<details>

<summary><code>assa_abloy_vostio_metadata.endpoint_id</code> Format: <code>String</code></summary>
</details>
<details>

<summary><code>assa_abloy_vostio_metadata.key_id</code> Format: <code>String</code></summary>
</details>
<details>

<summary><code>assa_abloy_vostio_metadata.key_issuing_request_id</code> Format: <code>String</code></summary>
</details>
<details>

<summary><code>assa_abloy_vostio_metadata.override_guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>String</code></summary>
</details>
<details>

<summary><code>card_number</code> Format: <code>String</code></summary>

Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>code</code> Format: <code>String</code></summary>

Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>created_at</code> Format: <code>Datetime</code></summary>

Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
</details>
<details>

<summary><code>display_name</code> Format: <code>String</code></summary>

Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
</details>
<details>

<summary><code>ends_at</code> Format: <code>String</code></summary>

Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`.
</details>
<details>

<summary><code>errors</code> Format: <code>List</code> Item format: <code>Object</code></summary>

Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).

- <code>error_code</code> Format: <code>String</code>


- <code>message</code> Format: <code>String</code>

</details>
<details>

<summary><code>external_type</code> Format: <code>Enum</code></summary>

Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`
</details>
<details>

<summary><code>external_type_display_name</code> Format: <code>String</code></summary>

Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
</details>
<details>

<summary><code>is_issued</code> Format: <code>Boolean</code></summary>

Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
</details>
<details>

<summary><code>is_latest_desired_state_synced_with_provider</code> Format: <code>Boolean</code></summary>

Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
</details>
<details>

<summary><code>is_managed</code> Format: <code>Boolean</code></summary>
</details>
<details>

<summary><code>is_multi_phone_sync_credential</code> Format: <code>Boolean</code></summary>

Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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).
</details>
<details>

<summary><code>is_one_time_use</code> Format: <code>Boolean</code></summary>

Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
</details>
<details>

<summary><code>issued_at</code> Format: <code>Datetime</code></summary>

Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
</details>
<details>

<summary><code>latest_desired_state_synced_with_provider_at</code> Format: <code>Datetime</code></summary>

Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
</details>
<details>

<summary><code>parent_acs_credential_id</code> Format: <code>UUID</code></summary>

ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>starts_at</code> Format: <code>String</code></summary>

Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
</details>
<details>

<summary><code>visionline_metadata</code> Format: <code>Object</code></summary>

Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
<details>

<summary><code>visionline_metadata.auto_join</code> Format: <code>Boolean</code></summary>
</details>
<details>

<summary><code>visionline_metadata.card_function_type</code> Format: <code>Enum</code></summary>

Possible enum values:
- `guest`
- `staff`
</details>
<details>

<summary><code>visionline_metadata.card_id</code> Format: <code>String</code></summary>
</details>
<details>

<summary><code>visionline_metadata.common_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
</details>
<details>

<summary><code>visionline_metadata.credential_id</code> Format: <code>String</code></summary>
</details>
<details>

<summary><code>visionline_metadata.guest_acs_entrance_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
</details>
<details>

<summary><code>visionline_metadata.is_valid</code> Format: <code>Boolean</code></summary>
</details>
<details>

<summary><code>visionline_metadata.joiner_acs_credential_ids</code> Format: <code>List</code> Item format: <code>UUID</code></summary>
</details>
<details>

<summary><code>warnings</code> Format: <code>List</code> Item format: <code>Object</code></summary>

Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).

- <code>created_at</code> Format: <code>Datetime</code>

Date and time at which Seam created the warning.


- <code>message</code> Format: <code>String</code>

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


- <code>warning_code</code> Format: <code>Enum</code>

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`

</details>
<details>

<summary><code>workspace_id</code> Format: <code>UUID</code></summary>

ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
</details>
---

#### `status`

Format: `Enum`
Expand Down
Loading
Loading