1.0.0 • Published 10 months ago

@cef-ebsi/vcdm1.1-idunion-poa-schema v1.0.0

Weekly downloads
-
License
EUPL-1.2
Repository
-
Last release
10 months ago

EBSI Logo

@cef-ebsi/vcdm1.1-idunion-poa-schema

Power-of-Attorney

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

  • 0x1bd1afd9a838d8c3f1679fca6478f8e05f6e0380ef29ca84c671df72142637a2 (hexadecimal)
  • z2sbTT23X2zfsdMCPFMC7GiUwyHE91Lg9BpeEA5uqtT9s (multibase base58btc)

Table of Contents

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Power-of-Attorney",
  "description": "",
  "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 Power-of-Attorney",
          "type": "object",
          "properties": {
            "id": {
              "description": "Defines a unique identifier of the natural person for which the Power of Attorney is issued (e.g. DID-subject)",
              "type": "string"
            },
            "poaScope": {
              "description": "Attribute that describes the range of the PoA (if unlimited. Full_PoA = True; if limited. PoA = false)",
              "type": "boolean"
            },
            "poaType": {
              "description": "A positive list of human readable areas for which the PoA is valid",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "familyName": {
              "description": "Defines current family name(s) of the natural person",
              "type": "string"
            },
            "firstName": {
              "description": "Defines current first name(s) of the natural person",
              "type": "string"
            },
            "dateOfBirth": {
              "description": "Defines date of birth of the natural person",
              "type": "string",
              "format": "date"
            },
            "placeOfBirth": {
              "description": "The city where the natural person was born",
              "type": "string"
            }
          },
          "required": [
            "id",
            "poaScope",
            "familyName",
            "firstName",
            "dateOfBirth",
            "placeOfBirth"
          ]
        }
      }
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-idunion-poa-schema@1.0.0

# with Yarn
yarn add @cef-ebsi/vcdm1.1-idunion-poa-schema@1.0.0

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-idunion-poa-schema@1.0.0

Usage

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

import { schema, metadata } from "@cef-ebsi/vcdm1.1-idunion-poa-schema";

// you can now use the schema and metadata

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

import type { PowerOfAttorney } from "@cef-ebsi/vcdm1.1-idunion-poa-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:

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.

1.0.0

10 months ago