CommonsDB Developer PortalCommonsDB Developer PortalCommonsDB Developer Portal
  • Documentation
  • Declaration API
  • Metadata API
  • Search API
  • Status API
metadata
    Retrieve declaration metadata by identifiergetRetrieve declaration metadata by identifier (Public)get
Schemas
powered by Zudoku
Metadata Engine API

Schemas


TsaSignature

  • tsrstring

    Base64-encoded TimeStampResponse (TSR)

  • tsqstring

    Base64-encoded TimeStampQuery (TSQ)

Declaration

  • signaturestring

    JWT signature of the declaration metadata

  • tsaSignatureobject

    Timestamp Authority signature

  • commonsDbRegistrySignaturestring

    JWT signature of commonsDbRegistry (if present)

  • commonsDbRegistryTsaSignatureobject

    Timestamp Authority signature

  • declarationMetadataobject
  • metaInternalobject

    Internal metadata for tracking and identification

MetaInternal

  • rayIdstring

    Original request tracking ID

  • cidstring

    CID identifier

  • cidV1string

    CIDv1 identifier - primary identifier for retrieval

  • declarationIdstring

    Declaration identifier

  • isccCodestring

    ISCC code

  • companyIdstring

    Company DID

  • declarerIdstring

    Declarer DID

PublicMetadata

  • $schemastring · uri

    Schema URL

  • @contextstring · uri

    JSON-LD context URL

  • isccstring

    ISCC code

  • namestring

    Title of the Work

  • descriptionstring

    Description of the Work

  • mediatypestring

    MIME type

  • thumbnailstring

    Base64-encoded thumbnail

  • redirectstring · uri

    Redirect URL

  • sourceUrlstring · uri

    Source URL

  • supersedesstring

    CIDv1 identifier of a previous declaration this one supersedes. When declaring: (1) the referenced declaration must exist, (2) it must not already be superseded, and (3) only the original declarer can supersede their own declaration.

  • timestampinteger · int64

    Unix timestamp in milliseconds

  • declarerIdstring

    DID of the declarer

  • entryUUIDstring · uuid

    Entry UUID from source system

  • versioninteger

    Declaration version

  • credentialsobject[]

    Verifiable credentials

  • supplierMetadataobject

    Additional metadata from the supplier

CommonsDbRegistry

  • isccstring

    ISCC code

  • locationstring · uri

    URL of the content at the supplier

  • rightsStatementstring · uri

    License/rights statement URL

  • timestampinteger · int64

    Unix timestamp in milliseconds

  • declarationIdstring

    Reference to related declaration

  • credentialsobject[]

Credential

  • @contextstring[]
  • idstring · uri
  • typestring[]
  • issuerstring
  • validFromstring · date-time
  • validUntilstring · date-time
  • credentialSubjectobject
  • proofobject

ErrorResponse

  • errorstring

    Error type or title

  • messagestring

    Detailed error message

On this page
  • TsaSignature
  • Declaration
  • MetaInternal
  • PublicMetadata
  • CommonsDbRegistry
  • Credential
  • ErrorResponse