@cef-ebsi/vcdm1.1-type-extensions-terms-of-use-accreditation-policy-schema

EBSI Type Extension for use of AccreditationPolicy

Defines the Accreditation Policy under which the Verifiable Credential has been issued

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

• 0xbd17dfb8842618ecaed85b0b3decc48ddaa6f9594cb49b7d4c38ab67573027d6 (hexadecimal)
• zDj9AooAn2uearMS76PPjrn6M9KHssA5ShTg4eew3wxmK (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 AccreditationPolicy",
  "description": "Defines the Accreditation Policy under which the Verifiable Credential has been issued",
  "type": "object",
  "properties": {
    "termsOfUse": {
      "anyOf": [
        {
          "$ref": "#/$defs/termsOfUse"
        },
        {
          "type": "array",
          "description": "One item must match the type extension",
          "contains": {
            "$ref": "#/$defs/termsOfUse"
          }
        }
      ]
    }
  },
  "$defs": {
    "termsOfUse": {
      "description": "Defines the Accreditation Policy under which the Verifiable Credential has been issued",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the TermsOfUse entry. It MUST be AccreditationPolicy.",
          "enum": ["AccreditationPolicy"]
        },
        "trustFramework": {
          "type": "string",
          "description": "Name of the Trust Framework (TF)."
        },
        "policyId": {
          "type": "string",
          "description": "URI or URL identifying the policy under which the Trust Framework operates or Verifiable Accreditation or Attestation has been Issued.",
          "format": "uri"
        },
        "lib": {
          "type": "string",
          "description": "Legal basis for the tf, is a string as 'professional qualifications directive' or eIDAS. OPTIONAL.",
          "format": "uri"
        },
        "parentAccreditation": {
          "type": "string",
          "description": "URL to access the parent entity in the trust chain supporting the attestation. REQUIRED.",
          "format": "uri"
        },
        "rootAuthorisation": {
          "type": "string",
          "description": "URL to access the root entity in the trust chain supporting the attestation. REQUIRED.",
          "format": "uri"
        }
      },
      "required": ["type", "parentAccreditation", "rootAuthorisation"]
    }
  }
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-type-extensions-terms-of-use-accreditation-policy-schema@2.0.0

# with Yarn
yarn add @cef-ebsi/vcdm1.1-type-extensions-terms-of-use-accreditation-policy-schema@2.0.0

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-type-extensions-terms-of-use-accreditation-policy-schema@2.0.0

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-type-extensions-terms-of-use-accreditation-policy-schema";

// you can now use the schema and metadata

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

import type { EBSITypeExtensionForUseOfAccreditationPolicy } from "@cef-ebsi/vcdm1.1-type-extensions-terms-of-use-accreditation-policy-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.