@cef-ebsi/vcdm2.0-vid-legal-entity-schema

EBSI Legal Entity Verifiable ID

Schema of an EBSI Verifiable ID for a legal entity

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

• 0x69b4db34bfd77058e719c9f5f559d12bc6577152c4572da4ffc7a9f190955adc (hexadecimal)
• z87dkzVddhQ16vN2pKaWhJDnVWAJ8F9w5G2F1H9RtvBm5 (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 a legal entity",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm2.0-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 the DID of the subject that is described by the Verifiable Attestation",
              "type": "string",
              "format": "uri"
            },
            "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 (website)  of Credential Subject",
              "oneOf": [
                {
                  "type": "string",
                  "format": "uri"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              ]
            }
          },
          "required": ["id", "legalName", "domainName"]
        }
      }
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/vcdm2.0-vid-legal-entity-schema@1.2.0

# with Yarn
yarn add @cef-ebsi/vcdm2.0-vid-legal-entity-schema@1.2.0

# with pnpm
pnpm add @cef-ebsi/vcdm2.0-vid-legal-entity-schema@1.2.0

Usage

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

import { schema, metadata } from "@cef-ebsi/vcdm2.0-vid-legal-entity-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/vcdm2.0-vid-legal-entity-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.