@cef-ebsi/vcdm1.1-revocation-statuslist-schema

EBSI StatusList2021 Credential

Schema of an EBSI StatusList2021 Verifiable Credential

The schema is published to the Trusted Schemas Registry with the IDs:

• 0x5c6bc6d5d778034f093c8aeb5f9381e3f0229d396b0f42d0ae7e14aab5856f99 (hexadecimal)
• z7DmpwC9doRxZrtQ9PBjz8qQgGWqojkGExELnrw1x8qdi (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EBSI StatusList2021 Credential",
  "description": "Schema of an EBSI StatusList2021 Verifiable Credential",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "credentialSubject": {
          "description": "Defines information about the subject that is described by the Verifiable Attestation",
          "type": "object",
          "properties": {
            "id": {
              "description": "Defines the DID of the subject that is described by the Verifiable Attestation",
              "type": "string",
              "format": "uri"
            },
            "type": {
              "description": "Defines the Verifiable Credential subject type",
              "type": "string",
              "const": "StatusList2021"
            },
            "statusPurpose": {
              "description": "Purpose of the status entry",
              "type": "string",
              "enum": ["revocation", "suspension"]
            },
            "encodedList": {
              "description": "Encoded and compressed list of statuses",
              "type": "string"
            }
          },
          "required": ["id", "type", "statusPurpose", "encodedList"]
        }
      },
      "required": ["credentialSubject"]
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/[email protected]

# with Yarn
yarn add @cef-ebsi/[email protected]

# with pnpm
pnpm add @cef-ebsi/[email protected]

Usage

The package exports the schema and its metadata as JavaScript objects:

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-revocation-statuslist-schema";

// you can now use the schema and metadata

In addition, the package exports a TypeScript type corresponding to the schema:

import type { EBSIStatusList2021Credential } from "@cef-ebsi/vcdm1.1-revocation-statuslist-schema";

License

Copyright (c) 2019 European Commission Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at:

• https://joinup.ec.europa.eu/page/eupl-text-11-12

Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence.