@cef-ebsi/vcdm1.1-multi-uni-pilot-verifiable-attestation-organisational-id-schema

EBSI Legal Entity Verifiable ID

Schema of an EBSI Verifiable ID for an organization-legal entity participating in the educational use cases

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

• 0x4016f7a8d08d4412b247d7825dcf7fc2c3c7f3463adb79a9ffc70f6c8f8c2bf0 (hexadecimal)
• z5KBQVxQHKeaqngYj9aEWGbgKpPT4gTSznUwCRym1GG9m (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EBSI Legal Entity Verifiable ID",
  "description": "Schema of an EBSI Verifiable ID for an organization-legal entity participating in the educational use cases",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "credentialSubject": {
          "description": "Defines information about the subject that is described by the Verifiable ID",
          "type": "object",
          "properties": {
            "id": {
              "description": "Defines a unique identifier of the credential subject",
              "type": "string"
            },
            "identifier": {
              "description": "Defines an alternative identifier for the organization",
              "type": "array",
              "items": {
                "$ref": "#/$defs/identifier"
              }
            },
            "legalPersonIdentifier": {
              "description": "National/Legal Identifier of Credential Subject (constructed by the sending Member State in accordance with the technical specifications for the purposes of cross-border identification and which is as persistent as possible in time)",
              "type": "string"
            },
            "legalName": {
              "description": "Official legal name of Credential Subject",
              "type": "string"
            },
            "legalAddress": {
              "description": "Official legal address of Credential Subject",
              "type": "string"
            },
            "VATRegistration": {
              "description": "VAT number  of Credential Subject",
              "type": "string"
            },
            "taxReference": {
              "description": "Official tax reference number of Credential Subject",
              "type": "string"
            },
            "LEI": {
              "description": "Official legal entity identifier (LEI) of Credential Subject (referred to in Commission Implementing Regulation (EU) No 1247/2012)",
              "type": "string"
            },
            "EORI": {
              "description": "Economic Operator Registration and Identification (EORI) of Credential Subject (referred to in Commission Implementing Regulation (EU) No 1352/2013)",
              "type": "string"
            },
            "SEED": {
              "description": "System for Exchange of Excise Data (SEED) of Credential Subject (i.e. excise number provided in Article 2(12) of Council Regulation (EC) No 389/2012)",
              "type": "string"
            },
            "SIC": {
              "description": "Standard Industrial Classification (SIC) of Credential Subject (Article 3(1) of Directive 2009/101/EC of the European Parliament and of the Council.)",
              "type": "string"
            },
            "domainName": {
              "description": "Domain name  of Credential Subject",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "required": ["id"]
        }
      }
    }
  ],
  "$defs": {
    "identifier": {
      "description": "Defines an alternative Identifier object",
      "type": "object",
      "properties": {
        "schemeID": {
          "description": "Defines the schema used to define alternative identification",
          "type": "string"
        },
        "value": {
          "description": "Define the alternative identification value",
          "type": "string"
        },
        "id": {
          "description": "The URI of the identifier",
          "type": "string",
          "format": "uri"
        }
      },
      "required": ["schemeID", "value"]
    }
  }
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-multi-uni-pilot-verifiable-attestation-organisational-id-schema@1.3.1

# with Yarn
yarn add @cef-ebsi/vcdm1.1-multi-uni-pilot-verifiable-attestation-organisational-id-schema@1.3.1

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-multi-uni-pilot-verifiable-attestation-organisational-id-schema@1.3.1

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-multi-uni-pilot-verifiable-attestation-organisational-id-schema";

// you can now use the schema and metadata

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

import type { EBSILegalEntityVerifiableID } from "@cef-ebsi/vcdm1.1-multi-uni-pilot-verifiable-attestation-organisational-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.