Liccium Developer Portal
Declaration Engine API

Schemas

TsaSignature

  • tsrstring · required

    Base64-encoded TimeStampResponse (TSR) from the TSA

  • tsqstring · required

    Base64-encoded TimeStampQuery (TSQ) sent to the TSA

Credential

  • idstring · uri · required

    Unique identifier for the credential

  • typestring[] · required

    Credential types indicating its structure and semantics

  • @contextstring[]

    JSON-LD context for the credential

  • 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

  • credentialSchemaobject[]

    External schema(s) defining the structure of the credential

  • proofobject

    Cryptographic proof of the credential

Declaration

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

    JWT signature of declaration metadata

  • tsaSignatureobject · required

    Timestamp Authority signature containing timestamp request and response payloads

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

    JWT signature of the tdmaiRegistry payload. Required when tdmaiRegistry is provided.

  • tdmaiRegistryTsaSignatureobject

    TSA signature of the tdmaiRegistry payload. Required when tdmaiRegistry is provided.

ApiResponse

  • codeinteger · int32
  • typestring
  • messagestring

DeclarationResponse

  • rayIdstring

    Unique identifier for the request

  • messagestring

    Status message of the ingestion

  • envstring

    Environment where the declaration was ingested

  • isccstring

    ISCC code of the ingested declaration

  • cidV1string

    Content Identifier Version 1 of the ingested declaration

  • versionstring

    API version

ErrorResponse

  • errorstring

    Error type or title

  • messagestring

    Detailed error message

  • isccstring

    ISCC code if available

  • jwkErrorstring
  • tsaErrorsstring[]
  • providedTimestampinteger
  • serverTimeinteger

FaiaPlugin

  • faiaFlagstring · enum · required

    FAIA category flag classifying the role of AI in the published content

    Enum values:
    hcc
    aac
    aig
  • activityCodestring · enum

    FAIA activity code describing the specific type of AI involvement. Not applicable to hcc declarations. aac: coCreation, contribution, enhancement, refinement. aig: transformation, analysis.

    Enum values:
    coCreation
    contribution
    enhancement
    refinement
    transformation
    analysis
  • systemAttributionstring

    Name or identifier of the AI system used (e.g. ChatGPT, Google Gemini, Stable Diffusion 3)

  • systemVersionstring

    Version of the AI system used (e.g. GPT-4o, v1.3.2). Requires systemAttribution to also be present.

ValidationErrorResponse

  • errorstring

    Error type

  • messagestring

    Summary of the validation failure

  • schemaUrlstring
  • contextUrlstring
  • validationErrorsstring[]

    List of specific validation errors

  • isccstring