Core API

Issue / Seal

Seal an EDM artifact into a cryptographically signed .ddna envelope with W3C Data Integrity Proofs. Creates an immutable, verifiable record.

POST/v1/issuescope: issue

Overview

The Issue endpoint wraps an EDM artifact in a .ddna envelope with a cryptographic proof using the eddsa-jcs-2022 cryptosuite. Each issuance creates a certificate in the DeepaData registry for audit trails.

Pass a pre-extracted artifact object from /v1/extract. For combined extract-and-seal in one call, use /v1/extract-and-seal.

Immutability: Once sealed, the artifact cannot be modified without invalidating the cryptographic proof. Store the envelope and certificate_id for future verification.

Issuance Pathways

The pathway parameter indicates who is sealing the artifact and in what context.

subjectSelf-issued

The subject themselves is sealing their own emotional record. Authority format: user:vp_id

delegatedApp on behalf of user

An application (e.g., therapy platform) seals records on behalf of their users. Authority format: app:platform-name

retrospectiveHistorical data

Sealing historical records that were created before DeepaData integration. Authority format: app:platform-name

Request Body

FieldTypeRequiredDescription
artifactobjectrequiredThe EDM artifact from /v1/extract to seal.
pathwaystringrequired'subject' | 'delegated' | 'retrospective'
authoritystringrequiredWho is sealing: 'user:id' or 'app:platform-name'
subject_refstringoptionalYour external subject identifier (e.g., client ID).
subject_vp_idstringoptionalIf provided, associates this artifact with the subject's VitaPass address — a portable identity their emotional records follow across platforms.
conformance_levelstringoptional'sealed' (default) | 'certified'. Certified runs all five compliance checks (422 on failure) and requires an Extended or Full profile artifact.

Example Request

curl -X POST https://deepadata.com/api/v1/issue \
  -H "Authorization: Bearer dda_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "artifact": { ... },
    "pathway": "delegated",
    "authority": "app:therapy-platform",
    "subject_ref": "client-12345"
  }'

Example Response

{
  "success": true,
  "data": {
    "envelope": {
      "ddna_header": {
        "version": "1.0",
        "format": "ddna",
        "created": "2026-02-24T10:30:00.000Z"
      },
      "edm_payload": {
        "meta": { "id": "edm_01HV8X3K2M...", "version": "0.8.3" },
        "core": { "anchor": "...", "spark": "..." },
        "constellation": { "emotion_primary": "relief" },
        "governance": { "jurisdiction": "HIPAA", "consent_basis": "consent" }
      },
      "proof": {
        "type": "DataIntegrityProof",
        "cryptosuite": "eddsa-jcs-2022",
        "created": "2026-02-24T10:30:01.000Z",
        "verificationMethod": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK#key-1",
        "proofPurpose": "assertionMethod",
        "proofValue": "z5vgFc8h2YR3..."
      }
    },
    "certificate_id": "8f7a3b2c-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
    "conformance_level": "sealed",
    "issuance": {
      "pathway": "delegated",
      "authority": "app:therapy-platform",
      "timestamp": "2026-02-24T10:30:01.000Z",
      "issuer_did": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
    }
  },
  "meta": {
    "version": "0.8.3",
    "issued_at": "2026-02-24T10:30:01.000Z"
  }
}

Governance Metadata at Seal

The sealed envelope header carries governance metadata (jurisdiction, consent_basis, exportability, retention_policy). These values are never inferred or defaulted by the sealing service: each resolves from your artifact's own governance/meta values, then your account settings defaults (jurisdiction and consent basis, configurable in Settings). If a field the EDM spec allows to be null is still unresolved, it is sealed as an explicit null — meaning "not asserted". If consent_basis, which the spec requires, cannot be resolved, the request is refused with a 400 rather than sealing a fabricated value.

Conformance Levels

The conformance level is determined by which checks pass during issuance.

LevelRequirements
CertifiedExtended or Full profile artifact, 5 compliance checks passed. Certified issuance is in development — not yet offered for regulated or enterprise procurement.
SealedValid EDM artifact, W3C Data Integrity Proof, registry entry, VitaPass address created for subject.
CompliantValid EDM JSON conforming to schema (spec level — not issued by this platform). No seal required. Usable in any retrieval stack.

Error Codes

400

Missing or invalid artifact, pathway, or authority

401

Missing or invalid API key

403

API key does not have 'issue' scope

429

Rate limit exceeded

503

Issuer credentials not configured

Related