UserAdd a physical key to the user inventory

Add a physical key to the user inventory

Records that a physical key has been issued to the user by some organisation. Server assigns a per-user autoincrement number (returned in the response) which is never reused after removal.

curl -X POST "https://api.spkey.co/users/example_string/AddPhysicalKey" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "orgId": "example_string",
  "orgName": "John Doe",
  "note": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null",
  "number": 42,
  "orgId": "example_string",
  "orgName": "John Doe",
  "note": "example_string",
  "addedAt": 3.14
}
POST
/users/{id}/AddPhysicalKey
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
orgIdstring
Required

Issuing organisation id

Min length: 1
orgNamestring

Issuing organisation display name

notestring

Free-text note about the key (max 500 chars)

Max length: 500
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Body

application/json
orgIdstring
Required

Issuing organisation id

orgNamestring

Issuing organisation display name

notestring

Free-text note about the key (max 500 chars)

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required
numberinteger
Required

Server-assigned per-user key number

orgIdstring
Required
orgNamestring
notestring
addedAtnumber
Required