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

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:

• 0xeae40291dc6c7dbf1a54cfd9270650997e33fc9fcb3e637f390c0b6916102bc1 (hexadecimal)
• zGov4ANWQ6CGwDt4P3k78uymkCM2y2tbapd7Jk3DPTeRn (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "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@1.0.2

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

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

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