QueryGet wallet install URL

Get wallet install URL

Returns a URL the user can open to install their wallet key into Apple Wallet or Google Wallet. Returns 404 if the user has no wallet key the caller may see (partners see only their own org's key).

curl -X GET "https://api.spkey.co/users/example_string/wallet/link?orgId=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "url": "example_string",
  "walletType": "APPLE"
}
GET
/users/{id}/wallet/link
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

urlstring
Required
walletTypestring
Required
Allowed values:APPLEGOOGLE