Privicore
  1. Websockets
Privicore
  • Privicore API
  • Utility
    • Utility
    • Check server health
      GET
    • Request command id status
      GET
  • Profile
    • Profile Model and Authentication Workflow
    • Register new profile
      POST
    • Authenticate
      POST
    • Retrieve profile id
      GET
    • Change password
      POST
    • Generate qr token for authorization
      POST
    • Reauthorize authorization token
      POST
    • Revoke authorization token
      POST
    • Retrieve token expiry
      POST
  • OAuth Application
    • OAuth Application Management
    • Register OAuth Application
      POST
    • Retrieve OAuth app configuration
      POST
    • Request OAuth app authorization code
      GET
    • Retrieve OAuth app authorization code
      POST
    • Obtain OAuth app access token
      POST
    • OAuth application list
      GET
    • Retrieve OAuth application scope
      GET
    • Refresh OAuth app access token
      POST
  • Public key
    • Public and Private Key Management
    • Generate your private and public keys
    • Register public key
    • Retrieve public key
    • Retrieve CAB public key
  • Data Token
    • Data Token Management
    • Reserve token space
    • Retrieve temporary data token
    • Exchange data for token
    • Upstream file via stream auth
    • Request data via token
    • Download data
    • Configure information security risk meta
    • Configure file meta
    • List data tokens
    • Update data token
    • Delete data
  • Device
    • Device Management
    • Request unique identifier (i.e. Register new device)
    • Retrieve unique identifier
    • Retrieve profile devices
    • Configure device meta
    • Approve device
    • Reject device
    • Retrieve device configuration
    • Remove device
  • Storage
    • Storage Device Management
    • Register storage device
    • List storage devices
    • Synchronize device
    • Remove storage
  • Verified authenticator
    • Authenticator and Voting Management
    • Register authenticator
    • List verified authenticators
    • Retrieve voting strategy
    • Set quorum size
    • Set quorum strategy
    • Set voting time limit
    • Set maximum voting attempts
    • Remove authenticator
    • Register voting configuration
    • Update voting configuration
    • List voting configurations
    • Retrieve voting configuration
  • Policy
    • Policy Management
    • List policy templates
    • Register policy
    • List active policies
    • List inactive policies
    • Activate policy
    • Deactivate policy
    • Delete policy
    • List registered policies
    • Retrieve registered policy
  • Voting
    • Voting Operations
    • Create voting
    • Check pool status
  • Websockets
    • WebSocket Integration
    • Establishing Connection
    • Join Channel
    • Leave Channel
    • Command Status Messages
    • Data Download Messages
  • Schemas
    • Response
      • CommandAccepted
      • Unauthorized
      • ValidationErrors
    • Schemas
    • profileId
    • deviceIdentifier
    • directoryId
    • directoryName
    • directoryShortName
    • givenName
    • familyName
    • createdAt
    • meta
  1. Websockets

Data Download Messages

Overview#

Receive real-time notifications containing download links for data requested via data tokens.

Data Download Messages#

Message Type: X-DPT-CAB-REQUEST-ID

Message Structure#

{
  "data": {
    "type": "X-DPT-CAB-REQUEST-ID",
    "id": "b24b68f6-ef45-486a-bb4a-e58125b83a11",
    "data_context": "data-token-context",
    "output_type": 1,
    "body": "https://download-server.example.com/path?auth=token"
  }
}

Message Fields#

FieldDescription
typeMessage type identifier (X-DPT-CAB-REQUEST-ID)
idUnique request identifier returned when data was requested
data_contextContext associated with the data token
output_typeType of output data
bodyDownload URL or message content

Output Type Values#

ValueTypeDescription
0MessageTextual message or status update
1FileDownload link for requested data

Handling Messages#

Use Case#

Data download messages eliminate the need to poll for download link availability. After requesting data via a data token, the system prepares the encrypted data and sends the download link via WebSocket as soon as it's ready.
Example Workflow:
1.
Request data via token using the API
2.
API returns request identifier
3.
Subscribe to WebSocket notifications using the request ID
4.
System retrieves data from storage devices and decrypts through the chain
5.
Download link is sent via WebSocket when ready
6.
Initiate download immediately
This enables efficient data retrieval without repeatedly checking if data is available.
Request IDs are unique and can be used as event identifiers
Download links include authentication tokens and are time-limited
Output type 1 indicates a file download link
Output type 0 may indicate status updates during data preparation
Download links should be used immediately as they may expire
Remove event listeners after receiving the download link
Modified at 2026-01-05 14:09:10
Previous
Command Status Messages
Next
CommandAccepted
Built with