@cef-ebsi/vcdm2.0-multi-uni-pilot-work-certificate-schema

Verifiable Work Certificate

Schema of Work Certificate for a natural persons.

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

• 0x4fc40c22e5a3db9849d4412fb737141c2c37e38ecde23d9984c7989f332dac79 (hexadecimal)
• z6NNbRM5SoGa4cbULzaXqCKYWUWoKmkYsmVcrBD8zqvjJ (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Verifiable Work Certificate",
  "description": "Schema of Work Certificate for a natural persons.",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm2.0-attestation-schema/schema.json"
    },
    {
      "properties": {
        "credentialSubject": {
          "description": "Defines additional information about the subject that is described by the Verifiable Certificate of Work",
          "type": "object",
          "properties": {
            "id": {
              "description": "Defines the DID of the subject that is described by the Verifiable Attestation",
              "type": "string",
              "format": "uri"
            },
            "familyName": {
              "description": "Defines current family name(s) of the credential subject",
              "type": "string"
            },
            "firstName": {
              "description": "Defines current first name(s) of the credential subject",
              "type": "string"
            },
            "startDate": {
              "description": "Defines date of entry in company of the credential subject",
              "type": "string",
              "format": "date-time"
            },
            "endDate": {
              "description": "Defines date of leaving the company of the credential subject",
              "type": "string",
              "format": "date-time"
            },
            "listOfOccupations": {
              "description": "Defines the list of occupations held in the company of the credential subject",
              "type": "array",
              "items": {
                "type": "object",
                "required": ["occupationalCategory", "startDate"],
                "properties": {
                  "occupationalCategory": {
                    "description": "Defines the function held in the company of the credential subject. Recommendation: see Occupational Category: https://schema.org/occupationalCategory",
                    "type": "string"
                  },
                  "startDate": {
                    "description": "Defines start date of employment held in company of the credential subject",
                    "type": "string",
                    "format": "date-time"
                  },
                  "endDate": {
                    "description": "Defines end date of employment held in company of the credential subject",
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            },
            "socialBenefits": {
              "description": "Defines the prorogued benefits of the credential subject",
              "type": "string"
            }
          },
          "required": [
            "id",
            "familyName",
            "firstName",
            "startDate",
            "listOfOccupations"
          ]
        }
      }
    }
  ]
}

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/vcdm2.0-multi-uni-pilot-work-certificate-schema";

// you can now use the schema and metadata

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

import type { VerifiableWorkCertificate } from "@cef-ebsi/vcdm2.0-multi-uni-pilot-work-certificate-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.