@cef-ebsi/vcdm1.1-dc4eu-professional-id v1.0.0

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

Professional ID

Schema for professional identity credentials

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

• 0x11bf60b7e9af1d7a4d8450c90f4babe6b4c34ec78e1d71eb69d6f82f5abede74 (hexadecimal)
• z2CHBovrL2TptHFFtszG5Jn8LZU1SxLfMY6Vg93ctKEAw (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Professional ID",
  "description": "Schema for professional 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 professional ID credential"
        },
        "type": {
          "type": "array",
          "description": "Credential type definitions",
          "items": {
            "type": "string"
          },
          "default": ["VerifiableCredential", "ProfessionalIdCredential"]
        },
        "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 professional ID was issued"
        },
        "credentialSubject": {
          "type": "object",
          "description": "Information about the registered professional",
          "properties": {
            "id": {
              "type": "string"
            },
            "givenName": {
              "description": "Current first name(s), including middle name(s) where applicable, of the professional.",
              "type": "string"
            },
            "familyName": {
              "description": "Current last name(s) or surname(s) of the professional.",
              "type": "string"
            },
            "documentNumber": {
              "description": "A number for the person identification data, assigned by the provider of person identification data.",
              "type": "string"
            },
            "personalAdministrativeNumber": {
              "description": "Identification number of the registered professional.",
              "type": "string"
            },
            "legallyEntitled": {
              "description": "Attribute identifying whether a professional is legally entitled to practice or not.",
              "type": "boolean"
            },
            "professionalSpeciality": {
              "description": "Specific area of knowledge within a profession that allows the professional to carry out specific tasks in accordance with that speciality.",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": [
            "id",
            "givenName",
            "familyName",
            "personalAdministrativeNumber"
          ]
        },
        "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/vcdm1.1-dc4eu-professional-id@1.0.0

# with Yarn
yarn add @cef-ebsi/vcdm1.1-dc4eu-professional-id@1.0.0

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-dc4eu-professional-id@1.0.0

Usage

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

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

// you can now use the schema and metadata

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

import type { ProfessionalID } from "@cef-ebsi/vcdm1.1-dc4eu-professional-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.