Skip to content
Docs
Operation

Start device pairing

POST/devices/pairing
A device begins pairing and receives a user code + device code (unauthenticated).

Body

type*"relay" | "scanner" | "kiosk" | "signage"
namestring
▼platformobject
osstring
osVersionstring
appVersionstring
hostnamestring
archstring

Returns

Pairing started

Errors

400
Bad Request - Invalid input
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error

Every error names its code and links to it. All error codes

curl -X POST "https://api.ticketlayer.com/v1/devices/pairing" \  -H "Content-Type: application/json" \  -d '{    "type": "relay",    "name": "string",    "platform": {      "os": "string",      "osVersion": "string",      "appVersion": "string",      "hostname": "string",      "arch": "string"    }  }'
Response 201
{
  "pairingId": "string",
  "userCode": "string",
  "deviceCode": "string",
  "verificationUrl": "string",
  "verificationUrlComplete": "string",
  "expiresAt": "string",
  "pollIntervalSeconds": 0
}

Try it in test mode

Body