Privicore
  1. Data Token
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
      POST
    • Retrieve temporary data token
      GET
    • Exchange data for token
      POST
    • Upstream file via stream auth
      POST
    • Request data via token
      POST
    • Download data
      GET
    • Configure information security risk meta
      POST
    • Configure file meta
      POST
    • List data tokens
      GET
    • Update data token
      POST
    • Delete data
      POST
  • 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
    • List policy templates
    • Register policy
    • List active policies
    • List inactive policies
    • Activate policy
    • Deactivate policy
    • Delete policy
    • List registered policies
    • Retrieve registered policy
  • Directory
    • Register Directory
    • Retrieve owned Directories
    • Retrieve assigned directories
    • Retrieve Directory
    • Create Directory User
    • Update user information
    • Invite Profile
    • Set profile password
    • List Directory Invites
    • Process Invitation
    • Retrieve directory profile
    • List directory users
    • Directory profiles info
    • Create profile device
    • Add storage device to profile
    • List directory devices
    • Create directory voting pool
    • Store directory meta information
  • Voting
    • Create voting
    • Check pool status
  • Schemas
    • Response
      • CommandAccepted
      • Unauthorized
      • ValidationErrors
    • Schemas
    • profileId
    • deviceIdentifier
    • directoryId
    • directoryName
    • directoryShortName
    • givenName
    • familyName
    • createdAt
    • meta
  1. Data Token

Reserve token space

POST
/data-token/reserve-token-space

Overview#

Request a temporary data token before uploading data. The token remains temporary until data is exchanged, and will expire if not used within the specified time-to-live (TTL).

Reserve Token Space#

Endpoint: POST /data-token/reserve-token-space
Authentication: Required (Authorization token obtained from the step)
Content-Type: application/x-www-form-urlencoded

Request Parameters#

ParameterTypeRequiredDescription
contextstringYesOrganizational context for the token (path, namespace, or classification)
ttlintegerNoTime-to-live in minutes. Default: 5 minutes
metastringNoAdditional metadata for the token
Allowed TTL Values:
1 minute
5 minutes (default)
30 minutes
60 minutes

Context Parameter#

The context parameter is a flexible organizational identifier used to categorize and group tokens. It can represent:
File paths: /home/username/documents/financial
Namespaces: project.module.component
Classifications: top-secret, confidential, internal
Organizational units: department.team.project
Custom hierarchies: Any string that helps organize and identify tokens
The context does not affect token functionality but provides a logical grouping mechanism for token management and retrieval.

Use Case#

This is the first step in the data token workflow. Reserve a token before you have data ready to upload. The temporary token allocates space in the system and provides a unique identifier for the subsequent data exchange. If the token is not used to exchange data within the TTL period, it will expire and be automatically removed from the system.
Tokens are temporary until data is exchanged
Unused tokens expire after the specified TTL
The context parameter helps organize and identify token purposes
Reserve tokens only when you're ready to exchange data within the TTL window

Request

Authorization
API Key
Add parameter in header
X-DPT-AUTHORIZATION
Example:
X-DPT-AUTHORIZATION: ********************
or
Header Params

Body Params application/x-www-form-urlencoded

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.privicore.com:9009/data-token/reserve-token-space' \
--header 'X-DPT-AUTHORIZATION: <api-key>' \
--data-urlencode 'context=' \
--data-urlencode 'ttl=5' \
--data-urlencode 'meta='

Responses

🟢202Success
This response does not have a body.
🟠401401
🟠422422
Modified at 2025-12-11 17:38:05
Previous
Data Token Management
Next
Retrieve temporary data token
Built with