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"
}'
import requests
import json
url = "https://api.spkey.co/users/example_string/AddPhysicalKey"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"orgId": "example_string",
"orgName": "John Doe",
"note": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/users/example_string/AddPhysicalKey", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"orgId": "example_string",
"orgName": "John Doe",
"note": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"orgId": "example_string",
"orgName": "John Doe",
"note": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/users/example_string/AddPhysicalKey", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/users/example_string/AddPhysicalKey')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"orgId": "example_string",
"orgName": "John Doe",
"note": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null",
"number": 42,
"orgId": "example_string",
"orgName": "John Doe",
"note": "example_string",
"addedAt": 3.14
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/users/{id}/AddPhysicalKeyTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
User ID
The media type of the request body
Issuing organisation id
Issuing organisation display name
Free-text note about the key (max 500 chars)
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
User ID
Body
Issuing organisation id
Issuing organisation display name
Free-text note about the key (max 500 chars)
Responses
Server-assigned per-user key number