Screener 2FA Registration
If the screener has two-factor authentication (phone verification) security enabled, this endpoint will be used to register the user's phone number to be linked with it.
Endpoint
POST v2/watch/content/screeners/{screener_key}/2fa
If the product does not allow for link type screeners and force-login has been enabled for the screener, a JWT token is mandatory to be passed in the Authorization header.
Note: The force_login flag on the screener currently only applies to Publicity screeners.
| Header |
Value |
| Authorization |
JWT token |
If the product allows link type screeners and the force-login has not been enabled for the screener, the API key can be passed in the Authorization header for authentication.
| Header |
Value |
| Authorization |
Bearer api_key |
Request Body
{
"phone": <int>,
"country_code": <int>
}
| Parameter |
Type |
Requirement |
Description |
phone |
Integer |
Required |
Phone number of the user to whom the 2FA registration is being linked. |
country_code |
Integer |
Required |
Country code of the user's phone number. |
Response Body
{
"status_code": <status_code>,
"detail": <str>
}
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 |
| W2003 |
HTTP 401 |
Invalid auth token |
| W2101 |
HTTP 403 |
API key not authorized to perform this action |
| W5001 |
HTTP 429 |
Rate limited |
| W5000 |
HTTP 500 |
Unknown server error occurred |
Screener 2FA OTP Request
Related to the endpoint above. Once the user's phone number is linked, this endpoint will be used to request for an OTP to start playback.
Endpoint
GET v2/watch/content/screeners/{screener_key}/2fa
If the product does not allow for link type screeners and force-login has been enabled for the screener, a JWT token is mandatory to be passed in the Authorization header.
Note: The force_login flag on the screener currently only applies to Publicity screeners.
| Header |
Value |
| Authorization |
JWT token |
If the product allows link type screeners and the force-login has not been enabled for the screener, the API key can be passed in the Authorization header for authentication.
| Header |
Value |
| Authorization |
Bearer api_key |
Response Body
{
"status_code": W0000,
"detail": "Success"
}
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 |
| W2003 |
HTTP 401 |
Invalid auth token |
| W2101 |
HTTP 403 |
API key not authorized to perform this action |
| W5001 |
HTTP 429 |
Rate limited |
| W5000 |
HTTP 500 |
Unknown server error occurred |
