MatterDeviceAdvance the app-service PIN campaign from one reported shadow

Advance the app-service PIN campaign from one reported shadow

Reads the reported shadow for device liveness and for the ack of an in-flight SetCredential, and emits the one step the campaign takes (send, clear, verdict, give up, re-drive, retire) or NO_EVENT.

curl -X POST "https://api.spkey.co/matter-devices/example_string/ProcessAppPinTick" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "reported": {},
  "requirePinRemote": "null",
  "hasStoredPin": true,
  "projected": "null",
  "pinMinLength": "null",
  "pinMaxLength": "null"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": {
    "type": "AppPinSendRequested",
    "data": {
      "deviceId": "example_string",
      "thingName": "John Doe",
      "timestamp": 3.14,
      "messageId": "example_string",
      "attempt": 42,
      "userIndex": 42,
      "credentialIndex": 42,
      "pinMinLength": "null",
      "pinMaxLength": "null"
    }
  },
  "appPinCampaign": "null"
}
POST
/matter-devices/{id}/ProcessAppPinTick
POST
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.
path
idstring
Required

Matter Device ID

Content-Typestring
Required

The media type of the request body

Options: application/json
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

idstring
Required

Matter Device ID

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventstring
Required

The single step the campaign took, or null when this shadow changed nothing

appPinCampaignobject,null