API Reference

The SovSeal API allows developers to programmatically manage vaults, assets, guardians, and heirs. Our API is REST-based and follows the simplified v2.0 architecture.

Authentication

All requests require a SovSeal API Key provided in the x-api-key header.

curl -H "x-api-key: YOUR_KEY" https://api.sovseal.com/v1/vault

Types

Heir

interface Heir {
  id: string;
  name: string;
  email: string;
  walletAddress?: string;
}

Guardian

interface Guardian {
  id: string;
  name: string;
  email: string;
  walletAddress?: string;
}

Vault State

type VaultState = 'active' | 'releasing' | 'released';

Release Trigger

type ReleaseTrigger = 'dead_man_switch' | 'manual' | 'guardian_claim';

SSS Preset

type SSSPreset = 'standard' | 'enhanced';

Endpoints

Vaults

GET /api/vault

List all vaults owned by the authenticated user.

GET /api/vault/:id

Retrieve details for a specific vault.

POST /api/vault/:id/release/config

Update the release trigger configuration.

• Body: { trigger: ReleaseTrigger, config: any }

People (Guardians & Heirs)

POST /api/vault/:id/guardian

Add a guardian to the vault.

• Body: { name: string, email: string, walletAddress?: string }

POST /api/vault/:id/heir

Add an heir to the vault.

• Body: { name: string, email: string, walletAddress?: string }

Assets

POST /api/vault/:id/asset

Upload an encrypted asset to the vault.

Deprecated Endpoints (v1.0)

The following endpoints have been removed in v2.0:

• POST /api/vault/:id/lock
• POST /api/vault/:id/unlock
• * /api/vault/:id/protection/*
• * /api/vault/:id/succession/*
• POST /api/vault/:id/release/contest
• * /api/vault/:id/verification
• * /api/vault/:id/certificate
• GET /api/verify/:hash

See the Migration Guide for details on how to map your old integration to the new API.