v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Check code [Beta]

Use this endpoint for Device Flow Login (PIN Pair) functionality to check if the generated code has been authorized.

get/v1/codes/check

Query parameters

codestring required

Code to be checked if it has been authorized. Minimum length: 6. Maximum length: 6.

deviceIdstring required

Unique device identifier. Minimum length: 1. Maximum length: 128.

broadcasterIdinteger required

Unique broadcaster identifier. Value is publisherId. Minimum: 1. Maximum: 999999999.

Response

200

tokenTypestring

accessTokenstring

refreshTokenstring

expiresIninteger

customerIdstring

additionalPayloadstring

Example response

{
  "tokenType": "jwt",
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiNzc1ODQzMzU4Iiwib2ZmZXJJZCI6IlM1Njc5MjE3NjZfTkwifQ.rh67_MtVAe4ggE3kFALsuAL-XI3bQoOd_VYo1pirg3o0JOWnNYfaZaXo6DaYiJ7TDSGXyiQQPXJpz3LmJhfGgjww_gXcrf_CDO4sfKKFFfHi3GCNNSMp0-Ewf8_uCizGgqbarDGWDCRXGtgyJyK_SHIvUOsFcEe2TQqvQayQlV-ZpcapNPHKS-1zgClLhOz0ACE4FBos9fUsHrwQEcGDDY0hvs4TOLmWiRttTtTnL76hfZp-8JX1NBEi0QVy6ymVlJThdiK8GO4rIF7-6qi5UiXkCIzRb-qIfo5T0qYqHcEHksD3rOFMpC3GdS-1iXXfyRDZl27oL7RseKxgTYfwEA",
  "refreshToken": "a432f20d669764cb447d1ceffa76292d20a0f3d9524f290ec18afe106ec3349a",
  "expiresIn": 900000,
  "customerId": "123456789",
  "additionalPayload": "{ \"phoneModel\": \"samsung\" }"
}