@windingtree/org.id-resolver 3.0.0-beta.7 → 3.0.0

package/dist/responseSchema.json

@@ -0,0 +1,1126 @@
+{
+  "$id": "responseSchema.json",
+  "title": "ORGiD DID Resolution Response",
+  "allOf": [
+    {
+      "$ref": "#/definitions/DidResponse"
+    }
+  ],
+  "definitions": {
+    "DidResponse": {
+      "type": "object",
+      "properties": {
+        "@context": {
+          "$ref": "#/definitions/ContextReference"
+        },
+        "did": {
+          "$ref": "#/definitions/DIDReference"
+        },
+        "didDocument": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/definitions/OrgJsonReference"
+            }
+          ]
+        },
+        "didResolutionMetadata": {
+          "$ref": "#/definitions/DIDResolutionMetadata"
+        },
+        "didDocumentMetadata": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/definitions/DIDDocumentMetadata"
+            }
+          ]
+        }
+      },
+      "required": [
+        "@context",
+        "did",
+        "didDocument",
+        "didResolutionMetadata",
+        "didDocumentMetadata"
+      ]
+    },
+    "DIDResolutionMetadata": {
+      "type": "object",
+      "properties": {
+        "contentType": {
+          "type": "string",
+          "enum": [
+            "application/did+ld+json"
+          ]
+        },
+        "retrieved": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "duration": {
+          "type": "number"
+        },
+        "resolverVersion": {
+          "type": "string"
+        },
+        "error": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "contentType",
+        "retrieved",
+        "duration",
+        "resolverVersion"
+      ]
+    },
+    "DIDDocumentMetadata": {
+      "type": "object",
+      "properties": {
+        "created": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updated": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "deactivated": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "data": {
+          "$ref": "#/definitions/OrgIdData"
+        }
+      }
+    },
+    "OrgIdData": {
+      "type": "object",
+      "properties": {
+        "tokenId": {
+          "type": "string"
+        },
+        "orgId": {
+          "type": "string"
+        },
+        "owner": {
+          "type": "string"
+        },
+        "orgJsonUri": {
+          "type": "string"
+        },
+        "delegates": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "created": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "tokenId",
+        "orgId",
+        "owner",
+        "orgJsonUri",
+        "delegates",
+        "created"
+      ]
+    },
+    "OrgJsonReference": {
+      "description": "ORG.JSON represents an organization or one of its structural units (departments, stores, etc.). In W3C terminology it is called DID Document.",
+      "type": "object",
+      "required": [
+        "@context",
+        "id",
+        "created"
+      ],
+      "properties": {
+        "schemaVersion": {
+          "description": "Semantic version of the org.json schema. If not defined it means the latest version",
+          "type": "string",
+          "pattern": "^([0-9]+.)?([0-9]+.)?([0-9]+)$",
+          "example": "0.3.2"
+        },
+        "@context": {
+          "$ref": "#/definitions/ContextReference"
+        },
+        "id": {
+          "$ref": "#/definitions/DIDReference"
+        },
+        "created": {
+          "description": "Date-time when the data was created.",
+          "type": "string",
+          "format": "date-time"
+        },
+        "updated": {
+          "description": "Date-time when the data was last changed.",
+          "type": "string",
+          "format": "date-time"
+        },
+        "deactivated": {
+          "description": "Date-time when the ORGiD was deactivated",
+          "type": "string",
+          "format": "date-time"
+        },
+        "verificationMethod": {
+          "description": "Public keys are used for digital signatures, encryption and other cryptographic operations, which in turn are the basis for purposes such as authentication or establishing secure communication with service endpoints.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/VerificationMethodReference"
+          }
+        },
+        "service": {
+          "description": "One of the primary purposes of ORG.JSON is to enable discovery of service endpoints (aka API URIs).",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ServiceReference"
+          }
+        },
+        "payment": {
+          "description": "Public information about payment accounts of the organization.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PaymentReference"
+          }
+        },
+        "trustAssertions": {
+          "$ref": "#/definitions/TrustAssertionsReference"
+        },
+        "credentials": {
+          "$ref": "#/definitions/CredentialsReference"
+        },
+        "capabilityDelegation": {
+          "$ref": "#/definitions/CapabilityDelegationReference"
+        },
+        "legalEntity": {
+          "$ref": "#/definitions/LegalEntityReference"
+        },
+        "organizationalUnit": {
+          "$ref": "#/definitions/OrganizationalUnitReference"
+        },
+        "person": {
+          "$ref": "#/definitions/ContactReference"
+        }
+      }
+    },
+    "LegalEntityReference": {
+      "description": "Legal entity information",
+      "type": "object",
+      "required": [
+        "legalName",
+        "registryCode",
+        "legalType",
+        "registeredAddress",
+        "media"
+      ],
+      "properties": {
+        "legalName": {
+          "description": "Legal name, e.g. 'Acme, Inc.' or 'Ajax Ltd.'",
+          "type": "string"
+        },
+        "alternativeName": {
+          "description": "A recognized name other than the legal name. Some jurisdictions recognize concepts such as a trading name or alternative forms of a legal entity's name. The Alternative Name property can be used to record such names but should not be used to record translations of the primary legal name. Where more than one legal name exists and where they have equal standing but are expressed in different languages, identify the language used in each of the multiple legal names. It is notable that some jurisdictions regard the use of any name other than the primary Legal Name as suspicious.",
+          "type": "string"
+        },
+        "registryCode": {
+          "description": "Identifier given to the legal entity by the authority with which it is registered.",
+          "type": "string"
+        },
+        "identifiers": {
+          "description": "A formally-issued identifier for the legal entity, other than the one that confers legal status upon it. Legal entities may have any number of identifiers (but only one legal identifier). For example, in many jurisdictions, a business will have one or more tax numbers associated with them which do not, by themselves, confer legal entity status. The Identifier property must not be used to link to the identifier issued by the authority that conferred legal entity status on a business.",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/IdentifierReference"
+              }
+            ]
+          }
+        },
+        "legalType": {
+          "description": "Legal entity type: limited company, corporation, NGO, etc.",
+          "type": "string"
+        },
+        "registeredAddress": {
+          "$ref": "#/definitions/AddressReference"
+        },
+        "locations": {
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/LocationReference"
+              }
+            ]
+          }
+        },
+        "contacts": {
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/ContactReference"
+              }
+            ]
+          }
+        },
+        "media": {
+          "$ref": "#/definitions/MediaListReference"
+        },
+        "organizationalUnits": {
+          "description": "A list of organizational units of the legal entity",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/DIDReference"
+              }
+            ]
+          }
+        }
+      }
+    },
+    "OrganizationalUnitReference": {
+      "description": "Organizational unit",
+      "type": "object",
+      "required": [
+        "name",
+        "media"
+      ],
+      "properties": {
+        "name": {
+          "description": "Unit name e.g. \"Grand Budapest Hotel\", \"Accounting Department\" or \"Acme 13th Ave\"",
+          "type": "string"
+        },
+        "type": {
+          "description": "Unit type, e.g. [\"hotel\", \"boutique\"]",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "type": "string"
+              }
+            ]
+          }
+        },
+        "description": {
+          "description": "Short description of the unit",
+          "type": "string"
+        },
+        "longDescription": {
+          "description": "Long description of the unit",
+          "type": "string"
+        },
+        "address": {
+          "$ref": "#/definitions/AddressReference"
+        },
+        "openingHours": {
+          "$ref": "#/definitions/OpeningHoursReference"
+        },
+        "contacts": {
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/ContactReference"
+              }
+            ]
+          }
+        },
+        "media": {
+          "$ref": "#/definitions/MediaListReference"
+        },
+        "parentOrganization": {
+          "description": "A link to the legal entity",
+          "$ref": "#/definitions/DIDReference"
+        }
+      }
+    },
+    "ContextReference": {
+      "description": "When two software systems need to exchange data, they need to use terminology and a protocol that both systems understand. The @context property ensures that two systems operating on the same DID document are using mutually agreed terminology.",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/LinkedContextReference"
+        },
+        {
+          "$ref": "#/definitions/LinkedMultipleContextReference"
+        },
+        {
+          "$ref": "#/definitions/LinkedContextDocumentReference"
+        }
+      ]
+    },
+    "LinkedContextReference": {
+      "description": "Linked context URI",
+      "type": "string",
+      "example": "https://www.w3.org/ns/did/v1"
+    },
+    "LinkedMultipleContextReference": {
+      "description": "A list of context references",
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "$ref": "#/definitions/LinkedContextReference"
+          }
+        ]
+      },
+      "example": "[\n  \"https://www.w3.org/ns/did/v1\",\n  \"https://windingtree.com/ns/orgid/v1\"\n]"
+    },
+    "LinkedContextDocumentReference": {
+      "description": "Context document https://www.w3.org/TR/json-ld/#the-context",
+      "type": "object",
+      "example": "{\n  \"@context\": \"https://json-ld.org/contexts/person.jsonld\",\n  \"name\": \"Example Site\",\n  \"homepage\": \"http://example.site.org/\",\n  \"image\": \"http://example.site.org/images/person.png\"\n}"
+    },
+    "DIDReference": {
+      "description": "The DID subject is denoted by the id property. The DID subject is the entity that the DID document (ORG.JSON) is about. That is, it is the entity identified by the DID and described in the DID document.",
+      "type": "string",
+      "pattern": "^did:orgid:([0-9])*(?::)?(0x[a-fA-F0-9]{64})+(?:[?])?([0-9a-zA-Z_=&%-]+)?(?:#)?([[0-9a-zA-Z-]+)?$",
+      "example": "did:orgid:4:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75"
+    },
+    "TrustAssertionsReference": {
+      "description": "List of trust assertions (claims with proofs)",
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "$ref": "#/definitions/CredentialReference"
+          }
+        ]
+      }
+    },
+    "CredentialsReference": {
+      "description": "List of credentials (provided and signed by third parties)",
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "$ref": "#/definitions/CredentialReference"
+          }
+        ]
+      }
+    },
+    "AssertionReference": {
+      "description": "Trust assertion",
+      "type": "object",
+      "required": [
+        "claim",
+        "type",
+        "proof"
+      ],
+      "properties": {
+        "claim": {
+          "description": "Claim subject. E.g. domain name or social account",
+          "type": "string"
+        },
+        "type": {
+          "description": "Proof type: (domain|dns|social)",
+          "type": "string",
+          "enum": [
+            "domain",
+            "dns",
+            "social"
+          ]
+        },
+        "proof": {
+          "description": "Proof of the claim: dns record, text file URI, or link to a post on facebook, linkedin, etc.",
+          "type": "string"
+        }
+      }
+    },
+    "VerificationMethodReference": {
+      "description": "Public keys are used for digital signatures, encryption and other cryptographic operations, which in turn are the basis for purposes such as authentication or establishing secure communication with service endpoints.",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "controller"
+      ],
+      "properties": {
+        "id": {
+          "description": "Identifies the owner of the corresponding private key",
+          "$ref": "#/definitions/DIDReference"
+        },
+        "type": {
+          "description": "The cryptographic suite that was used to generate a public key",
+          "$ref": "#/definitions/CryptographicSuiteReference"
+        },
+        "controller": {
+          "description": "Identifies the controller of the corresponding private key",
+          "$ref": "#/definitions/DIDReference"
+        },
+        "blockchainAccountId": {
+          "description": "Public key (account address) of the blockchain account",
+          "$ref": "#/definitions/BlockchainAccountId"
+        },
+        "publicKeyPem": {
+          "description": "A public key PEM property is used to specify the PEM-encoded version of the public key",
+          "type": "string",
+          "example": "-----BEGIN PUBLIC KEY-----\\nMII8YbF3s8q3c...j8Fk88FsRa3K\\n-----END PUBLIC KEY-----\\n"
+        },
+        "publicKeyJwk": {
+          "description": "Public key in JWT format (recommended key format)",
+          "$ref": "#/definitions/PublicKeyJwkReference"
+        },
+        "publicKeyBase58": {
+          "description": "Public key in value in Base58 Bitcoin format",
+          "type": "string"
+        },
+        "note": {
+          "description": "Note about the private key purpose",
+          "type": "string"
+        },
+        "verificationMethodRevocation": {
+          "description": "Verification method revocation status",
+          "$ref": "#/definitions/VerificationMethodRevocationReference"
+        }
+      },
+      "example": "{\n  \"id\": \"did:orgid:1:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75#key1\",\n  \"type\": \"EcdsaSecp256k1VerificationKey2019\",\n  \"controller\": \"did:orgid:1:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75\",\n  \"publicKeyPem\": \"MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE/7GpAW4+se9gZOFPtwk63ZhV1nX6M0UobMYO6FMAnON6vCbglyOaRzEltugkp6GrM8LZ6is0rMBMAXCvb9FH2g==\",\n  \"note\": \"B2C Webserver Key\"\n}"
+    },
+    "VerificationMethodRevocationReference": {
+      "type": "object",
+      "properties": {
+        "reason": {
+          "description": "Revocation reason according to https://datatracker.ietf.org/doc/html/rfc5280#section-5.3.1",
+          "type": "string",
+          "enum": [
+            "unspecified",
+            "keyCompromise",
+            "affiliationChanged",
+            "superseded",
+            "cessationOfOperation",
+            "certificateHold",
+            "privilegeWithdrawn"
+          ]
+        },
+        "invalidityDate": {
+          "description": "Date of the public key invalidation",
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
+    "PublicKeyJwkReference": {
+      "type": "object",
+      "example": "{\n  \"crv\": \"Ed25519\",\n  \"x\": \"VCpo2LMLhn6iWku8MKvSLg2ZAoC-nlOyPVQaO3FxVeQ\",\n  \"kty\": \"OKP\",\n  \"kid\": \"_Qq0UL2Fq651Q0Fjd6TvnYE-faHiOpRlPVQcY_-tA4A\"\n}"
+    },
+    "ServiceReference": {
+      "description": "One of the primary purposes of ORG.JSON is to enable discovery of service endpoints (aka API URIs).",
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "serviceEndpoint"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/DIDReference"
+        },
+        "type": {
+          "description": "Service endpoint type, e.g. \"Google Maps\" or \"NDC\"",
+          "type": "string"
+        },
+        "serviceEndpoint": {
+          "allOf": [
+            {
+              "description": "JSON-LD object or a valid URI conforming to [RFC3986] and normalized according to the rules in section 6 of [RFC3986] and to any normalization rules in its applicable URI scheme specification."
+            },
+            {
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/LinkedEndpointReference"
+                },
+                {
+                  "$ref": "#/definitions/LinkedDocumentEndpointReference"
+                }
+              ]
+            }
+          ]
+        }
+      },
+      "example": "{\n  \"id\": \"did:orgid:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75#apiv1\",\n  \"serviceEndpoint\": \"https://staging.glider.travel/api/v1\",\n  \"type\": \"glider\",\n  \"description\": \"Search and Book API\",\n  \"docs\": \"https://staging.glider.travel/api/docs/\"\n}"
+    },
+    "PaymentReference": {
+      "description": "Public information about payment accounts of the organization.",
+      "type": "object",
+      "required": [
+        "type",
+        "currency"
+      ],
+      "properties": {
+        "type": {
+          "description": "The type of the payment record",
+          "type": "string",
+          "enum": [
+            "crypto",
+            "bank",
+            "simard"
+          ]
+        },
+        "currency": {
+          "description": "Currency of the account",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Currency"
+          }
+        },
+        "address": {
+          "description": "Cryptocurrency account address",
+          "allOf": [
+            {
+              "$ref": "#/definitions/BlockchainAccountId"
+            }
+          ]
+        },
+        "swift": {
+          "description": "SWIFT/BIC bank code according to ISO 9326",
+          "$ref": "#/definitions/SwiftCode"
+        },
+        "iban": {
+          "description": "International Bank Account Number (IBAN) according to ISO 13616:1997",
+          "$ref": "#/definitions/IbanCode"
+        }
+      },
+      "example": "{\n  \"type\": \"crypto\",\n  \"currency\": [\n    \"btc\"\n  ],\n  \"address\": \"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq\",\n  \"description\": \"General donation channel\"\n}"
+    },
+    "LinkedEndpointReference": {
+      "description": "Service endpoint URI conforming to [RFC3986] and normalized according to the rules in section 6 of [RFC3986] and to any normalization rules in its applicable URI scheme specification.",
+      "type": "string",
+      "example": "https://staging.glider.travel/api/v1"
+    },
+    "LinkedDocumentEndpointReference": {
+      "description": "Service endpoint document conforming to JSON-LD object https://www.w3.org/TR/json-ld/",
+      "type": "object",
+      "required": [
+        "@context"
+      ],
+      "properties": {
+        "@context": {
+          "$ref": "#/definitions/ContextReference"
+        },
+        "type": {
+          "description": "Service endpoint type",
+          "type": "string"
+        }
+      },
+      "example": "{\n  \"@context\": {\n    \"api\": \"https://own.api.service/schema.yaml#\",\n    \"orgid\": \"https://github.com/windingtree/org.json-schema/blob/master/src/orgid-json-schema.yaml#\",\n    \"type\": \"api:type\",\n    \"b2b\": \"orgid:/definitions/LinkedEndpointReference\",\n    \"admin\": \"orgid:/definitions/LinkedEndpointReference\"\n  },\n  \"type\": \"Booking Service\",\n  \"b2b\": \"https://your.api.service/api/v1\",\n  \"admin\": \"https://your.api.service/api/admin/v1\"\n}"
+    },
+    "IdentifierReference": {
+      "description": "A set of identifiers other than legal identifier",
+      "type": "object",
+      "required": [
+        "type",
+        "value"
+      ],
+      "properties": {
+        "type": {
+          "description": "Identifier type (e.g. \"IATA\", \"Trade License\")",
+          "type": "string"
+        },
+        "value": {
+          "description": "Identifier value",
+          "type": "string"
+        }
+      },
+      "example": "IATA"
+    },
+    "AddressReference": {
+      "description": "Legal entity official address, physical location of a store, etc.",
+      "type": "object",
+      "required": [
+        "country",
+        "locality",
+        "postalCode",
+        "streetAddress"
+      ],
+      "properties": {
+        "country": {
+          "description": "ISO 3166-1 alpha-2 country code",
+          "type": "string"
+        },
+        "subdivision": {
+          "description": "ISO 3166-2 country subdivision code1",
+          "type": "string"
+        },
+        "locality": {
+          "description": "City or town",
+          "type": "string"
+        },
+        "postalCode": {
+          "description": "Postal code",
+          "type": "string"
+        },
+        "streetAddress": {
+          "description": "Street address",
+          "type": "string"
+        },
+        "premise": {
+          "description": "Office, suite, apartment, etc.",
+          "type": "string"
+        },
+        "gps": {
+          "description": "GPS coordinates",
+          "type": "string"
+        },
+        "geocodes": {
+          "description": "Address geocode: Open Location Code, what3words, etc.",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/GeoCodeReference"
+              }
+            ]
+          }
+        }
+      },
+      "example": "{\n  \"country\": \"CZ\",\n  \"subdivision\": \"71\",\n  \"locality\": \"Jihlava\",\n  \"postalCode\": \"71354\",\n  \"streetAddress\": \"3150 Main St.\",\n  \"premise\": \"STE 100\",\n  \"gps\": \"50.087070,14.417210\",\n  \"geocodes\": [\n    {\n      \"type\": \"olc\",\n      \"value\": \"3CQ9+F2 Prague\"\n    },\n    {\n      \"type\": \"what3words\",\n      \"value\": \"printers.torn.images\"\n    }\n  ]\n}"
+    },
+    "GeoCodeReference": {
+      "description": "Open Location Code (Plus Code) or what3words",
+      "type": "object",
+      "required": [
+        "type",
+        "value"
+      ],
+      "properties": {
+        "type": {
+          "description": "(olc|what3words)",
+          "type": "string"
+        },
+        "value": {
+          "description": "E.g. \"G6FX+QP\" or \"///compressor.verb.patch\"",
+          "type": "string"
+        }
+      },
+      "example": "[\n  {\n    \"type\": \"olc\",\n    \"value\": \"3CQ9+F2 Prague\"\n  },\n  {\n    \"type\": \"what3words\",\n    \"value\": \"printers.torn.images\"\n  }\n]"
+    },
+    "LocationReference": {
+      "description": "Any location that business is related to the organization.",
+      "type": "object",
+      "required": [
+        "name",
+        "address",
+        "contacts"
+      ],
+      "properties": {
+        "name": {
+          "description": "Location name",
+          "type": "string"
+        },
+        "description": {
+          "description": "Location description",
+          "type": "string"
+        },
+        "address": {
+          "$ref": "#/definitions/AddressReference"
+        },
+        "openingHours": {
+          "$ref": "#/definitions/OpeningHoursReference"
+        },
+        "contacts": {
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/ContactReference"
+              }
+            ]
+          }
+        }
+      }
+    },
+    "OpeningHoursReference": {
+      "description": "Opening hours",
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "$ref": "#/definitions/OpeningHoursRangeReference"
+          }
+        ]
+      }
+    },
+    "OpeningHoursRangeReference": {
+      "description": "Opening hours range",
+      "type": "object",
+      "required": [
+        "weekDay",
+        "hours"
+      ],
+      "properties": {
+        "weekDay": {
+          "description": "Three-letter week day, e.g. mon, tue, wed...",
+          "type": "string"
+        },
+        "hours": {
+          "description": "Time range, e.g. 9:00-17:30 or 12:30-20:05",
+          "type": "string",
+          "pattern": "^[0-9]{1,2}:[0-9]{1,2}-[0-9]{1,2}:[0-9]{1,2}$"
+        }
+      },
+      "example": "{\n  \"weekDay\": \"fri\",\n  \"hours\": \"10:00-16:00\"\n}"
+    },
+    "ContactReference": {
+      "description": "Contact reference",
+      "type": "object",
+      "properties": {
+        "function": {
+          "description": "Contact function: sales, support, accounting, etc.",
+          "type": "string"
+        },
+        "name": {
+          "description": "Contact person or department name",
+          "type": "string"
+        },
+        "phone": {
+          "description": "Phone number",
+          "type": "string"
+        },
+        "email": {
+          "description": "Email",
+          "type": "string",
+          "format": "email"
+        },
+        "messengers": {
+          "description": "Messenger accounts",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/MessengerReference"
+              }
+            ]
+          }
+        },
+        "language": {
+          "$ref": "#/definitions/LanguageReference"
+        }
+      },
+      "example": "{\n  \"function\": \"Reception\",\n  \"name\": \"John Smith\",\n  \"phone\": \"+1234567890\",\n  \"email\": \"email@spam.com\",\n  \"messengers\": [\n    {\n      \"type\": \"whatsapp\",\n      \"value\": \"+1234567890\"\n    },\n    {\n      \"type\": \"kik\",\n      \"value\": \"acme.ny.reception\"\n    }\n  ]\n}"
+    },
+    "MessengerReference": {
+      "description": "Messenger account information",
+      "type": "object",
+      "required": [
+        "type",
+        "value"
+      ],
+      "properties": {
+        "type": {
+          "description": "whatsapp, telegram, viber, wechat, messenger, line, etc.",
+          "type": "string"
+        },
+        "value": {
+          "description": "Messenger account ID",
+          "type": "string"
+        }
+      },
+      "example": "[\n  {\n    \"type\": \"whatsapp\",\n    \"value\": \"+1234567890\"\n  },\n  {\n    \"type\": \"kik\",\n    \"value\": \"acme.ny.reception\"\n  }\n]"
+    },
+    "LanguageReference": {
+      "description": "Preferred languages",
+      "type": "array",
+      "items": {
+        "allOf": [
+          {
+            "$ref": "#/definitions/LanguageItemReference"
+          }
+        ]
+      },
+      "example": "[\n  \"en-US\",\n  \"en-GB\",\n  \"cs-CZ\"\n]"
+    },
+    "LanguageItemReference": {
+      "description": "Language tag according to RFC 4646. Represented as combination of the ISO 639-1 language code and ISO 3166-1 alpha-2 country code. Examples: en-US, en-GB, cs-CZ, etc.",
+      "type": "string",
+      "example": "en-US"
+    },
+    "MediaListReference": {
+      "description": "List of media files",
+      "type": "object",
+      "required": [
+        "logo"
+      ],
+      "properties": {
+        "logo": {
+          "description": "Organization or unit logo",
+          "type": "string"
+        },
+        "images": {
+          "description": "List of images",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/MediaReference"
+              }
+            ]
+          }
+        },
+        "videos": {
+          "description": "List of video files",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/MediaReference"
+              }
+            ]
+          }
+        },
+        "documents": {
+          "description": "List of documents",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/MediaReference"
+              }
+            ]
+          }
+        },
+        "others": {
+          "description": "Files other than images, video files or documents",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "$ref": "#/definitions/MediaReference"
+              }
+            ]
+          }
+        }
+      },
+      "example": "{\n  \"logo\": \"https://imagehosting/hotel.jpg\",\n  \"images\": [\n    {\n      \"description\": \"Hotel Lobby\",\n      \"uri\": \"https://imagehosting/123456789.jpg\",\n      \"thumbnail\": \"https://imagehosting/123456789-thumbnail.jpg\"\n    }\n  ],\n  \"videos\": [\n    {\n      \"description\": \"Hotel Tour\",\n      \"uri\": \"https://videohosting/hotel-tour.mp4\",\n      \"cover\": \"https://imagehosting/hotel-tour-cover.jpg\",\n      \"thumbnail\": \"https://imagehosting/hotel-tour-cover-thumbnail.jpg\"\n    }\n  ],\n  \"documents\": [\n    {\n      \"description\": \"Hotel Presentation\",\n      \"uri\": \"https://filehosting/hotel-presentation.pdf\"\n    }\n  ]\n}"
+    },
+    "MediaReference": {
+      "description": "Media file",
+      "type": "object",
+      "required": [
+        "uri"
+      ],
+      "properties": {
+        "description": {
+          "description": "File description",
+          "type": "string"
+        },
+        "thumbnail": {
+          "description": "Thumbnail image",
+          "type": "string",
+          "format": "uri"
+        },
+        "uri": {
+          "description": "Link to the media resource",
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "example": "{\n  \"description\": \"Hotel Tour\",\n  \"uri\": \"https://videohosting/hotel-tour.mp4\",\n  \"cover\": \"https://imagehosting/hotel-tour-cover.jpg\",\n  \"thumbnail\": \"https://imagehosting/hotel-tour-cover-thumbnail.jpg\"\n}"
+    },
+    "Currency": {
+      "description": "Currency code",
+      "type": "string",
+      "pattern": "^[a-zA-Z]{2,}$",
+      "example": "EUR"
+    },
+    "BlockchainAccountId": {
+      "description": "Public key of the blockchain account",
+      "type": "string",
+      "pattern": "^([-a-zA-Z0-9]{5,41}):([-a-zA-Z0-9]{1,32}):([a-zA-Z0-9]{1,64})|([a-zA-Z0-9]{1,64})@([-a-z0-9]{5,41}):([-a-zA-Z-0-9]{1,32})$",
+      "example": "eip155:1:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb 0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb@eip155:1 # Legacy format"
+    },
+    "SwiftCode": {
+      "description": "SWIFT/BIC bank code according to ISO 9326",
+      "type": "string",
+      "pattern": "^[a-zA-Z]{4}[ -]{0,1}[a-zA-Z]{2}[ -]{0,1}[a-zA-Z0-9]{2}[ -]{0,1}[XXX0-9]{0,3}$",
+      "example": "UBSWUS33CHI"
+    },
+    "IbanCode": {
+      "description": "International Bank Account Number (IBAN) according to ISO 13616:1997",
+      "type": "string",
+      "pattern": "^([A-Z]{2}[ -]?[0-9]{2})(?=(?:[ -]?[A-Z0-9]){9,30}$)((?:[ -]?[A-Z0-9]{3,5}){2,7})([ -]?[A-Z0-9]{1,3})?$",
+      "example": "DE91100000000123456789"
+    },
+    "CryptographicSuiteReference": {
+      "description": "The cryptographic suite type that can be used for signatures verification",
+      "type": "string",
+      "enum": [
+        "EcdsaSecp256k1VerificationKey2019",
+        "EcdsaSecp256k1RecoveryMethod2020",
+        "JsonWebKey2020"
+      ]
+    },
+    "CapabilityDelegationReference": {
+      "description": "The capability delegation is used to specify mechanism that might be used by the DID subject (organization entity or person) to delegate a cryptographic capability to another party, such as delegating the authority to access a specific HTTP API to a subordinate or to specify a method of verification of credentials. ORGiD protocol uses capability delegation to specify an own method of ORG.JSON VC verification or a third party verification method to do it.",
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "$ref": "#/definitions/DIDReference"
+          },
+          {
+            "$ref": "#/definitions/VerificationMethodReference"
+          }
+        ]
+      },
+      "example": "\"capabilityDelegation\": [\n  \"did:orgid:4:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75#key1\",\n  {\n    \"id\": \"did:orgid:1:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75#key1\",\n    \"type\": \"EcdsaSecp256k1VerificationKey2019\",\n    \"controller\": \"did:orgid:1:0x94bf5a57b850a35b4d1d7b59f663ce3a8a76fd9928ef2067cc772fc97fb0ad75\",\n    \"publicKeyPem\": \"MFYwEAYHKoZIzj0CAQYFK4EEAAoDQgA...M8LZ6is0rMBMAXCvb9FH2g==\"\n  }\n]"
+    },
+    "CredentialReference": {
+      "description": "ORGiD Verifiable Credentials Schema",
+      "type": "object",
+      "required": [
+        "@context",
+        "id",
+        "type",
+        "issuer",
+        "issuanceDate",
+        "credentialSubject"
+      ],
+      "properties": {
+        "@context": {
+          "$ref": "#/definitions/ContextReference"
+        },
+        "id": {
+          "description": "Unique identifier of the VC generated by the issuer",
+          "$ref": "#/definitions/UUIDReference"
+        },
+        "type": {
+          "description": "Type of the VC",
+          "type": "array",
+          "items": {
+            "allOf": [
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "example": "[ \"VerifiableCredential\", \"UniversityDegreeCredential\" ]"
+        },
+        "issuer": {
+          "description": "VC issuer",
+          "$ref": "#/definitions/DIDReference"
+        },
+        "holder": {
+          "description": "VC holder",
+          "oneOf": [
+            {
+              "$ref": "#/definitions/VCHolderReference"
+            },
+            {
+              "$ref": "#/definitions/VCTypedHolderReference"
+            }
+          ]
+        },
+        "issuanceDate": {
+          "description": "When the VC was issued",
+          "type": "string",
+          "format": "date-time"
+        },
+        "expirationDate": {
+          "description": "When the VC will be expired",
+          "type": "string",
+          "format": "date-time"
+        },
+        "validFrom": {
+          "description": "When the VC will becomes valid. Useful when the credential usage is time dependent. E.g. Entrance card to the SPA",
+          "type": "string",
+          "format": "date-time"
+        },
+        "validUntil": {
+          "validFrom": null,
+          "description": "When the VC will becomes invalid. Useful when the credential usage is time dependent. E.g. Entrance card to the SPA",
+          "type": "string",
+          "format": "date-time"
+        },
+        "credentialSubject": {
+          "description": "Claims about the subject of VC",
+          "type": "object"
+        },
+        "proof": {
+          "$ref": "#/definitions/VCProofReference"
+        }
+      }
+    },
+    "UUIDReference": {
+      "description": "Unique identifier",
+      "type": "string",
+      "format": "uuid",
+      "minLength": 36,
+      "maxLength": 36,
+      "pattern": "^(?:^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[a-f0-9]{4}-[a-f0-9]{12}$)|(?:^0{8}-0{4}-0{4}-0{4}-0{12}$)$",
+      "example": "11111111-2222-3333-4444-000000000001"
+    },
+    "VCHolderReference": {
+      "description": "Holder' ORGiD",
+      "$ref": "#/definitions/DIDReference"
+    },
+    "VCTypedHolderReference": {
+      "description": "This type of the holder definition can be used when a credential issued to a holder who is not the (only) subject of the credential, who has no relationship with the subject of the credential, but who has a relationship with the issuer",
+      "type": "object",
+      "required": [
+        "type",
+        "id"
+      ],
+      "properties": {
+        "type": {
+          "description": "A type of activity during which the issuer permits to own the credential",
+          "type": "string",
+          "example": "LawEnforcement"
+        },
+        "id": {
+          "description": "Holder's ORGiD",
+          "$ref": "#/definitions/DIDReference"
+        }
+      }
+    },
+    "VCProofReference": {
+      "description": "Digital proof that makes the credential tamper-evident",
+      "type": "object",
+      "required": [
+        "type",
+        "created",
+        "proofPurpose",
+        "verificationMethod",
+        "jws"
+      ],
+      "properties": {
+        "type": {
+          "$ref": "#/definitions/CryptographicSignatureSuiteReference"
+        },
+        "created": {
+          "description": "When proof was created",
+          "type": "string",
+          "format": "date-time"
+        },
+        "proofPurpose": {
+          "description": "Purpose of the proof",
+          "type": "string",
+          "example": "assertionMethod"
+        },
+        "verificationMethod": {
+          "description": "The identifier of the public key that can verify the signature",
+          "$ref": "#/definitions/DIDReference"
+        },
+        "jws": {
+          "description": "The digital signature value",
+          "type": "string"
+        }
+      }
+    },
+    "CryptographicSignatureSuiteReference": {
+      "description": "The cryptographic signature suite that was used to generate the signature",
+      "type": "string",
+      "enum": [
+        "EcdsaSecp256k1Signature2019",
+        "EcdsaSecp256k1RecoverySignature2020",
+        "JsonWebSignature2020"
+      ]
+    }
+  }
+}