UserRemove a physical key from the user inventory

Remove a physical key from the user inventory

Removes the physical-key entry with the given number from the user's inventory. The next-number counter is NOT decremented — numbers are never reused after removal.

curl -X POST "https://api.spkey.co/users/example_string/RemovePhysicalKey" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "number": 42,
  "_callerOrgId": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null",
  "number": 42
}
POST
/users/{id}/RemovePhysicalKey
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
numberinteger
Required

Number of the physical key to remove

_callerOrgIdstring

Server-set: caller org id from API-key auth. Clients MUST NOT supply this.

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
numberinteger
Required

Number of the physical key to remove

_callerOrgIdstring

Server-set: caller org id from API-key auth. Clients MUST NOT supply this.

Responses

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