Skip to content

Pair

METHOD NAME pair

This method doesn't require authentication.

Description

Creates a pairing request and displays an OTP on the device screen to authenticate. The OTP is valid for 30 seconds.

Requires state IDLE and, on success, moves to PAIRING

Parameters

object

  • serialNumber string REQUIRED
    The serial number of the device

Result

null on success

Errors

  • MissingParams
  • InvalidParams on mismatched serial number
  • ScreenNotReady
  • IllegalState

Example

Request

1
2
3
4
5
6
7
8
{
  "jsonrpc": "2.0",
  "id": "1234567890",
  "method": "pair",
  "params": {
    "serialNumber": "ABCDEF1234"
  }
}

Response

1
2
3
4
{
  "jsonrpc": "2.0",
  "id": "1234567890"  
}