Generate a Code

• Request Parameters

• Response

Generates a code for an access code, given a device ID.

JavaScript

Generates a code for an access code, given a device ID.

Code

await seam.accessCodes.generateCode({
  device_id: "02cd5099-d9f8-45a1-a9c0-f2ecbd334792",
});

Output

{ "device_id": "02cd5099-d9f8-45a1-a9c0-f2ecbd334792", "code": "1234" }

cURL

Generates a code for an access code, given a device ID.

Code

curl --include --request POST "https://connect.getseam.com/access_codes/generate_code" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "02cd5099-d9f8-45a1-a9c0-f2ecbd334792"
}
EOF

Output

{
  "generated_code": {
    "device_id": "02cd5099-d9f8-45a1-a9c0-f2ecbd334792",
    "code": "1234"
  }
}

Python

Generates a code for an access code, given a device ID.

Code

seam.access_codes.generate_code(device_id="02cd5099-d9f8-45a1-a9c0-f2ecbd334792")

Output

AccessCode(device_id="02cd5099-d9f8-45a1-a9c0-f2ecbd334792", code="1234")

Ruby

Generates a code for an access code, given a device ID.

Code

seam.access_codes.generate_code(device_id: "02cd5099-d9f8-45a1-a9c0-f2ecbd334792")

Output

{ "device_id" => "02cd5099-d9f8-45a1-a9c0-f2ecbd334792", "code" => "1234" }

PHP

Generates a code for an access code, given a device ID.

Code

<?php
$seam->access_codes->generate_code(
    device_id: "02cd5099-d9f8-45a1-a9c0-f2ecbd334792"
);

Output

<?php
["device_id" => "02cd5099-d9f8-45a1-a9c0-f2ecbd334792", "code" => "1234"];

Seam CLI

Generates a code for an access code, given a device ID.

Code

seam access-codes generate-code --device_id "02cd5099-d9f8-45a1-a9c0-f2ecbd334792"

Output

{ "device_id": "02cd5099-d9f8-45a1-a9c0-f2ecbd334792", "code": "1234" }

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

device_id String (Required)

ID of the device for which you want to generate a code.

---

Response

access_code

JSON

{
  "access_code_id": "e9cf6dd6-89aa-477f-a701-c08f3de13c1f",
  "code": "1234",
  "common_code_key": null,
  "created_at": "2025-06-14T16:54:17.946242Z",
  "device_id": "c9cd621d-ef0c-45c8-b608-026ebdb74615",
  "ends_at": "2025-07-04T16:54:17.946049Z",
  "errors": [],
  "is_backup": false,
  "is_backup_access_code_available": false,
  "is_external_modification_allowed": false,
  "is_managed": true,
  "is_offline_access_code": true,
  "is_one_time_use": true,
  "is_scheduled_on_device": true,
  "is_waiting_for_code_assignment": false,
  "name": "My Access Code",
  "pulled_backup_access_code_id": null,
  "starts_at": "2025-07-02T16:54:17.946049Z",
  "status": "set",
  "type": "time_bound",
  "warnings": []
}