TsaSignature
tsrstring · requiredBase64-encoded TimeStampResponse (TSR) from the TSA
tsqstring · requiredBase64-encoded TimeStampQuery (TSQ) that was sent to the TSA
Credential
@contextstring[]JSON-LD context for the credential
idstring · uriUnique identifier for the credential
typestring[]Credential types indicating its structure and semantics
issuerstringIdentifier of the credential issuer, typically a DID
validFromstring · date-timeStart time when the credential becomes valid
validUntilstring · date-timeExpiration time of the credential
credentialSubjectobjectSubject of the credential and its properties
proofobjectCryptographic proof of the credential
PublicMetadata
$schemastring · uri · requiredURL 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 · requiredURL 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}$· requiredISCC code identifying the digital content. Must be exactly 55 alphanumeric characters after 'ISCC:'
namestring · minLength: 1 · requiredTitle of the Work
timestampinteger · int64 · requiredUnix timestamp in milliseconds. Must be within 60 seconds of server time when submitting.
declarerIdstring · pattern:^did:[a-z0-9]+:· requiredDID (Decentralized Identifier) of the declaring entity
descriptionstringDescription of the Work
mediatypestringMIME type of the declared content
thumbnailstringBase64-encoded image embedded as a Data URI, typically a small preview
redirectstring · uriA URL where users should be directed
sourceUrlstring · uriThe original source of the content, such as where it was first published
supersedesstringCIDv1 identifier of a previous declaration this one supersedes. Validation rules:
- The referenced declaration must exist in the registry
- The referenced declaration must not already be superseded by another declaration
- 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: 1Version number of the declaration
entryUUIDstring · uuidUnique identifier for the entry from an authority source
credentialsobject[] · minItems: 1Array of verifiable credentials. Must contain at least one credential.
supplierMetadataobjectAdditional metadata from the data supplier
liccium_pluginsobjectOptional plugin metadata (IPTC, TDM/AI, C2PA)
CommonsDbRegistry
isccstring · pattern:^ISCC:[A-Z0-9]{55}$· requiredISCC code (must match publicMetadata.iscc)
locationstring · uri · requiredURL of the content at the supplier's repository
rightsStatementstring · uri · requiredLicense 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):
CC BY-SA (all versions 1.0-4.0, including country ports):
timestampinteger · int64 · requiredUnix timestamp in milliseconds. Must be within 60 seconds of server time.
credentialsobject[] · minItems: 1 · requiredArray of credentials with proof. Must contain at least one credential.
declarationIdstringOptional reference to a previous declaration
Declaration
signaturestring · pattern:^[A-Za-z0-9_-]+\.[A-…· requiredJWT signature of the declaration metadata. Must use ES256 algorithm with JWK embedded in the header.
tsaSignatureobject · requiredTimestamp 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.
commonsDbRegistryTsaSignatureobjectTSA signature for commonsDbRegistry. Required when commonsDbRegistry is provided.
DeclarationSuccessResponse
rayIdstringUnique request identifier for tracking
messagestring · enumStatus message indicating the declaration was accepted
Enum values:accepted and pendingaccepted and pending, tracking may be delayedenvstringEnvironment where the declaration was processed
isccstringISCC code of the submitted declaration
cidV1stringCIDv1 identifier generated for the declaration. Use this to track status via
/v1/status/{identifier}endpoint.versionstringAPI version
ErrorResponse
errorstringError type or title
messagestringDetailed error message
isccstringISCC code if available
ValidationErrorResponse
errorstringError type
messagestringSummary of the validation failure
schemaUrlstringSchema URL that was used for validation
contextUrlstringContext URL that was used for validation
schemaVersionstringSchema version
contextVersionstringContext version
validationErrorsstring[]List of specific validation errors
isccstringISCC code if available