Provision a PIN on a Matter Door Lock

Runs the Yale Door Lock create-user + set-credential flow to provision a temporary PIN on a Matter lock. PIN is 4–8 digits and base64-encoded before sending.

curl -X POST "https://api.spkey.co/matter-devices/example_string/SetMatterPin" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "pinCode": "example_string",
  "userIndex": 42,
  "credentialIndex": 42
}'

import requests
import json

url = "https://api.spkey.co/matter-devices/example_string/SetMatterPin"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "pinCode": "example_string",
  "userIndex": 42,
  "credentialIndex": 42
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.spkey.co/matter-devices/example_string/SetMatterPin", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "pinCode": "example_string",
  "userIndex": 42,
  "credentialIndex": 42
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "pinCode": "example_string",
  "userIndex": 42,
  "credentialIndex": 42
}`)

    req, err := http.NewRequest("POST", "https://api.spkey.co/matter-devices/example_string/SetMatterPin", 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/matter-devices/example_string/SetMatterPin')
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 = '{
  "pinCode": "example_string",
  "userIndex": 42,
  "credentialIndex": 42
}'

response = http.request(request)
puts response.body

{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}