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

declare

Endpoint:https://api.commonsdb.org

Declaration submission operations


Submit a new Declaration to registries

POST
https://api.commonsdb.org
/v1/declare

Submit a new Declaration to the CommonsDB registry. The declaration must include:

  • JWT signature with embedded JWK in the header (ES256 algorithm)
  • TSA signature with timestamp request (TSQ) and response (TSR)
  • Schema and Context URLs pointing to valid CommonsDB schemas (minimum version 0.2.0)
  • Timestamp within 60 seconds of server time
  • Valid ISCC code in format ISCC:XXXXXXX (55 character alphanumeric code)
  • Valid rightsStatement (if commonsDbRegistry is provided) - must be a Creative Commons or Public Domain license URL

Submit a new Declaration to registries › Headers

  • Authorizationstring · required

    Bearer token for authentication (e.g., Bearer <your-api-key>)

Submit a new Declaration to registries › Request Body

  • 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.

Submit a new Declaration to registries › Responses

Declaration accepted and pending processing

  • 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

POST /v1/declare