Skip to content
Tilecast Docs

resolvePairingCode

POST
/api/v1/screens/pairing/resolve
curl --request POST \
  --url https://example.com/api/v1/screens/pairing/resolve \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "code": "example" }'

Requires an authenticated user with the write scope. Resolves a visible six-character pairing code into its pending session. Unknown, expired, or consumed codes answer 404.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
code
required
string
>= 6 characters <= 6 characters
Examplegenerated
{
  "code": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Pending player metadata

Media typeapplication/json
object
data
required
object
id
required
string format: uuid
status
required
string
Allowed values: pending approved rejected
metadata
required
object
playerInstallationId
required
string format: uuid
platform
required
string
>= 1 characters <= 120 characters
manufacturer
required
string
>= 1 characters <= 120 characters
model
required
string
>= 1 characters <= 120 characters
androidVersion
required
string
>= 1 characters <= 120 characters
playerVersion
required
string
>= 1 characters <= 120 characters
screenWidth
required
integer
>= 1 <= 16384
screenHeight
required
integer
>= 1 <= 16384
density
required
number
>= 0.5 <= 10
locale
required
string
>= 1 characters <= 120 characters
timezone
required
string
>= 1 characters <= 120 characters
approximateAddress
string
createdAt
required
string format: date-time
expiresAt
required
string format: date-time
previouslyPaired
required
boolean
existingScreenId
string format: uuid
existingScreenName
string
hasActiveCredential
required
boolean
credentialReplacementAuthorized
required
boolean
pairingMode
required
string
Allowed values: new_screen hardware_replacement credential_repair
Example
{
  "data": {
    "status": "pending",
    "pairingMode": "new_screen"
  }
}

401

Section titled “401”

Dashboard authentication required

404

Section titled “404”

Code invalid, missing, or expired