@cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema

@cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema

Bitstring Status List v1.0 BitstringStatusListCredential schema

Schema of a BitstringStatusListCredential Verifiable Credential

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

• 0xb26f927a2ad5bf0031ef6ae4645036228e3f68d87966c424b464853b85e53947 (hexadecimal)
• zD1YFDrV5fwbMcqbLE14UFrd17rYjCfU86mwtJey1pDC2 (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Bitstring Status List v1.0 BitstringStatusListCredential schema",
  "description": "Schema of a BitstringStatusListCredential Verifiable Credential",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "type": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "prefixItems": [
            { "const": "VerifiableCredential" },
            { "const": "VerifiableAttestation" },
            { "const": "BitstringStatusListCredential" }
          ],
          "minItems": 3,
          "uniqueItems": true
        },
        "credentialSubject": {
          "description": "Defines information about the subject that is described by the Verifiable Attestation",
          "type": "object",
          "properties": {
            "id": {
              "description": "URI of the status list",
              "type": "string",
              "format": "uri"
            },
            "type": {
              "description": "Defines the type of the credential subject, which is the status list",
              "type": "string",
              "const": "BitstringStatusList"
            },
            "statusPurpose": {
              "description": "Purpose of the status entry",
              "type": "string",
              "enum": ["refresh", "revocation", "suspension", "message"]
            },
            "encodedList": {
              "description": "Multibase-encoded base64url (with no padding) representation of the GZIP-compressed bitstring values for the associated range of verifiable credential status values",
              "type": "string"
            },
            "ttl": {
              "description": "Indicates the time to live in milliseconds before a refresh SHOULD be attempted",
              "type": "number"
            }
          },
          "required": ["id", "type", "statusPurpose", "encodedList"]
        }
      },
      "required": ["type", "credentialSubject"]
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema@1.0.0-next.0

# with Yarn
yarn add @cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema@1.0.0-next.0

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema@1.0.0-next.0

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema";

// you can now use the schema and metadata

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

import type { BitstringStatusListV10BitstringStatusListCredentialSchema } from "@cef-ebsi/vcdm1.1-bitstring-status-list-v1.0-credential-schema";

License

Copyright (C) 2024 European Union

This program is free software: you can redistribute it and/or modify it under the terms of the EUROPEAN UNION PUBLIC LICENCE v. 1.2 as published by the European Union.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EUROPEAN UNION PUBLIC LICENCE v. 1.2 for further details.

You should have received a copy of the EUROPEAN UNION PUBLIC LICENCE v. 1.2. along with this program. If not, see https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12.