Skip to Content

TwentyThree™ API

API Method: /api/protection/verify

Verify access to a video or stream which is protected with one of the built-in protection method.

Parameters

ParameterDescription
object_id (required)Which object should be verified?
protection_method (required)Which method is the object currently protected with?
verification_dataOptionally, any extra string or data that is need to authenticate access. For example, when the protection method is `password`, this parameter should include the correct password for the object.

Permission level

The minimum required permission level is:

write

Example XML Response

<response status="ok" permission_level="write" message="You have access to the resource" cached="0">
  <object_id>1234567</object_id>
  <object_type>live</object_type>
  <protected_token>abcfe123456abce</protected_token>
</response>

Example JSON Response

{
  "status": "ok", 
  "message":"You have access to the resource",
  "permission_level":"write",
  "cached":"0",
  "protectedtoken":{
      "object_id": "1234567", 
      "object_type": "live", 
      "protected_token": "abcfe123456abce"
  },
  "p": "1",
  "size": "1",
  "site": {...},
  "endpoint": "/api/protection/verify"
}