QR Login

watch.auth.session.qr_login

This API allows you to login users with QR code.

Headers

The authorization header must carry the API key that was provided during application registration.

Header Value
Authorization Bearer api_key

Endpoint

    POST v2/watch/auth/login/qr

Request Body

    {
        "login_code": "A1B2C3",
        "type": "pin",
        "credentials": "<your_creds>",
        "persist": true
    }
Parameter Type Requirement Description
login_code String Required The code shown on the device being signed in, as returned by the QR login code API.
type String Required Specifies the type of authentication. The allowed values are [pin, password].
credentials Object Required Specifies your authentication credentials. This can be PIN of username and password defined. See samples below.
persist Boolean Optional Specifies if the user needs to be logged in for a longer period of time.

Request Body (type = pin)

Send the following request body when authenticating using PIN:

    {
        "type": "pin",
        "credentials": {
            "pin": "BSGB7xx"
        }
    }

Body (type = password)

Send the following request body when authenticating using username and password:

    {
        "type": "password",
        "credentials": {
            "username": "john.doe@indee.tv",
            "password": "yourpasswordhere"
        }
    }

Response Body

    {
        "status_code": "W0000",
        "message": ""
    }
Field Type Description
status_code Integer The Indee API status code. See the full list of codes in the Status Codes section.

Status Codes

Indee status code HTTP Response Code Description
W0000 HTTP 200 Success
W2000 HTTP 401 Authorization header was either not passed or there was some issue parsing it
W2001 HTTP 401 API key is invalid or expired, or is not fully configured
W2009 HTTP 401 ClientID header was either not passed or is malformed
W2100 HTTP 403 Origin domain is not whitelisted for this API key
W2108 HTTP 403 Watch product is inactive
W2102 HTTP 451 Request blocked by geofencing for the resolved region
W2002 HTTP 401 The login code is invalid or has expired
W5001 HTTP 429 Rate limited
W5000 HTTP 500 Unknown server error occurred