@cef-ebsi/vcdm1.1-dc4eu-engineer-id

Engineer ID

Schema for engineers identity credentials

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

• 0xa16f2d5597b64daa832e13753d5b99fd7442a4b1e93eb8a1e524f8b41f426c8c (hexadecimal)
• zBsAxxzJoZcW5qegamwPYjuLEwtPbpmUdShK5dd9sRdoq (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Engineer ID",
  "description": "Schema for engineers identity credentials",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "id": {
          "type": "string",
          "format": "uri",
          "description": "Unique identifier for the engineer ID credential"
        },
        "type": {
          "type": "array",
          "description": "Credential type definitions",
          "items": {
            "type": "string"
          },
          "default": [
            "VerifiableCredential",
            "VerifiableAttestation",
            "EngineerIdCredential"
          ]
        },
        "issuer": {
          "type": "object",
          "description": "Information about the issuing institution",
          "properties": {
            "id": {
              "type": "string",
              "format": "uri",
              "description": "Unique identifier of the issuing institution"
            },
            "name": {
              "type": "object",
              "description": "Multilingual name of the issuing institution",
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "required": ["id", "name"]
        },
        "issuanceDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date when the ID was issued"
        },
        "credentialSubject": {
          "type": "object",
          "description": "Information about the engineer and their status",
          "properties": {
            "id": {
              "type": "string"
            },
            "givenName": {
              "description": "Current first name(s), including middle name(s) where applicable.",
              "type": "string"
            },
            "familyName": {
              "description": "Current last name(s) or surname(s).",
              "type": "string"
            },
            "professionalBody": {
              "description": "Corresponds to the national or regional professional body of engineers where the professional is registered.",
              "type": "string"
            },
            "personalAdministrativeNumber": {
              "description": "Identification number of the registered engineer.",
              "type": "string"
            },
            "legallyEntitled": {
              "description": "Defines whether the engineer is considered to be qualified to practise.",
              "type": "boolean"
            },
            "engineeringSpeciality": {
              "description": "List representing the engineering specialty of the professional.",
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "Aeronautical engineer",
                  "Agricultural engineer",
                  "Building engineer",
                  "Chemical engineer",
                  "Civil and environmental engineer",
                  "Civil engineer",
                  "Computer science engineer",
                  "Construction/Civil engineer: building of roads, bridges, railways",
                  "Electrical and computer engineer",
                  "Electrical engineer",
                  "Electromechanical engineer",
                  "Electronic engineer",
                  "Energy engineer",
                  "Engineer",
                  "Engineer fishing fleet",
                  "Environmental engineer",
                  "Forest engineer",
                  "Gas engineer",
                  "Geographical engineer",
                  "Geotechnical engineer",
                  "Industrial engineer",
                  "Information systems engineer",
                  "Marine engineer",
                  "Mechanical engineer",
                  "Mining engineer",
                  "Telecommunications engineer"
                ]
              }
            }
          },
          "required": [
            "id",
            "givenName",
            "familyName",
            "personalAdministrativeNumber",
            "engineeringSpeciality"
          ]
        },
        "proof": {
          "type": "object",
          "description": "Cryptographic proof of the credential",
          "properties": {
            "type": {
              "type": "string",
              "description": "Type of proof"
            },
            "created": {
              "type": "string",
              "format": "date-time",
              "description": "Date and time when the proof was created"
            },
            "proofPurpose": {
              "type": "string",
              "description": "Purpose of the proof"
            },
            "verificationMethod": {
              "type": "string",
              "format": "uri",
              "description": "Method used to verify the proof"
            },
            "proofValue": {
              "type": "string",
              "description": "Value of the proof"
            }
          },
          "required": [
            "type",
            "created",
            "proofPurpose",
            "verificationMethod",
            "proofValue"
          ]
        }
      },
      "required": [
        "@context",
        "id",
        "type",
        "issuer",
        "issuanceDate",
        "expirationDate",
        "credentialSubject",
        "proof"
      ]
    }
  ]
}

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-dc4eu-engineer-id";

// you can now use the schema and metadata

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

import type { EngineerID } from "@cef-ebsi/vcdm1.1-dc4eu-engineer-id";

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.