@pdtf/schemas 3.6.0-dev.3 → 3.6.0-dev.32

package/src/schemas/v4/PropertyTitleLink.json

@@ -0,0 +1,183 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/propertyTitleLink.json",
+  "type": "object",
+  "title": "Property–Title Link Entity",
+  "description": "A standing assertion that a property (UPRN) is related to a title. Many-to-many: one UPRN can sit on several titles, and one title (a block freehold, say) can cover many UPRNs. Issued by HM Land Registry for a registered title, and by the seller's conveyancer, on the epitome of title, for unregistered land. References no Transaction: a Transaction selects the titles being sold from the linked titles through titlesToBeSold, and a linked title it does not select is related but not sold.",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.32",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "83f31fddf82e57e67f2bc92844459095041b254b970d8881dd4318248c188f67"
+  },
+  "properties": {
+    "id": {
+      "title": "Property–Title Link URN",
+      "description": "Uniform Resource Name identifier for the link, urn:pdtf:propertyTitleLink:{id}",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "property": {
+      "title": "Property Reference",
+      "description": "URN referencing the Property entity, urn:pdtf:uprn:{uprn}",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "title": {
+      "title": "Title Reference",
+      "description": "URN referencing the Title entity: urn:pdtf:titleNumber:{number} for a registered title, urn:pdtf:unregisteredTitle:{id} for unregistered land",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "basis": {
+      "title": "Basis of the link",
+      "description": "What the link rests on, and the date it speaks as at. A registered title is linked on the register's own UPRN-to-title data; unregistered land on the epitome of title.",
+      "type": "object",
+      "properties": {
+        "type": {
+          "title": "Basis type",
+          "type": "string",
+          "enum": [
+            "Register Dataset",
+            "Epitome of Title"
+          ]
+        },
+        "asOf": {
+          "title": "As at",
+          "description": "The date the link speaks as at: the dataset's effective date, or the date the epitome was examined",
+          "type": "string",
+          "format": "date"
+        }
+      },
+      "required": [
+        "type",
+        "asOf"
+      ],
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "Register Dataset"
+              ]
+            },
+            "dataset": {
+              "title": "Dataset",
+              "description": "The register dataset the link is taken from, e.g. \"HMLR Title Number and UPRN Look Up\"",
+              "type": "string"
+            },
+            "datasetRelease": {
+              "title": "Dataset release",
+              "description": "The release the link is taken from, e.g. the full-file name of HMLR's monthly release (\"LR_UPRN_FULL_APR.csv\"). The dataset records no date per row, so asOf is the release date.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "dataset"
+          ]
+        },
+        {
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "Epitome of Title"
+              ]
+            },
+            "rootOfTitle": {
+              "title": "Root of title",
+              "description": "The good root of title the epitome starts from",
+              "type": "object",
+              "properties": {
+                "description": {
+                  "title": "Description",
+                  "description": "e.g. \"Conveyance on sale\"",
+                  "type": "string"
+                },
+                "date": {
+                  "title": "Date",
+                  "description": "Date of the root document",
+                  "type": "string",
+                  "format": "date"
+                }
+              }
+            },
+            "epitomeDigest": {
+              "title": "Epitome digest",
+              "description": "SHA-256 digest of the epitome of title as examined, in the form sha256:{hex} (spec 02 §6.6)",
+              "type": "string",
+              "pattern": "^sha256:[0-9a-f]{64}$"
+            }
+          },
+          "required": [
+            "rootOfTitle"
+          ]
+        }
+      ]
+    }
+  },
+  "required": [
+    "property",
+    "title",
+    "basis"
+  ],
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "title": {
+            "type": "string",
+            "pattern": "^urn:pdtf:titleNumber:"
+          }
+        },
+        "required": [
+          "title"
+        ]
+      },
+      "then": {
+        "properties": {
+          "basis": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "const": "Register Dataset"
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "title": {
+            "type": "string",
+            "pattern": "^urn:pdtf:unregisteredTitle:"
+          }
+        },
+        "required": [
+          "title"
+        ]
+      },
+      "then": {
+        "properties": {
+          "basis": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "const": "Epitome of Title"
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/src/schemas/v4/Representation.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/representation.json",
+  "type": "object",
+  "title": "Representation Entity",
+  "description": "A professional representation relationship — one party instructed by another, e.g. a conveyancer acting for a seller. One entity per (representative, represented party) pair: a conveyancer instructed jointly by two sellers yields two, and sellers who instruct separate conveyancers yield one each.",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.32",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "83f31fddf82e57e67f2bc92844459095041b254b970d8881dd4318248c188f67"
+  },
+  "properties": {
+    "id": {
+      "title": "Representation URN",
+      "description": "Uniform Resource Name identifier for the representation",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "representative": {
+      "title": "Representative Reference",
+      "description": "DID referencing the Person or Organisation who is instructed",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:(?:(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    },
+    "representedParty": {
+      "title": "Represented Party Reference",
+      "description": "DID referencing the Person or Organisation who instructed them",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:(?:(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    },
+    "role": {
+      "title": "Role",
+      "type": "string",
+      "enum": [
+        "Seller",
+        "Seller's Conveyancer",
+        "Prospective Buyer",
+        "Buyer",
+        "Buyer's Conveyancer",
+        "Giftor",
+        "Estate Agent",
+        "Buyer's Agent",
+        "Surveyor",
+        "Mortgage Broker",
+        "Lender",
+        "Landlord",
+        "Tenant",
+        "Platform Support"
+      ],
+      "description": "The kind of representation this is — a property of the representation, not a duplicated participant attribute. The representative's firm is on the transaction roster."
+    },
+    "transaction": {
+      "title": "Transaction Reference",
+      "description": "DID referencing the Transaction entity",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:(?:(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    }
+  },
+  "required": [
+    "representative",
+    "representedParty",
+    "role",
+    "transaction"
+  ]
+}

package/src/schemas/v4/SellerCapacity.json

@@ -0,0 +1,193 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/sellerCapacity.json",
+  "type": "object",
+  "title": "Seller Capacity Entity",
+  "description": "The legal capacity in which a seller is selling a given title. Derived from the V3 participants 'Seller' branch (sellersCapacity, dateBecameOwnerOrAuthority).",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.32",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "83f31fddf82e57e67f2bc92844459095041b254b970d8881dd4318248c188f67"
+  },
+  "properties": {
+    "id": {
+      "title": "Seller Capacity URN",
+      "description": "Uniform Resource Name identifier for the seller capacity",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "seller": {
+      "title": "Seller Reference",
+      "description": "DID referencing the Person or Organisation acting as seller",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:(?:(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    },
+    "title": {
+      "title": "Title Reference",
+      "description": "URN referencing the Title entity being sold",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "sellersCapacity": {
+      "title": "Capacity in which the Seller sells",
+      "ta6ed6Title": "What is your role in the sale?",
+      "ta6ed6v2Title": "What is your role in the sale?",
+      "type": "object",
+      "properties": {
+        "capacity": {
+          "type": "string",
+          "title": "",
+          "enum": [
+            "Legal Owner",
+            "Personal Representative for a Deceased Owner",
+            "Under Power of Attorney",
+            "Mortgagee in Possession",
+            "Company Director",
+            "Company Secretary",
+            "Trustee",
+            "Assistant",
+            "Other"
+          ],
+          "ta6ed6Enum": [
+            "Legal Owner",
+            "Company Director",
+            "Personal Representative for a Deceased Owner",
+            "Under Power of Attorney",
+            "Trustee"
+          ],
+          "ta6ed6v2Enum": [
+            "Legal Owner",
+            "Company Director",
+            "Personal Representative for a Deceased Owner",
+            "Under Power of Attorney",
+            "Trustee"
+          ],
+          "ta6ed6EnumNames": {
+            "Legal Owner": "Seller (Private individual)",
+            "Company Director": "Seller (Company)",
+            "Personal Representative for a Deceased Owner": "Executor(s)/Administrator(s)",
+            "Under Power of Attorney": "Attorney(s)",
+            "Trustee": "Trustee(s)"
+          },
+          "ta6ed6v2EnumNames": {
+            "Legal Owner": "Seller (Private individual)",
+            "Company Director": "Seller (Company)",
+            "Personal Representative for a Deceased Owner": "Executor(s)/Administrator(s)",
+            "Under Power of Attorney": "Attorney(s)",
+            "Trustee": "Trustee(s)"
+          }
+        }
+      },
+      "discriminator": {
+        "propertyName": "capacity"
+      },
+      "oneOf": [
+        {
+          "properties": {
+            "capacity": {
+              "enum": [
+                "Legal Owner",
+                "Mortgagee in Possession"
+              ]
+            },
+            "sellersCapacityDetails": {
+              "title": "Please provide details if applicable",
+              "description": "(for example if the sellers names do not match the legal owners on the title deed due to change of name on marriage)",
+              "type": "string"
+            },
+            "attachments": {
+              "title": "Attachments",
+              "type": "string",
+              "enum": [
+                "Attached",
+                "To follow"
+              ]
+            }
+          }
+        },
+        {
+          "properties": {
+            "capacity": {
+              "enum": [
+                "Personal Representative for a Deceased Owner",
+                "Under Power of Attorney",
+                "Trustee",
+                "Assistant",
+                "Other"
+              ]
+            },
+            "sellersCapacityDetails": {
+              "title": "Please provide details and provide any probate, grant of representation or power of attorney ",
+              "type": "string"
+            },
+            "attachments": {
+              "title": "Attachments",
+              "type": "string",
+              "enum": [
+                "Attached",
+                "To follow"
+              ]
+            }
+          }
+        },
+        {
+          "properties": {
+            "capacity": {
+              "enum": [
+                "Company Director",
+                "Company Secretary"
+              ]
+            },
+            "sellersCapacityDetails": {
+              "title": "Please provide details and provide any probate, grant of representation or power of attorney ",
+              "type": "string"
+            },
+            "attachments": {
+              "title": "Attachments",
+              "type": "string",
+              "enum": [
+                "Attached",
+                "To follow"
+              ]
+            },
+            "companyName": {
+              "title": "Company name",
+              "type": "string"
+            },
+            "companyNumber": {
+              "title": "Company number",
+              "type": "string"
+            },
+            "directorOrAuthorisedPerson": {
+              "title": "Director/authorised person",
+              "type": "string"
+            },
+            "countryOfIncorporation": {
+              "title": "Country of incorporation",
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
+    "dateBecameOwnerOrAuthority": {
+      "title": "Date the seller became owner or was authorised to sell",
+      "ta6ed6Title": "When did you become the owner of, or get authority to sell, the property? (DD/MM/YYYY)",
+      "ta6ed6v2Title": "When did you become the owner of, or get authority to sell, the property? (DD/MM/YYYY)",
+      "type": "string",
+      "format": "date"
+    },
+    "transaction": {
+      "title": "Transaction Reference",
+      "description": "DID referencing the Transaction entity",
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:(?:(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})*:)*(?:[a-zA-Z0-9._-]|%[0-9A-Fa-f]{2})+$"
+    }
+  },
+  "required": [
+    "seller",
+    "transaction"
+  ]
+}