@pdtf/schemas 3.0.0-9 → 3.0.1-2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Property Data Trust Framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdtf/schemas",
-  "version": "3.0.0-9",
+  "version": "3.0.1-2",
   "description": "Property Data Trust Framework Schemas and Utilities",
   "main": "index.js",
   "directories": {

package/src/examples/v3/exampleAddParticipantVouch.json

@@ -0,0 +1,32 @@
+{
+  "verification": {
+    "trust_framework": "uk_pdtf",
+    "time": "2022-01-25T13:05:03.108Z",
+    "evidence": [
+      {
+        "type": "vouch",
+        "attestation": {
+          "type": "digital_attestation",
+          "voucher": {
+            "name": "Martin Abode"
+          }
+        },
+        "verification_method": {
+          "type": "auth"
+        }
+      }
+    ]
+  },
+  "claims": {
+    "/participants/-": {
+      "name": {
+        "firstName": "Martin",
+        "lastName": "Abode"
+      },
+      "email": "martin@abode.co.uk",
+      "organisation": "Abode and Floggit Estate Agents",
+      "organisationReference": "MAR/12243/22",
+      "role": "Estate Agent"
+    }
+  }
+}

package/src/examples/v3/exampleDocumentedVouch.json

@@ -0,0 +1,40 @@
+{
+  "verification": {
+    "trust_framework": "uk_pdtf",
+    "time": "2022-01-25T13:16:44.527Z",
+    "evidence": [
+      {
+        "type": "vouch",
+        "attachments": [
+          {
+            "digest": {
+              "alg": "md5",
+              "value": "randomHashValue"
+            },
+            "url": "https://fakeFileStore.com/some/kind/of/file",
+            "desc": "proofOfAddress.pdf",
+            "pdtfSchemaPath": "/propertyPack/materialFacts/councilTax/councilTaxAffectingAlterations/details"
+          }
+        ],
+        "verification_method": {
+          "type": "auth"
+        },
+        "attestation": {
+          "voucher": {
+            "name": "Maria Harris"
+          },
+          "type": "digital_attestation"
+        }
+      }
+    ]
+  },
+  "claims": {
+    "/propertyPack/councilTax": {
+      "councilTaxBand": "D",
+      "councilTaxAffectingAlterations": {
+        "yesNo": "Yes",
+        "details": "Extension added in 2005 to add bedroom with ensuite shower room. Certificate of Compliance issued 17th Feb 2006 and council tax updated"
+      }
+    }
+  }
+}

package/src/examples/v3/exampleElectronicRecord.json

@@ -0,0 +1,30 @@
+{
+  "verification": {
+    "time": "2022-01-25T07:52:14.318Z",
+    "trust_framework": "uk_pdtf",
+    "evidence": [
+      {
+        "type": "electronic_record",
+        "verifier": {
+          "organization": "Property Pack Assembly Software Ltd"
+        },
+        "record": {
+          "source": {
+            "name": "Royal Mail Postcode Address File",
+            "rights": "(c) Royal Mail"
+          },
+          "type": "postcode_address_file"
+        }
+      }
+    ]
+  },
+  "claims": {
+    "/propertyPack/address": {
+      "line1": "3 The Hollys",
+      "line2": "Birtley",
+      "town": "CHESTER LE STREET",
+      "county": "County Durham",
+      "postcode": "DH3 1QN"
+    }
+  }
+}