Reference

API Reference

REST endpoints for the SOVEREIGN\PROVENANCE platform. Search by path, method, or group. Deep links from System Maintenance land on the matching section.

5 categories41 groups161 listed routesSystem Maintenance →

Copy a route to the clipboard, or jump from the outline.

Customer Success & Management

26 routes

Customer Onboarding System

4 endpoints
  • POST/api/v1/admin/onboard
  • GET/api/v1/admin/organizations/:id/onboarding-checklist
  • GET/api/v1/admin/organizations
  • POST/api/v1/admin/organizations

Organization Management

7 endpoints
  • GET/api/v1/admin/organizations
  • POST/api/v1/admin/organizations
  • GET/api/v1/admin/organizations/:id
  • PUT/api/v1/admin/organizations/:id
  • POST/api/v1/admin/organizations/:id/users
  • GET/api/v1/admin/organizations/:id/activity
  • GET/api/v1/admin/organizations/:id/stats

Subscription Management

7 endpoints
  • POST/api/v1/admin/subscriptions
  • GET/api/v1/admin/subscriptions
  • GET/api/v1/admin/subscriptions/:id
  • PUT/api/v1/admin/subscriptions/:id
  • POST/api/v1/admin/api-keys
  • DELETE/api/v1/admin/api-keys/:id
  • GET/api/v1/admin/api-keys/:id/usage

Customer Provenance Workspaces

2 endpoints
  • GET/api/v1/admin/organizations/:id
  • GET/api/v1/admin/organizations/:id/stats

Investor Portal

0 endpoints

See System Maintenance for routes and the testing guide.

Customer Health Monitoring

4 endpoints
  • GET/api/v1/admin/organizations/:id/stats
  • GET/api/v1/admin/organizations/:id/activity
  • GET/api/v1/admin/subscriptions/:id
  • GET/api/v1/admin/api-keys/:id/usage

Backend Services

38 routes

API Service

