@cef-ebsi/vcdm1.1-verifiable-education-id-schema

Verifiable Educational ID

Schema of a Verifiable Educational ID for a natural person participating in the educational use cases

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

• 0xcc7df4ad0edfe9024f79f1d3fa70c8666a849e7d29b7fa6b3fce5ada0617f824 (hexadecimal)
• zEmFZquJtANNz7XNE46thRi1E2cAfpQiXVLSBdDgLyfGP (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Verifiable Educational ID",
  "description": "Schema of a Verifiable Educational ID for a natural person participating in the educational use cases",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "credentialSubject": {
          "description": "Defines additional properties on credentialSubject to describe IDs that do not have a substantial level of assurance.",
          "type": "object",
          "properties": {
            "id": {
              "description": "Defines a unique identifier of the credential subject. DID:Key value, generated by the user wallet and associated to the credential holder. Refer specification available at https://api-pilot.ebsi.eu/docs/specs/did-methods/did-method-for-natural-person ",
              "type": "string"
            },
            "identifier": {
              "description": "Defines an alternative identifier for the credential subject and has as value the value of eduPersonPrincipalName attribute of the credential subject within the Home Organization (needs to be globally unique and persistent).",
              "type": "string"
            },
            "schacPersonalUniqueCode": {
              "description": " schacPersonalUniqueCode can have different forms urn:schac:personalUniqueCode:int:esi:<sHO>:<code> (where <sHO> is the Higher Education Institution's schacHomeOrganization) and urn:schac:personalUniqueCode:int:esi:<country-code>:<code> (<code> is a string that uniquely identifies the person).",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "schacPersonalUniqueID": {
              "description": "value is different in different countries, mostly urn:schac:personalUniqueID:<country-code>:<code>.",
              "type": "string"
            },
            "schacHomeOrganization": {
              "description": "Specifies the home organization of the credential subject",
              "type": "string"
            },
            "familyName": {
              "description": "Defines current family name(s) of the credential subject which corresponds to the eduGAIN attribute sn",
              "type": "string"
            },
            "firstName": {
              "description": "Defines current first name(s) of the credential subject which corresponds to the eduGAIN attribute givenName",
              "type": "string"
            },
            "displayName": {
              "description": "The name(s) that should appear in white-pages-like applications",
              "type": "string"
            },
            "dateOfBirth": {
              "description": "Defines date of birth of the credential subject (format: yyyyMMdd)",
              "type": "string",
              "format": "date"
            },
            "commonName": {
              "description": "Defines the first and the family name(s) of the credential subject at the time of their birth",
              "type": "string"
            },
            "mail": {
              "description": "(primary) e-mail address of the credential subject as registered by the educational institution issuing the Verifiable Educational ID",
              "type": "string"
            },
            "eduPersonPrincipalName": {
              "description": "Unique, persistent identifier of the credential subject",
              "type": "string"
            },
            "eduPersonPrimaryAffiliation": {
              "description": "Primary Affiliation within Home Organization ",
              "type": "string"
            },
            "eduPersonAffiliation": {
              "description": "Affiliation within Home Organization. It can contain multiple values such as member, student, employee, faculty, staff, affiliate, alumni, etc.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "eduPersonScopedAffiliation": {
              "description": "The person's affiliations within Home Organization scoped with the Home Organization",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "eduPersonAssurance": {
              "description": "represents identity assurance profiles (IAPs) https://wiki.refeds.org/display/ASS/REFEDS+Assurance+Framework+ver+1.0",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "image": {
              "$ref": "#/$defs/MediaObjectType"
            }
          },
          "required": ["id", "identifier", "eduPersonScopedAffiliation"]
        }
      }
    }
  ],
  "$defs": {
    "URIType": {
      "type": "string",
      "format": "uri"
    },
    "StringType": {
      "type": "string"
    },
    "LiteralType": {
      "$ref": "#/$defs/StringType"
    },
    "IntegerType": {
      "type": "integer"
    },
    "GenericIdType": {
      "allOf": [
        {
          "$ref": "#/$defs/URIType"
        },
        {
          "if": {
            "type": "string",
            "pattern": "^(http|urn)"
          },
          "then": {
            "type": "string",
            "pattern": "^(http://data.europa.eu/snb/|http://publications.europa.eu/resource/authority/|urn:epass:.+:[0-9]+$|urn:epass:concept(Scheme)?:[0-9A-Za-z\\-]*$)"
          }
        }
      ]
    },
    "Many!LangStringType": {
      "type": "object",
      "propertyNames": {
        "pattern": "^(aa|ab|ae|af|ak|am|an|ar|as|av|ay|az|ba|be|bg|bh|bi|bm|bn|bo|br|bs|ca|ce|ch|co|cr|cs|cu|cv|cy|da|de|dv|dz|ee|el|en|eo|es|et|eu|fa|ff|fi|fj|fo|fr|fy|ga|gd|gl|gn|gu|gv|ha|he|hi|ho|hr|ht|hu|hy|hz|ia|id|ie|ig|ii|ik|in|io|is|it|iu|iw|ja|ji|jv|jw|ka|kg|ki|kj|kk|kl|km|kn|ko|kr|ks|ku|kv|kw|ky|la|lb|lg|li|ln|lo|lt|lu|lv|mg|mh|mi|mk|ml|mn|mo|mr|ms|mt|my|na|nb|nd|ne|ng|nl|nn|no|nr|nv|ny|oc|oj|om|or|os|pa|pi|pl|ps|pt|qu|rm|rn|ro|ru|rw|sa|sc|sd|se|sg|sh|si|sk|sl|sm|sn|so|sq|sr|ss|st|su|sv|sw|ta|te|tg|th|ti|tk|tl|tn|to|tr|ts|tt|tw|ty|ug|uk|ur|uz|ve|vi|vo|wa|wo|xh|yi|yo|za|zh|zu)$"
      },
      "minProperties": 1
    },
    "ConceptSchemeType": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/$defs/GenericIdType"
        },
        "type": {
          "const": "ConceptScheme"
        }
      },
      "required": []
    },
    "ConceptType": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/$defs/GenericIdType"
        },
        "type": {
          "const": "Concept"
        },
        "prefLabel": {
          "$ref": "#/$defs/Many!LangStringType"
        },
        "notation": {
          "$ref": "#/$defs/LiteralType"
        },
        "inScheme": {
          "$ref": "#/$defs/ConceptSchemeType"
        },
        "definition": {
          "$ref": "#/$defs/Many!LangStringType"
        }
      },
      "required": []
    },
    "MediaObjectType": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/$defs/GenericIdType"
        },
        "type": {
          "const": "MediaObject"
        },
        "title": {
          "$ref": "#/$defs/Many!LangStringType"
        },
        "description": {
          "$ref": "#/$defs/Many!LangStringType"
        },
        "contentType": {
          "$ref": "#/$defs/ConceptType"
        },
        "attachmentType": {
          "$ref": "#/$defs/ConceptType"
        },
        "contentEncoding": {
          "$ref": "#/$defs/ConceptType"
        },
        "contentSize": {
          "$ref": "#/$defs/IntegerType"
        },
        "content": {
          "$ref": "#/$defs/StringType"
        },
        "contentURL": {
          "$ref": "#/$defs/URIType"
        }
      },
      "required": ["contentType", "contentEncoding", "content"]
    }
  }
}

Installation

# with npm
npm add @cef-ebsi/[email protected]

# with Yarn
yarn add @cef-ebsi/[email protected]

# with pnpm
pnpm add @cef-ebsi/[email protected]

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-verifiable-education-id-schema";

// you can now use the schema and metadata

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

import type { VerifiableEducationalID } from "@cef-ebsi/vcdm1.1-verifiable-education-id-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.