@cef-ebsi/vcdm1.1-multi-uni-pilot-education-verifiable-accreditation-records-schema

EBSI Education Verifiable Accreditation records

EBSI Education Verifiable Accreditation record schema for educational contexts

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

• 0x4f9dc4947a020fccbdf435f53d5d7915d7706e0d8f910f73e6ff765202dd0467 (hexadecimal)
• z6MnjrUbQrbadBDTJz2kzn3NMyxQxrkzFL4mQBSmPEbBt (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EBSI Education Verifiable Accreditation records",
  "description": "EBSI Education Verifiable Accreditation record schema for educational contexts",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "credentialSubject": {
          "type": "object",
          "properties": {
            "id": {
              "description": "Defines a unique identifier of the Verifiable attestation",
              "type": "string"
            },
            "authorizationClaims": {
              "description": "Defines a list of claims that define/determine the authorization of an Issuer to issue certain types of VCs. Mandatory",
              "type": "object",
              "properties": {
                "accreditationType": {
                  "description": "Defines the type of accreditation. Mandatory*",
                  "type": "string",
                  "format": "uri"
                },
                "decision": {
                  "description": "Defines the Quality Decision issued by the Quality Assuring Authority",
                  "type": "string"
                },
                "report": {
                  "description": "Includes a publicly accessible report of the quality assurance decision",
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "limitQualification": {
                  "description": " Defines The qualification that was accredited ",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "description": "Defines a portable and unique identifier of the qualification",
                        "type": "string",
                        "format": "uri"
                      },
                      "title": {
                        "description": "Defines the title of the qualification",
                        "type": "string"
                      },
                      "alternativeLabel": {
                        "description": "Defines an alternative name of the qualification",
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "EQFLevel": {
                        "description": "Defines the qualification level as specified by the European Qualification Framework.",
                        "type": "string",
                        "format": "uri"
                      },
                      "NQFLevel": {
                        "description": "Defines the qualification level as specified by a National Qualification Framework.",
                        "type": "string",
                        "format": "uri"
                      }
                    }
                  }
                },
                "limitField": {
                  "description": "Defines The field of education for which the accreditation is valid",
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "limitQFLevel": {
                  "description": "Defines the european qualification level for which the accreditation is valid",
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "limitJurisdiction": {
                  "description": "Defines the jurisdiction for which the accreditation is valid",
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                },
                "reviewDate": {
                  "description": "Defines the The date when the accreditation has to be re-viewed",
                  "type": "string",
                  "format": "date-time"
                }
              },
              "required": ["accreditationType", "limitJurisdiction"]
            }
          },
          "required": ["id", "authorizationClaims"]
        }
      }
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-multi-uni-pilot-education-verifiable-accreditation-records-schema@1.3.0

# with Yarn
yarn add @cef-ebsi/vcdm1.1-multi-uni-pilot-education-verifiable-accreditation-records-schema@1.3.0

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-multi-uni-pilot-education-verifiable-accreditation-records-schema@1.3.0

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-multi-uni-pilot-education-verifiable-accreditation-records-schema";

// you can now use the schema and metadata

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

import type { EBSIEducationVerifiableAccreditationRecords } from "@cef-ebsi/vcdm1.1-multi-uni-pilot-education-verifiable-accreditation-records-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.