JavaScript / TypeScript SDK

import { TruthlockClient, Algorithm, Verdict } from "@truthlock/sdk";

// 1. Create client
const client = new TruthlockClient({
  baseUrl: "https://api.truthlocks.com",
  auth: {
    type: "apiKey",
    apiKey: "tl_live_...",
    tenantId: "your-tenant-id",
  },
});

// 2. Create and trust an issuer
const issuer = await client.issuers.create({
  name: "My Organization",
  legal_name: "My Organization Inc.",
  display_name: "My Org",
});
await client.issuers.trust(issuer.id);

// 3. Register a signing key
await client.keys.register(issuer.id, {
  kid: "key-2026",
  alg: Algorithm.Ed25519,
  public_key_b64url: "your-public-key-base64url",
});

// 4. Mint an attestation
const attestation = await client.attestations.mint({
  issuer_id: issuer.id,
  kid: "key-2026",
  alg: Algorithm.Ed25519,
  schema: "degree",
  claims: {
    student_name: "Jane Doe",
    degree_type: "Bachelor of Science",
  },
});

console.log("Attestation ID:", attestation.id);

// 5. Verify
const result = await client.verify.verifyOnline({
  attestation_id: attestation.id,
});

if (result.verdict === Verdict.Valid) {
  console.log("Attestation verified successfully");
}

import { TruthlockClient, Verdict } from "@truthlock/sdk";

const client = new TruthlockClient({
  baseUrl: "https://api.truthlocks.com",
  auth: { type: "apiKey", apiKey: "tl_live_...", tenantId: "your-tenant-id" },
});

const revoked = await client.attestations.revoke(
  "660e8400-e29b-41d4-a716-446655440001",
  { reason: "Certificate holder no longer employed" }
);

console.log("Status:", revoked.status); // "REVOKED"
console.log("Revoked at:", revoked.revoked_at);

// Subsequent verifications reflect the revocation
const check = await client.verify.verifyOnline({
  attestation_id: "660e8400-e29b-41d4-a716-446655440001",
});
console.log("Verdict:", check.verdict); // "REVOKED"

import { TruthlockClient, Algorithm } from "@truthlock/sdk";

const client = new TruthlockClient({
  baseUrl: "https://api.truthlocks.com",
  auth: { type: "apiKey", apiKey: "tl_live_...", tenantId: "your-tenant-id" },
});

// Supersede an attestation with updated claims
const updatedPayload = Buffer.from(
  JSON.stringify({
    student_name: "Jane Doe",
    degree_type: "Master of Science", // Updated from Bachelor to Master
  })
).toString("base64url");

const result = await client.attestations.supersede(
  "660e8400-e29b-41d4-a716-446655440001", // Original attestation ID
  { new_payload_b64url: updatedPayload }
);

console.log("Old attestation status:", result.old.status); // "SUPERSEDED"
console.log("New attestation ID:", result.new.attestation_id);

auth: {
  type: 'apiKey',
  apiKey: 'tl_live_...',     // From Console > Settings > API Keys
  tenantId: 'your-tenant-id', // From Console > Settings > General
}

auth: {
  type: 'bearer',
  token: 'eyJhbGciOi...',  // JWT from login flow
}

auth: {
  type: 'service',
  apiKey: 'tl_svc_...',
  tenantId: 'your-tenant-id',
}

import { TruthlockClient } from "@truthlock/sdk";

const client = new TruthlockClient({
  baseUrl: "https://api.truthlocks.com",
  auth: { type: "apiKey", apiKey: "tl_live_...", tenantId: "your-tenant-id" },
});

// Create a governance request to suspend an issuer
const req = await client.governance.createRequest({
  action: "suspend",
  issuer_id: "issuer-uuid",
  reason: "Compliance review pending",
});
console.log(`Request created: ${req.id} (status: ${req.status})`);

// Another authorized user approves the request
await client.governance.approveRequest(req.id);

// Execute the approved request
const result = await client.governance.executeRequest(req.id);
console.log(`Executed: ${result.id} — issuer is now ${result.issuer_status}`);

// List all governance requests
const requests = await client.governance.listRequests();
for (const r of requests) {
  console.log(`[${r.status}] ${r.action} ${r.issuer_id} — ${r.reason}`);
}

import { TruthlockClient } from "@truthlock/sdk";

const client = new TruthlockClient({
  baseUrl: "https://api.truthlocks.com",
  auth: { type: "apiKey", apiKey: "tl_live_...", tenantId: "your-tenant-id" },
});

// Query recent attestation events
const events = await client.audit.query({
  action: "attestation.mint",
  from: "2026-06-01T00:00:00Z",
  to: "2026-06-30T23:59:59Z",
  limit: 100,
});
for (const evt of events.data) {
  console.log(`[${evt.timestamp}] ${evt.action} by ${evt.actor_id}`);
}

// Start an async export for compliance
const exportJob = await client.audit.export({
  from: "2026-01-01T00:00:00Z",
  to: "2026-06-30T23:59:59Z",
  report_type: "soc2", // "soc2", "gdpr", "hipaa", or omit for raw
  format: "json",
});
console.log(`Export started: ${exportJob.id} (status: ${exportJob.status})`);

import { TruthlockClient } from "@truthlock/sdk";

const client = new TruthlockClient({
  baseUrl: "https://api.truthlocks.com",
  auth: { type: "apiKey", apiKey: "tl_live_...", tenantId: "your-tenant-id" },
});

// Mint a payment receipt
const receipt = await client.receipts.mint({
  issuer_id: "your-issuer-id",
  kid: "ed-key-2026",
  alg: "Ed25519",
  receipt_type: "payment_receipt",
  subject: "customer@example.com",
  payload: {
    amount: 5000,
    currency: "USD",
    provider: "stripe",
    provider_reference: "ch_3Px...",
  },
});

// Verify a receipt
const result = await client.receipts.verify(receipt.receipt_id);
console.log("Verdict:", result.verdict); // "VALID"

// Download a proof bundle for offline verification
const bundle = await client.receipts.getProofBundle(receipt.receipt_id);

// Search receipts
const results = await client.receipts.search({
  q: "stripe",
  receipt_type: "payment_receipt",
  from_date: "2026-01-01T00:00:00Z",
});

// Export receipts as JSON
const exportJob = await client.receipts.export({
  format: "json",
  filters: { receipt_type: "payment_receipt" },
});
// Poll for completion
const completed = await client.receipts.getExport(exportJob.id);

// Redact PII from a receipt (permanent, for GDPR erasure requests)
await client.receipts.redact(receipt.receipt_id);