Declaration Engine API

Schemas


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 · required

    signature of declaration metadata

  • tsaSignaturestring

    signature of declaration metadata with timestamp service

  • tdmaiRegistrySignaturestring

    signature of declaration metadata

  • tdmaiRegistryTsaSignaturestring

    signature of declaration metadata with timestamp service

  • declarationMetadataobject

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