@cef-ebsi/vcdm1.1-type-extensions-credential-status-status-list-2021-schema

EBSI type extension for use of StatusList2021

Defines revocation details for an issued Verifiable Credential

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

• 0x60d2b6a9a923dacfa6c2cb03d101b92c2b2683ed5e248ffa8fb414edbb6b9670 (hexadecimal)
• z7WxViWAEwg9G3fadmM1k9YTtMq9QLkGgGMie86JMWajZ (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EBSI type extension for use of StatusList2021",
  "description": "Defines revocation details for an issued Verifiable Credential",
  "type": "object",
  "properties": {
    "credentialStatus": {
      "description": "Contains information about how to verify the status of the Verifiable Attestation",
      "type": "object",
      "properties": {
        "id": {
          "description": "References the unique URI of the status",
          "type": "string",
          "format": "uri"
        },
        "type": {
          "description": "Defines the Verifiable Credential status type",
          "type": "string",
          "const": "StatusList2021Entry"
        },
        "statusPurpose": {
          "description": "Purpose of the status entry",
          "type": "string",
          "enum": ["revocation", "suspension"]
        },
        "statusListIndex": {
          "description": "Integer expressed as a string. The zero based index value identifies the bit position of the status",
          "type": "string"
        },
        "statusListCredential": {
          "description": "URL referencing the StatusList2021Credential containing the index",
          "type": "string",
          "format": "uri"
        }
      },
      "required": ["id", "type", "statusListIndex", "statusListCredential"]
    }
  }
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-type-extensions-credential-status-status-list-2021-schema@1.0.3

# with Yarn
yarn add @cef-ebsi/vcdm1.1-type-extensions-credential-status-status-list-2021-schema@1.0.3

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-type-extensions-credential-status-status-list-2021-schema@1.0.3

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-type-extensions-credential-status-status-list-2021-schema";

// you can now use the schema and metadata

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

import type { EBSITypeExtensionForUseOfStatusList2021 } from "@cef-ebsi/vcdm1.1-type-extensions-credential-status-status-list-2021-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.