Plum / developers
REST APIDevice

Redeem a device claim

Redeem a claim using a provisioned, verified mTLS device client certificate. A personal device redeems an owner claim to establish its account binding; a shared recorder redeems a session claim to start that session. When redeeming a session claim, include the recorder's own `ble_address` (12 uppercase hex digits, no colons) so phones can find the session from its tag; owner claims ignore it. A BLE address already reported by another open session returns 409 CONFLICT. Set Content-Type to application/json or application/cbor for the request body. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).

POST/device/claims/redeem

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/device/claims/redeem" \  -H "X-API-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "claim_token": "stringstringstringstringstringstringstrings"  }'
{  "success": true,  "data": {    "owner_user_id": "65139110-7c3c-4777-b692-80c218be3b9d",    "device_id": "string",    "binding_epoch": "f92bd0f6-ad82-48f7-b45e-7b07b52b3f71",    "binding_kind": "session",    "session_expires_at": 0  }}

Create a device upload intent POST

Create a chunk upload intent for a bound device. Set Content-Type to application/json or application/cbor for the request body. Requires a provisioned, verified mTLS device client certificate and an account binding. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).

Check the device's account GET

Read the device's binding. Every 200 and 403 DEVICE_UNBOUND reply carries `X-A5-Binding-State`, an opaque token that changes whenever the binding the device must act on changes. Send it back as `known` with `wait` to long-poll: while the state still equals `known`, the reply is held until the state changes or `wait` seconds pass, and then carries `X-A5-Held: 1`. Ask again at once after a held reply or a changed state; after an immediate reply with an unchanged state and no `X-A5-Held`, wait before asking again. Other errors are never held. Requires a provisioned, verified mTLS device client certificate and an account binding. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).