QueryGet user keys

Get user keys

Get user's physical and digital keys

curl -X GET "https://api.spkey.co/users/example_string/keys" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "physicalKeys": [
    {
      "number": 42,
      "orgId": "example_string",
      "orgName": "John Doe",
      "note": "example_string",
      "addedAt": 3.14
    }
  ],
  "digitalKeys": [
    {
      "keyId": "example_string",
      "keyIndex": 3.14,
      "walletType": "APPLE",
      "deviceId": "example_string",
      "addedAt": "example_string"
    }
  ],
  "walletKey": {
    "keyId": "example_string",
    "keyIndex": 3.14,
    "walletType": "APPLE",
    "deviceId": "example_string",
    "passUrl": "example_string",
    "serialNumber": "example_string",
    "addedAt": "example_string"
  }
}
GET
/users/{id}/keys
GET
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.
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

Responses

physicalKeysarray
Required
digitalKeysarray
Required
walletKeyobject