Skip to main content
The TimeLockData API provides endpoints for managing evidences — cryptographically anchored records that prove specific data existed in a specific state at a specific time — with full traceability on the blockchain.

Base URL

https://api.timelockdata.com/api/v1

Authentication

All requests require an API Key passed in the X-API-Key header.
X-API-Key: your_api_key
See Authentication for details.

Endpoint Groups

Health

EndpointMethodDescriptionAuth
/testGETAPI health checkNone

Categories

EndpointMethodDescription
/evidences/{COMPANY_ID}/categoryPOSTCreate a category
/evidences/{COMPANY_ID}/categoryGETList all categories
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}GETGet category details
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}PUTUpdate a category
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/filesGETList category files

Subcategories

EndpointMethodDescription
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/subcategoryPOSTCreate a subcategory
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/subcategory/{SUBCATEGORY_ID}GETGet subcategory details
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/subcategory/{SUBCATEGORY_ID}PUTUpdate a subcategory
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/subcategory/{SUBCATEGORY_ID}/filesGETList subcategory files

Evidences

EndpointMethodDescription
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/subcategory/{SUBCATEGORY_ID}/evidencePOSTCreate an evidence
/evidences/{COMPANY_ID}/evidencePOSTCreate with inline category creation
/evidences/{COMPANY_ID}/category/{CATEGORY_ID}/subcategory/{SUBCATEGORY_ID}/evidencesPOSTCreate in batch
/evidences/{COMPANY_ID}/evidencesGETList evidences
/evidences/{COMPANY_ID}/evidence/{EVIDENCE_EXTERNAL_ID}GETGet evidence details
/evidences/{COMPANY_ID}/evidence/{EVIDENCE_EXTERNAL_ID}PUTUpdate an evidence
/evidences/{COMPANY_ID}/evidence/{EVIDENCE_EXTERNAL_ID}/filesGETList evidence files
/evidences/{COMPANY_ID}/blockinfoPOSTGet blockchain statistics

Files

EndpointMethodDescription
/evidences/{COMPANY_ID}/filePOSTUpload files
/evidences/{COMPANY_ID}/fileGETDownload a file
/evidences/{COMPANY_ID}/fileDELETEDelete a file
/file/{COMPANY_ID}/{FILE_ID}GETRetrieve file content

Verification (Public, no auth required)

EndpointMethodDescription
/merkle/root/{txid}GETGet Merkle root for a transaction
/merkle/proof/{txid}GETGet Merkle proof for a transaction
/merkle/validatePOSTValidate a Merkle proof
/merkle/verify/{evidenceId}GETVerify an evidence record
/merkle/verify/{evidenceId}/{fileId}GETVerify a file
/merkle/tsa/{batchId}GETDownload TSA token

Source Systems

EndpointMethodDescription
/sourceSystem/{COMPANY_ID}GETList source systems
/sourceSystem/{COMPANY_ID}POSTCreate a source system
/sourceSystem/{COMPANY_ID}/{SYSTEM_ID}PATCHUpdate a source system
/sourceSystem/{COMPANY_ID}/{SYSTEM_ID}DELETEDelete a source system
/sourceSystem/{COMPANY_ID}/healthzGETSource system health check

Content Types

  • JSON requests: Content-Type: application/json
  • File uploads: Content-Type: multipart/form-data

HTTP Status Codes

CodeDescription
200Success (GET, PUT, DELETE)
201Created (POST)
400Invalid request data
401Missing or invalid credentials
403Insufficient permissions
404Resource not found
409Resource already exists

Error Response Format

{
  "error": "Error message",
  "code": "ERROR_CODE"
}

Blockchain Integration

All evidence operations (create, update, transfer) are recorded on the blockchain providing:
  • Immutable audit trails
  • Cryptographic verification via Merkle proofs
  • eIDAS qualified TSA (Time Stamp Authority) certified timestamps
  • Independent verification without authentication
  • Records remain verifiable even without TimeLockData