@latchd/sdk

JavaScript SDK for Latchd consent capture, cookie preferences, legal document rendering, and DSAR flows.

Install

npm install @latchd/sdk

Quick Start

import { init, fetchDocument, captureConsent } from "@latchd/sdk";

const client = init({
  apiKey: "latchd_pk_live_...",
});

const document = await fetchDocument(client, "privacy-policy");

await captureConsent(client, {
  documentId: document.id,
  documentVersion: document.versionNumber,
  userId: "user_123",
  type: "clickwrap",
  contentHash: "sha256-of-rendered-document",
});

Cookie Consent

import {
  createCookieConsentEngine,
  renderCookieBanner,
} from "@latchd/sdk";

const consent = createCookieConsentEngine({
  categories: {
    essential: {
      required: true,
      label: "Essential",
      description: "Required for core site functionality.",
    },
    analytics: {
      label: "Analytics",
      description: "Helps us understand site usage.",
    },
    marketing: {
      label: "Marketing",
      description: "Used for ads and campaign measurement.",
    },
    functional: {
      label: "Functional",
      description: "Stores convenience preferences.",
    },
  },
  storage: { cookieName: "latchd_cookie_prefs" },
  sync: { client, userId: "user_123" },
});

await consent.initialize();

renderCookieBanner(client, "user_123");

Included APIs

• LatchdClient for direct authenticated API access
• fetchDocument() for retrieving published legal documents
• captureConsent() and checkConsent() for clickwrap and consent state
• saveCookiePreference() and getCookiePreferences() for cookie settings
• createCookieConsentEngine() for category-based cookie consent state
• renderCookieBanner() for a lightweight cookie consent UI with manage-preferences controls
• submitDsarRequest() and verifyDsarRequest() for DSAR flows

Configuration

import { init } from "@latchd/sdk";

const client = init({
  apiKey: "latchd_pk_live_...",
  baseUrl: "https://api.latchd.com",
});

apiKey is required. baseUrl is optional and defaults to the hosted Latchd API.

Package Notes

• Zero-dependency package runtime
• Published with provenance from GitHub Actions
• React integrations are available separately in @latchd/react

More public documentation is coming soon.