Get a Credential

Returns a specified credential.

POST /acs/credentials/get

JavaScript

Seam SDK

await seam.acs.credentials.get({ acs_credential_id: "f2b8eaa6-5e6d-433f-87cc-a283f4df688d", }); /* { "access_method": "code", "acs_credential_id": "f2b8eaa6-5e6d-433f-87cc-a283f4df688d", "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39", "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952", "code": "123456", "created_at": "2025-06-16T16:54:17.946514Z", "display_name": "FRONT_DOOR", "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": false, "is_one_time_use": false, "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z", "starts_at": "2025-07-10T16:54:17.946512Z", "warnings": [], "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd" } */

200

{
  "acs_credential": {
    "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": [
      {
        "error_code": "<string>",
        "message": "<string>"
      }
    ],
    "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",
    "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_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_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"
      ]
    }
  },
  "ok": true
}

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

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

Body

application/json

acs_credential_id · string<uuid> · required

ID of the credential that you want to get.

Response

200

application/json

OK

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...

Show child attributes

ok · boolean · required