Trust & Data · API module

Data Vault

Navigate minimized owner-scoped metadata, and use the separately authenticated application file API for client-encrypted uploads, exact-file owner-approved backend decryption and commitment-only mainnet evidence. General grants, versions, retention and erasure remain separately planned contracts. This works without making the gateway a storage owner, key custodian or cleartext proxy.

BUSINESS CASES

Where this module fits

  • protected document inventory and bounded directory navigation
  • client-encrypted multipart storage
  • purpose- and recipient-bound retrieval
  • controlled sharing and grant revocation
  • retention, recycle, restore, and cryptographic-erasure governance
  • private-to-public evidence reconciliation

PRIMARY CONSUMERS

Who integrates it

  • workspace data owners
  • records and compliance systems
  • document-processing agents
  • evidence and disclosure integrations

PREREQUISITES

What must exist first

  • Existing owner metadata reads use vault:read and the native bearer-derived active workspace.
  • Partner files use a registered Vault-enabled confidential app, exact owner-consented vault:files:upload/read scopes, owner protection and separate selected-file approval.
  • Owner passwords, MFA/native sessions and private protection keys stay on the owner device; only app-scoped credentials reach the backend.
  • Each application supplies its exact production HTTPS origin/callback; test fixture callbacks are not production registration.
  • General lifecycle/grant/retention/recycle/restore/erasure contracts remain planned until individually promoted; no MPC wallet is required for this accepted file flow.

RECOMMENDED WORKFLOW

Compose the module safely.

  1. 01

    For owner metadata navigation use the existing native bearer and vault:read; never submit a Vault selector. Traverse one bounded level at a time.

  2. 02

    For partner files, follow the API-only Data Vault integration guide: owner signup/sign-in, first MFA, protected Vault, app registration and explicit connection authorization.

  3. 03

    Prepare a stable app-owner file ID, encrypt locally and persist exact registration/chunks before upload; reuse them on uncertain retries.

  4. 04

    Request exact-file decryption separately; the owner reviews and approves locally with fresh MFA before the backend receives its wrapped file key.

  5. 05

    Retrieve and decrypt only currently approved app-created files; renew short tokens only within original current owner authority.

  6. 06

    Verify new mainnet evidence independently. File/app/source revocation stops further access; do not infer a general grant, deletion or archival contract.

VERIFIED API-ONLY INTEGRATION

Data Vault integration: owner setup, explicit app and selected-file consent, encrypted uploads, backend retrieval/decryption and independent mainnet proof verification. Five synthetic owners completed the public API flow without a web interface or MPC wallet.

Read the complete developer guide, payloads and runnable example

Endpoint reference

Explore this module’s endpoints.

Check each endpoint’s availability and required permissions. Planned routes and routes awaiting deployment are preparation references, not callable APIs.

GETList protected objects/api/v2/data-vault/objectsList the authenticated workspace's top-level encrypted objects with minimized owner-use metadata, storage readiness, opaque content roots, and commitment-only evidence. Keys, shard topology, raw storage metadata, and download authority are excluded.›DELETEDelete protected object/api/v2/data-vault/objects/{object_uuid}Planned capability: request policy-governed deletion or cryptographic erasure of an eligible object.›GETGet protected object/api/v2/data-vault/objects/{object_uuid}Return minimized metadata and integrity evidence for one object after enforcing ownership at the authoritative storage query. Versions, retention policy, grants, keys, and download authority are not yet published by this contract.›GETList directory children/api/v2/data-vault/objects/{object_uuid}/childrenList one owner-scoped directory's immediate children using the same minimized object projection. This is single-level navigation, not a recursive tree, sharing grant, or download capability.›POSTCreate download ticket/api/v2/data-vault/objects/{object_uuid}/download-ticketsPlanned capability: issue a short-lived, subject-bound download ticket for an authorized object version.›GETList sharing grants/api/v2/data-vault/objects/{object_uuid}/grantsPlanned capability: list active and historical access grants for a protected object.›POSTCreate sharing grant/api/v2/data-vault/objects/{object_uuid}/grantsPlanned capability: grant a subject time- and purpose-bounded access to a protected object.›POSTRevoke sharing grant/api/v2/data-vault/objects/{object_uuid}/grants/{grant_uuid}/revocationsPlanned capability: revoke an active access grant while retaining its audit record.›POSTCreate upload session/api/v2/data-vault/upload-sessionsPlanned capability: create a bounded multipart upload session with content, retention, encryption, and integrity policy.›POSTComplete upload/api/v2/data-vault/upload-sessions/{session_uuid}/completionPlanned capability: verify uploaded parts and commit one immutable encrypted object version.›POSTGenerate data structure tree/api/v2/quantum/storage/datatreePlanned capability: apply the requested transition to generate data structure tree through the authoritative trust service boundary.›POSTDelete file from data vault/api/v2/quantum/storage/deletePlanned capability: apply the requested transition to file from data vault through the authoritative trust service boundary.›POSTCreate file download link from datavault/api/v2/quantum/storage/downloadPlanned capability: apply the requested transition to file download link from datavault through the authoritative trust service boundary.›POSTToggle favorites for file or folder/api/v2/quantum/storage/favoritePlanned capability: apply the requested transition to toggle favorites for file or folder through the authoritative trust service boundary.›POSTRequest file meta data/api/v2/quantum/storage/metadataPlanned capability: apply the requested transition to file meta data through the authoritative trust service boundary.›POSTCreate new folder/api/v2/quantum/storage/newfolderPlanned capability: apply the requested transition to new folder through the authoritative trust service boundary.›POSTRecycle file in datavault/api/v2/quantum/storage/recyclePlanned capability: apply the requested transition to recycle file in datavault through the authoritative trust service boundary.›POSTRename items in datavault/api/v2/quantum/storage/renamePlanned capability: apply the requested transition to rename items in datavault through the authoritative trust service boundary.›POSTRestore file from recycle bin/api/v2/quantum/storage/restorePlanned capability: apply the requested transition to restore file from recycle bin through the authoritative trust service boundary.›POSTUpload file to data vault/api/v2/quantum/storage/uploadPlanned capability: apply the requested transition to upload file to data vault through the authoritative trust service boundary.›POSTUse owner approved application encrypted files/api/v2/data-vault/filesUpload and retrieve encrypted files created through this exact confidential application and consenting owner; obtain backend decryption only after separate exact-file approval.›GETList compose public vault asset holdings/api/v2/explorer/vault-assets/{uuid}Planned capability: planning marker for the Explorer website's vault-holdings composition. Canonical integrations list assets with owner_vault_uuid, fetch exact asset records when holding-level detail is needed, and optionally join the public vault and vault-history reads by vault UUID.›GETGet all vaults/api/v2/explorer/vaultsList all vaults from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet vault record/api/v2/explorer/vaults/{uuid}Return vaults uuid from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet vault details/api/v2/explorer/vaults/{vault_uuid}Return vault details from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›GETGet vault history/api/v2/explorer/vaults/{vault_uuid}/historyReturn the ordered public record for vault history from the public Explorer read model, with the identifiers and verification metadata defined by the live contract.›