Create a Credential for an ACS User

await seam.acs.credentials.create({
  credential_manager_acs_system_id: "bccb0d23-5107-498b-87a6-6a8aa929eeb2",
  user_identity_id: "4b6ec19d-ba68-46ca-80fd-55247684c2bb",
  acs_system_id: "7113de29-6130-4153-a6ea-1b7ca0fe3198",
  access_method: "code",
  code: "1234",
  allowed_acs_entrance_ids: ["21805570-4706-4c21-99fc-3ed873a5e014"],
  starts_at: "2025-06-19T21:08:08.000Z",
  ends_at: "2025-06-23T12:35:01.000Z",
});

/*
{
  "access_method": "code",
  "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
  "acs_system_id": "7113de29-6130-4153-a6ea-1b7ca0fe3198",
  "acs_user_id": "53f39f90-5113-4bdd-8432-acf328ce508c",
  "code": "1234",
  "created_at": "2025-06-16T16:54:17.946514Z",
  "display_name": "Salto KS Credential",
  "errors": [],
  "external_type": "salto_ks_credential",
  "external_type_display_name": "Salto KS Credential",
  "is_latest_desired_state_synced_with_provider": true,
  "is_managed": true,
  "is_multi_phone_sync_credential": true,
  "is_one_time_use": false,
  "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z",
  "starts_at": "2025-06-19T21:08:08.000Z",
  "warnings": [],
  "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd"
}
*/

{
  "acs_credential": {
    "access_method": "code",
    "acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "is_managed": true,
    "warnings": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "akiles_metadata": {
      "member_pin_id": "<string>"
    },
    "assa_abloy_vostio_metadata": {
      "auto_join": true,
      "door_names": [
        "<string>"
      ],
      "endpoint_id": "<string>",
      "key_id": "<string>",
      "key_issuing_request_id": "<string>",
      "override_guest_acs_entrance_ids": [
        "<string>"
      ]
    },
    "card_number": "<string>",
    "code": "<string>",
    "ends_at": "<string>",
    "external_type": "pti_card",
    "external_type_display_name": "<string>",
    "is_issued": true,
    "is_latest_desired_state_synced_with_provider": true,
    "is_multi_phone_sync_credential": true,
    "is_one_time_use": true,
    "issued_at": "2023-11-07T05:31:56Z",
    "latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
    "parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "starts_at": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visionline_metadata": {
      "auto_join": true,
      "card_function_type": "guest",
      "card_id": "<string>",
      "common_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "credential_id": "<string>",
      "guest_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_valid": true,
      "joiner_acs_credential_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  }
}

POST

acs

credentials

create

await seam.acs.credentials.create({
  credential_manager_acs_system_id: "bccb0d23-5107-498b-87a6-6a8aa929eeb2",
  user_identity_id: "4b6ec19d-ba68-46ca-80fd-55247684c2bb",
  acs_system_id: "7113de29-6130-4153-a6ea-1b7ca0fe3198",
  access_method: "code",
  code: "1234",
  allowed_acs_entrance_ids: ["21805570-4706-4c21-99fc-3ed873a5e014"],
  starts_at: "2025-06-19T21:08:08.000Z",
  ends_at: "2025-06-23T12:35:01.000Z",
});

/*
{
  "access_method": "code",
  "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
  "acs_system_id": "7113de29-6130-4153-a6ea-1b7ca0fe3198",
  "acs_user_id": "53f39f90-5113-4bdd-8432-acf328ce508c",
  "code": "1234",
  "created_at": "2025-06-16T16:54:17.946514Z",
  "display_name": "Salto KS Credential",
  "errors": [],
  "external_type": "salto_ks_credential",
  "external_type_display_name": "Salto KS Credential",
  "is_latest_desired_state_synced_with_provider": true,
  "is_managed": true,
  "is_multi_phone_sync_credential": true,
  "is_one_time_use": false,
  "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z",
  "starts_at": "2025-06-19T21:08:08.000Z",
  "warnings": [],
  "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd"
}
*/

{
  "acs_credential": {
    "access_method": "code",
    "acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "is_managed": true,
    "warnings": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_credential_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "akiles_metadata": {
      "member_pin_id": "<string>"
    },
    "assa_abloy_vostio_metadata": {
      "auto_join": true,
      "door_names": [
        "<string>"
      ],
      "endpoint_id": "<string>",
      "key_id": "<string>",
      "key_issuing_request_id": "<string>",
      "override_guest_acs_entrance_ids": [
        "<string>"
      ]
    },
    "card_number": "<string>",
    "code": "<string>",
    "ends_at": "<string>",
    "external_type": "pti_card",
    "external_type_display_name": "<string>",
    "is_issued": true,
    "is_latest_desired_state_synced_with_provider": true,
    "is_multi_phone_sync_credential": true,
    "is_one_time_use": true,
    "issued_at": "2023-11-07T05:31:56Z",
    "latest_desired_state_synced_with_provider_at": "2023-11-07T05:31:56Z",
    "parent_acs_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "starts_at": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visionline_metadata": {
      "auto_join": true,
      "card_function_type": "guest",
      "card_id": "<string>",
      "common_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "credential_id": "<string>",
      "guest_acs_entrance_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_valid": true,
      "joiner_acs_credential_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

access_method

enum<string>

required

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

Available options:

code,

card,

mobile_key,

cloud_key

acs_system_id

string<uuid>

ID of the access system to which the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

acs_user_id

string<uuid>

ID of the access system user to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id.

allowed_acs_entrance_ids

string<uuid>[]

Set of IDs of the entrances for which the new credential grants access.

assa_abloy_vostio_metadata

object

Vostio-specific metadata for the new credential.

Show child attributes

code

string

Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable device or system integration guide.

Pattern: ^\d+$

credential_manager_acs_system_id

string<uuid>

ACS system ID of the credential manager for the new credential.

ends_at

string<date-time>

Date and time at which the validity of the new credential ends, in ISO 8601 format. Must be a time in the future and after starts_at.

is_multi_phone_sync_credential

boolean

default:false

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

salto_space_metadata

object

Salto Space-specific metadata for the new credential.

Show child attributes

starts_at

string<date-time>

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

user_identity_id

string<uuid>

ID of the user identity to whom the new credential belongs. You must provide either acs_user_id or the combination of user_identity_id and acs_system_id. If the access system contains a user with the same email_address or phone_number as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.

visionline_metadata

object

Visionline-specific metadata for the new credential.

Show child attributes

Response

acs_credential

object

required

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. See the acs_credential object.

Show child attributes

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Create a Credential for an ACS User

Authorizations

Body

Response