CommonsDB Developer PortalCommonsDB Developer PortalCommonsDB Developer Portal
  • Documentation
  • Declaration API
  • Metadata API
  • Search API
  • Status API
declare
    Submit a new Declaration to registriespost
Schemas
powered by Zudoku
Declaration Engine API

Schemas


TsaSignature

  • tsrstring · required

    Base64-encoded TimeStampResponse (TSR) from the TSA

  • tsqstring · required

    Base64-encoded TimeStampQuery (TSQ) that was sent to the TSA

Credential

  • @contextstring[]

    JSON-LD context for the credential

  • idstring · uri

    Unique identifier for the credential

  • typestring[]

    Credential types indicating its structure and semantics

  • issuerstring

    Identifier of the credential issuer, typically a DID

  • validFromstring · date-time

    Start time when the credential becomes valid

  • validUntilstring · date-time

    Expiration time of the credential

  • credentialSubjectobject

    Subject of the credential and its properties

  • proofobject

    Cryptographic proof of the credential

CommonsDbRegistryCredential

  • proofstring · required

    JWT signature proof of the credential

PublicMetadata

  • $schemastring · uri · required

    URL to the JSON schema used to validate the declaration structure. Must match pattern: https://w3id.org/(commonsdb|liccium)/schema/X.X.X.json with minimum version 0.2.0

  • @contextstring · uri · required

    URL to the JSON-LD context for the declaration. Must match pattern: https://w3id.org/(commonsdb|liccium)/context/X.X.X.json with minimum version 0.2.0

  • isccstring · pattern: ^ISCC:[A-Z0-9]{55}$ · required

    ISCC code identifying the digital content. Must be exactly 55 alphanumeric characters after 'ISCC:'

  • namestring · minLength: 1 · required

    Title of the Work

  • timestampinteger · int64 · required

    Unix timestamp in milliseconds. Must be within 60 seconds of server time when submitting.

  • declarerIdstring · pattern: ^did:[a-z0-9]+: · required

    DID (Decentralized Identifier) of the declaring entity

  • descriptionstring

    Description of the Work

  • mediatypestring

    MIME type of the declared content

  • thumbnailstring

    Base64-encoded image embedded as a Data URI, typically a small preview

  • redirectstring · uri

    A URL where users should be directed

  • sourceUrlstring · uri

    The original source of the content, such as where it was first published

  • supersedesstring

    CIDv1 identifier of a previous declaration this one supersedes. Validation rules:

    1. The referenced declaration must exist in the registry
    2. The referenced declaration must not already be superseded by another declaration
    3. Only the original declarer can supersede their own declaration - this is a security measure to prevent unauthorized modifications and cross-event attacks where different parties try to supersede the same declaration simultaneously

    If any validation fails, a 422 error will be returned. A declaration can only be superseded once, and only by its original owner.

  • versioninteger · min: 1

    Version number of the declaration

  • entryUUIDstring · uuid

    Unique identifier for the entry from an authority source

  • credentialsobject[] · minItems: 1

    Array of verifiable credentials. Must contain at least one credential.

  • supplierMetadataobject

    Additional metadata from the data supplier

  • liccium_pluginsobject

    Optional plugin metadata (IPTC, TDM/AI, C2PA)

CommonsDbRegistry

  • isccstring · pattern: ^ISCC:[A-Z0-9]{55}$ · required

    ISCC code (must match publicMetadata.iscc)

  • locationstring · uri · required

    URL of the content at the supplier's repository

  • rightsStatementstring · uri · required

    License URI. Must be a valid Creative Commons or Public Domain license. Allowed values include:

    Public Domain:

    • https://creativecommons.org/publicdomain/mark/1.0/
    • https://creativecommons.org/publicdomain/zero/1.0/

    CC BY (all versions 1.0-4.0, including country ports):

    • https://creativecommons.org/licenses/by/4.0/
    • https://creativecommons.org/licenses/by/3.0/
    • etc.

    CC BY-SA (all versions 1.0-4.0, including country ports):

    • https://creativecommons.org/licenses/by-sa/4.0/
    • https://creativecommons.org/licenses/by-sa/3.0/
    • etc.
  • timestampinteger · int64 · required

    Unix timestamp in milliseconds. Must be within 60 seconds of server time.

  • credentialsobject[] · minItems: 1 · required

    Array of credentials with proof. Must contain at least one credential.

  • declarationIdstring

    Optional reference to a previous declaration

Declaration

  • signaturestring · pattern: ^[A-Za-z0-9_-]+\.[A-… · required

    JWT signature of the declaration metadata. Must use ES256 algorithm with JWK embedded in the header.

  • tsaSignatureobject · required

    Timestamp Authority signature containing the timestamp request and response

  • declarationMetadataobject · required
  • commonsDbRegistrySignaturestring · pattern: ^[A-Za-z0-9_-]+\.[A-…

    JWT signature of the commonsDbRegistry metadata. Required when commonsDbRegistry is provided.

  • commonsDbRegistryTsaSignatureobject

    TSA signature for commonsDbRegistry. Required when commonsDbRegistry is provided.

DeclarationSuccessResponse

  • rayIdstring

    Unique request identifier for tracking

  • messagestring · enum

    Status message indicating the declaration was accepted

    Enum values:
    accepted and pending
    accepted and pending, tracking may be delayed
  • envstring

    Environment where the declaration was processed

  • isccstring

    ISCC code of the submitted declaration

  • cidV1string

    CIDv1 identifier generated for the declaration. Use this to track status via /v1/status/{identifier} endpoint.

  • versionstring

    API version

ErrorResponse

  • errorstring

    Error type or title

  • messagestring

    Detailed error message

  • isccstring

    ISCC code if available

ValidationErrorResponse

  • errorstring

    Error type

  • messagestring

    Summary of the validation failure

  • schemaUrlstring

    Schema URL that was used for validation

  • contextUrlstring

    Context URL that was used for validation

  • schemaVersionstring

    Schema version

  • contextVersionstring

    Context version

  • validationErrorsstring[]

    List of specific validation errors

  • isccstring

    ISCC code if available

On this page
  • TsaSignature
  • Credential
  • CommonsDbRegistryCredential
  • PublicMetadata
  • CommonsDbRegistry
  • Declaration
  • DeclarationSuccessResponse
  • ErrorResponse
  • ValidationErrorResponse