QueryGet user wallet status

Get user wallet status

Get the user's wallet status and the wallet keys this caller may see

curl -X GET "https://api.spkey.co/users/example_string/wallet?orgId=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "hasWalletKey": true,
  "walletKey": {
    "keyId": "example_string",
    "keyIndex": 3.14,
    "walletType": "APPLE",
    "deviceId": "example_string",
    "passUrl": "example_string",
    "serialNumber": "example_string",
    "addedAt": "example_string",
    "orgId": "null"
  },
  "walletKeys": [
    {
      "keyId": "example_string",
      "keyIndex": 3.14,
      "walletType": "APPLE",
      "deviceId": "example_string",
      "passUrl": "example_string",
      "serialNumber": "example_string",
      "addedAt": "example_string",
      "orgId": "null"
    }
  ]
}
GET
/users/{id}/wallet
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.
query
orgIdstring

Super-admin keys and the user themself: pick the wallet key of this org

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

Query Parameters

orgIdstring

Super-admin keys and the user themself: pick the wallet key of this org

Responses

hasWalletKeyboolean
Required
walletKeyobject
walletKeysarray
Required