Integration Playbook by Product Tier

Use this guide to determine which SOVEREIGN\PROVENANCE product a team should adopt and what integration pattern to follow.

Tier cheat sheet

Creator Shield — single creators or small studios embedding provenance directly into their publishing tools. Integrate via identity, creator/artifacts, and provenance APIs or the SDK helper methods.
Dataset Passport — institutional stewards managing datasets, storage connectors, and Guardian publications. Focus on ai/datasets, passport, and guardian/reports.
Lab Provenance & Compliance — AI labs with high dataset/run volume and regulatory reporting needs. Integrate the ai/* routes plus Auditor exports, and enable synthetic registration.
Platform Integrity API — high-volume upload scanning and lineage for platforms. Wire the /platforms/* endpoints into upload pipelines and Trust & Safety dashboards.
City / Guardian Node — civic or institutional guardrails. Deploy Guardian nodes, connect ledger mirrors, and automate /guardian/enforce plus /guardian/reports.
Sovereign Vault (Enterprise) — enterprises that need isolated tenants, private Guardian/Auditor clusters, and integrations into CI/CD + legal tooling. Use /enterprise/*, Guardian, and Auditor APIs together.

Persona	Pick this product	Why
Solo creator / boutique studio	Creator Shield	Fast time-to-value, dispute-ready outputs, auditor bundles included.
Museum, archive, civic steward	Dataset Passport	Built-in Guardian distribution + dataset policy binding.
AI lab / ML governance	Lab Provenance & Compliance	Synthetic registration and compliance bundles are entitlement-gated here.
Marketplace / consumer platform	Platform Integrity API	Volume-based pricing, upload hooks, lineage tracking.
City / National archive / regulator	City Guardian Node	Runs Guardian node clusters with policy enforcement + alerting.
Regulated enterprise	Sovereign Vault	Private runtime + Guardian/Auditor with SLAs, unlimited scale.

Pick a product ID — reference packages/product-config/src/products.ts for canonical IDs.
Map API keys — set PRODUCT_SUBSCRIPTIONS in apps/api env so each key resolves to the correct productId + entitlements.
Attach product headers (optional) — sending x-product-id allows multi-product sandboxes using the same API key.
Use the right SDK flows — each developer doc under docs/developer/*.md includes a minimal createSovProvClient recipe.
Mirror docs into UX — apps/web product pages are now powered by the same definitions, keeping marketing + docs aligned.