7 endpoints
  • GET/api/v1/health
  • GET/api/v1/provenance/*
  • GET/api/v1/identity/*
  • GET/api/v1/seal/*
  • GET/api/v1/passport/*
  • GET/api/v1/accord/*
  • GET/api/v1/ledger/*

Ledger Service

3 endpoints
  • GET/api/v1/ledger/events
  • GET/api/v1/ledger/integrity
  • GET/api/v1/ledger/query

Identity Engine

3 endpoints
  • GET/api/v1/identity/create
  • GET/api/v1/identity/verify
  • GET/api/v1/identity/trust

Seal Engine

3 endpoints
  • GET/api/v1/seal/create
  • GET/api/v1/seal/verify
  • GET/api/v1/seal/similarity

Passport Engine

3 endpoints
  • GET/api/v1/passport/create
  • GET/api/v1/passport/verify
  • GET/api/v1/passport/:id

Accord Engine

3 endpoints
  • GET/api/v1/accord/evaluate
  • GET/api/v1/accord/rules
  • GET/api/v1/accord/explain

Model Provenance Engine

4 endpoints
  • GET/api/v1/ai/datasets/register
  • GET/api/v1/ai/models/register
  • GET/api/v1/ai/training/register
  • GET/api/v1/ai/inference/register

Auditor Service

3 endpoints
  • GET/api/v1/auditor/artifact/:id
  • GET/api/v1/auditor/identity/:id
  • GET/api/v1/auditor/system

Runtime Service

3 endpoints
  • GET/api/v1/runtime/workflow
  • GET/api/v1/runtime/queue
  • GET/api/v1/runtime/state

Guardian Node

3 endpoints
  • GET/api/v1/guardian/status
  • GET/api/v1/guardian/integrity
  • GET/api/v1/guardian/governance

Governance Service

3 endpoints
  • GET/api/v1/governance/proposals
  • GET/api/v1/governance/vote
  • GET/api/v1/governance/history

API Endpoints

71 routes

Provenance APIs

6 endpoints
  • POST/api/v1/provenance/manifest
  • GET/api/v1/provenance/manifest/:id
  • POST/api/v1/provenance/lineage
  • GET/api/v1/provenance/lineage/:artifactId
  • POST/api/v1/provenance/seal
  • POST/api/v1/provenance/verify

Identity APIs

4 endpoints
  • POST/api/v1/identity/create
  • GET/api/v1/identity/:id
  • POST/api/v1/identity/verify
  • GET/api/v1/identity/trust/:id

Rights & Protocol APIs

5 endpoints
  • POST/api/v1/rights/apply
  • GET/api/v1/rights/:artifactId
  • POST/api/v1/protocols/create
  • GET/api/v1/protocols/list
  • POST/api/v1/protocols/attach

Persona-Specific APIs

7 endpoints
  • POST/api/v1/creator/artifacts/register
  • POST/api/v1/ai/datasets/register
  • POST/api/v1/ai/models/register
  • POST/api/v1/enterprise/projects
  • POST/api/v1/platforms/verify-upload
  • POST/api/v1/institutions/objects/bulk
  • POST/api/v1/civic/records/seal

Lineage APIs

4 endpoints
  • POST/api/v1/lineage
  • GET/api/v1/lineage/:artifactId
  • POST/api/v1/lineage/:artifactId/entry
  • GET/api/v1/lineage/:artifactId/chain

Synthetic APIs

4 endpoints
  • POST/api/v1/synthetic/register
  • GET/api/v1/synthetic/:id
  • POST/api/v1/synthetic/verify
  • GET/api/v1/synthetic/disclosure/:artifactId

Artifacts APIs

4 endpoints
  • POST/api/v1/artifacts
  • GET/api/v1/artifacts/:id
  • GET/api/v1/artifacts
  • PUT/api/v1/artifacts/:id

Events & Analytics APIs

4 endpoints
  • POST/api/v1/events
  • GET/api/v1/events
  • GET/api/v1/events/analytics
  • GET/api/v1/events/metrics

Telemetry APIs

4 endpoints
  • GET/api/v1/telemetry/health
  • GET/api/v1/telemetry/network
  • GET/api/v1/telemetry/gtm
  • GET/api/v1/telemetry/metrics

GTM APIs

4 endpoints
  • GET/api/v1/gtm/partners
  • POST/api/v1/gtm/briefs
  • GET/api/v1/gtm/recommendations
  • GET/api/v1/gtm/analytics

Jobs APIs

4 endpoints
  • POST/api/v1/jobs/trigger
  • GET/api/v1/jobs/:id
  • GET/api/v1/jobs
  • POST/api/v1/jobs/cancel/:id

Zone Management APIs

4 endpoints
  • POST/api/v1/zones
  • GET/api/v1/zones
  • GET/api/v1/zones/:id
  • PUT/api/v1/zones/:id

Admin Management APIs

5 endpoints
  • POST/api/v1/admin/organizations
  • GET/api/v1/admin/organizations
  • POST/api/v1/admin/subscriptions
  • POST/api/v1/admin/api-keys
  • POST/api/v1/admin/onboard

Customer Self-Service APIs

4 endpoints
  • GET/api/v1/self-service/account
  • PUT/api/v1/self-service/account
  • GET/api/v1/self-service/subscription
  • GET/api/v1/self-service/usage

Cultural APIs

4 endpoints
  • POST/api/v1/cultural/register
  • GET/api/v1/cultural/:id
  • POST/api/v1/cultural/protocols
  • GET/api/v1/cultural/ecosystem

Admin APIs

4 endpoints
  • POST/api/v1/admin/organizations
  • GET/api/v1/admin/organizations
  • GET/api/v1/admin/analytics
  • GET/api/v1/admin/telemetry

Products & Features

24 routes

Creator Shield

4 endpoints
  • POST/api/v1/identity
  • POST/api/v1/creator/artifacts/register
  • POST/api/v1/passport
  • POST/api/v1/provenance/verify

Dataset Passport

4 endpoints
  • POST/api/v1/identity
  • POST/api/v1/passport
  • POST/api/v1/guardian/reports
  • GET/api/v1/provenance/verify

Lab Provenance & Compliance

4 endpoints
  • POST/api/v1/identity
  • POST/api/v1/ai/datasets/register
  • POST/api/v1/ai/models/register
  • POST/api/v1/ai/training/register

Platform Integrity API

4 endpoints
  • POST/api/v1/platforms/verify-upload
  • POST/api/v1/platforms/record-transformation
  • GET/api/v1/platforms/docket/:platformId
  • GET/api/v1/platforms/badge/:hash

City & Institutional Guardian Node

4 endpoints
  • POST/api/v1/identity
  • GET/api/v1/guardian/status
  • POST/api/v1/guardian/enforce
  • POST/api/v1/guardian/reports

Sovereign Vault (Enterprise)

4 endpoints
  • POST/api/v1/identity
  • POST/api/v1/enterprise/projects
  • GET/api/v1/enterprise/projects/:id/provenance/export
  • POST/api/v1/guardian/enforce

Testing & Development

2 routes

Health Checks

2 endpoints
  • GET/api/v1/health
  • GET/api/v1/telemetry/health

For full endpoint details, cURL examples, and testing guides, use the System Maintenance portal (password required).