@pdtf/schemas 3.6.0-dev.20 → 3.6.0-dev.21

package/src/schemas/v4/Transaction.json

@@ -0,0 +1,1570 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/transaction.json",
+  "type": "object",
+  "title": "Transaction Entity",
+  "description": "Transaction-level metadata — status, milestones, chain, contracts, offers, enquiries, and sale context.",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.21",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "1c6c5812f73a36d3674d5fb7b5eb1f6ce524d09c4195e281e078b9e41ea94f6d"
+  },
+  "properties": {
+    "transactionId": {
+      "title": "UUID for the transaction",
+      "type": "string"
+    },
+    "externalIds": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "patternProperties": {
+                ".*": {}
+              }
+            }
+          ]
+        }
+      }
+    },
+    "metadata": {
+      "title": "Metadata",
+      "description": "Flexible container for vendor-specific metadata items relating to the transaction. Keys are vendor-defined; values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below /metadata (e.g. /metadata/vendor/item/field).",
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "array"
+                    },
+                    {
+                      "type": "null"
+                    },
+                    {
+                      "type": "object",
+                      "patternProperties": {
+                        ".*": {}
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "For sale",
+        "Under offer",
+        "Sold subject to contract",
+        "Contracts exchanged",
+        "Completed",
+        "Cancelled",
+        "To let",
+        "Let agreed"
+      ]
+    },
+    "valuationComparisonData": {
+      "title": "Valuation Comparison Data",
+      "description": "A collection of data used to compare the valuations (market values) of properties in the real estate or property market.",
+      "type": "object",
+      "properties": {
+        "propertyDetails": {
+          "title": "Property Details",
+          "description": "Details and information related to individual properties for valuation comparison.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "propertyListingInfo": {
+                "title": "Property Listing Information",
+                "description": "Information related to the pricing and status of a property listing.",
+                "type": "object",
+                "properties": {
+                  "listingType": {
+                    "title": "Listing Type",
+                    "type": "string",
+                    "enum": [
+                      "Recently Sold",
+                      "Currently On Sale"
+                    ],
+                    "description": "Type of property listing, indicating whether it was recently sold or is currently on sale."
+                  }
+                },
+                "discriminator": {
+                  "propertyName": "listingType"
+                },
+                "oneOf": [
+                  {
+                    "title": "Recently Sold Property",
+                    "description": "Specific information about a property that was recently sold.",
+                    "properties": {
+                      "listingType": {
+                        "enum": [
+                          "Recently Sold"
+                        ]
+                      },
+                      "soldDate": {
+                        "title": "Sold Date",
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date when the property was sold."
+                      },
+                      "soldPrice": {
+                        "title": "Sold Price",
+                        "type": "number",
+                        "description": "The amount for which the property was sold."
+                      }
+                    }
+                  },
+                  {
+                    "title": "Property Currently On Sale",
+                    "description": "Specific information about a property that is currently listed for sale.",
+                    "properties": {
+                      "listingType": {
+                        "enum": [
+                          "Currently On Sale"
+                        ]
+                      },
+                      "listedDate": {
+                        "title": "Listed Date",
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date when the property was listed for sale."
+                      },
+                      "listPrice": {
+                        "title": "List Price",
+                        "type": "number",
+                        "description": "The asking price for the property currently on sale."
+                      }
+                    }
+                  }
+                ]
+              },
+              "propertyFullDescription": {
+                "title": "Property Description",
+                "description": "A detailed description of the property.",
+                "type": "string"
+              },
+              "uprn": {
+                "title": "Unique Property Reference Number (UPRN)",
+                "description": "A unique identifier for the property.",
+                "type": "string"
+              },
+              "propertyType": {
+                "title": "Type of Property",
+                "description": "The type or category of the property.",
+                "type": "string"
+              },
+              "marketingTenure": {
+                "title": "Marketing Tenure",
+                "description": "The type of tenure being marketed for the property.",
+                "type": "string",
+                "enum": [
+                  "Commonhold",
+                  "Freehold",
+                  "Leasehold",
+                  "Share of Freehold",
+                  "Shared Ownership"
+                ]
+              },
+              "basicDetails": {
+                "title": "Basic Property Details",
+                "description": "Basic information about the property.",
+                "type": "object",
+                "properties": {
+                  "bedrooms": {
+                    "title": "Number of Bedrooms",
+                    "description": "The total number of bedrooms in the property.",
+                    "type": "integer"
+                  },
+                  "bathrooms": {
+                    "title": "Number of Bathrooms",
+                    "description": "The total number of bathrooms in the property.",
+                    "type": "integer"
+                  },
+                  "buildInformation": {
+                    "title": "Information related to property build",
+                    "description": "Details related to the construction of the property.",
+                    "type": "object",
+                    "properties": {
+                      "internalArea": {
+                        "title": "Total internal floor area",
+                        "description": "The total internal floor area of the property.",
+                        "type": "object",
+                        "properties": {
+                          "area": {
+                            "title": "Internal area value",
+                            "description": "The numerical value of the internal floor area.",
+                            "type": "number",
+                            "minimum": 0
+                          },
+                          "units": {
+                            "title": "Internal area units",
+                            "description": "The units of measurement for the internal floor area.",
+                            "type": "string",
+                            "enum": [
+                              "square metres",
+                              "square feet"
+                            ]
+                          }
+                        }
+                      },
+                      "yearOfBuild": {
+                        "title": "Year the property was built",
+                        "description": "The year when the property was constructed.",
+                        "type": "integer"
+                      }
+                    }
+                  }
+                }
+              },
+              "media": {
+                "title": "Media",
+                "description": "Media content related to the property listing.",
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "mediaType": {
+                      "title": "Type of media",
+                      "description": "The type of media content (e.g., images, floorplans, brochures) related to the property.",
+                      "type": "string",
+                      "enum": [
+                        "Image",
+                        "Floorplan",
+                        "Brochure",
+                        "Virtual tour",
+                        "Audio tour",
+                        "EPC",
+                        "EPC graph",
+                        "Other"
+                      ]
+                    },
+                    "mediaUrl": {
+                      "title": "Media URL",
+                      "description": "The URL or link to access the media content.",
+                      "type": "string",
+                      "format": "uri"
+                    },
+                    "caption": {
+                      "title": "Caption",
+                      "description": "A descriptive caption or label for the media content.",
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "propertyPricing": {
+          "title": "Property Pricing Estimates",
+          "description": "Detailed property pricing estimates, including rental estimates, market value, and yield calculations.",
+          "type": "object",
+          "properties": {
+            "rentalEstimate": {
+              "title": "Rental Estimate",
+              "description": "Estimated rental income for the property.",
+              "type": "object",
+              "properties": {
+                "estimatedAmount": {
+                  "title": "Rental Estimate Amount",
+                  "description": "The estimated rental amount for the property.",
+                  "type": "number"
+                },
+                "paymentFrequency": {
+                  "title": "Payment Frequency",
+                  "description": "The frequency at which the rental amount is calculated.",
+                  "type": "string",
+                  "enum": [
+                    "Per Week",
+                    "Per Calendar Month",
+                    "Per Year"
+                  ]
+                }
+              }
+            },
+            "estimatedPrice": {
+              "title": "Estimated Price",
+              "description": "Approximation of the property's current market value",
+              "type": "number"
+            },
+            "yield": {
+              "title": "Yield",
+              "description": "Return on investment (ROI) generated by an income-producing asset",
+              "type": "number"
+            },
+            "priceEstimationDetails": {
+              "type": "object",
+              "title": "Credibility and Pricing Methodology",
+              "description": "Information about the credibility of property pricing estimates and the methodology used in their calculation.",
+              "properties": {
+                "credibilitySources": {
+                  "type": "array",
+                  "title": "Data Sources",
+                  "description": "The sources of data used for property pricing estimates.",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "pricingMethodology": {
+                  "title": "Pricing Methodology",
+                  "description": "Description of the methodology used to estimate property pricing.",
+                  "type": "string",
+                  "default": "This estimate is based on a combination of market research, historical sales data, and current market trends. It may not represent the exact market value."
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "contracts": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "contractId": {
+            "title": "Contract id",
+            "description": "Stable identifier for this contract within the transaction. Array position is not a safe reference: contracts are added and superseded independently by different parties.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+          },
+          "contract": {
+            "type": "object",
+            "required": [
+              "template",
+              "terms"
+            ],
+            "properties": {
+              "template": {
+                "type": "object",
+                "required": [
+                  "name",
+                  "url",
+                  "requiredSignatories"
+                ],
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "url": {
+                    "type": "string",
+                    "format": "uri"
+                  },
+                  "externalIds": {
+                    "type": "object",
+                    "patternProperties": {
+                      ".*": {
+                        "oneOf": [
+                          {
+                            "type": "string"
+                          },
+                          {
+                            "type": "number"
+                          },
+                          {
+                            "type": "boolean"
+                          },
+                          {
+                            "type": "object",
+                            "patternProperties": {
+                              ".*": {}
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  },
+                  "requiredSignatories": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "role": {
+                          "type": "string",
+                          "enum": [
+                            "Seller",
+                            "Seller's Conveyancer",
+                            "Prospective Buyer",
+                            "Buyer",
+                            "Buyer's Conveyancer",
+                            "Estate Agent",
+                            "Buyer's Agent",
+                            "Surveyor",
+                            "Mortgage Broker",
+                            "Lender",
+                            "Landlord",
+                            "Tenant"
+                          ]
+                        },
+                        "requiresAll": {
+                          "type": "boolean"
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "terms": {
+                "type": "object"
+              }
+            }
+          },
+          "signatures": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "name",
+                "signedOn",
+                "role",
+                "contractHash"
+              ],
+              "properties": {
+                "signatureId": {
+                  "title": "Signature id",
+                  "description": "Stable identifier for this signature within the contract. Array position is not a safe reference: signatories sign independently and in any order.",
+                  "type": "string",
+                  "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+                },
+                "name": {
+                  "type": "string"
+                },
+                "signedOn": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "externalIds": {
+                  "type": "object",
+                  "patternProperties": {
+                    ".*": {
+                      "oneOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "number"
+                        },
+                        {
+                          "type": "boolean"
+                        },
+                        {
+                          "type": "object",
+                          "patternProperties": {
+                            ".*": {}
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              },
+              "role": {
+                "type": "string",
+                "enum": [
+                  "Seller",
+                  "Seller's Conveyancer",
+                  "Prospective Buyer",
+                  "Buyer",
+                  "Buyer's Conveyancer",
+                  "Estate Agent",
+                  "Buyer's Agent",
+                  "Surveyor",
+                  "Mortgage Broker",
+                  "Lender",
+                  "Landlord",
+                  "Tenant"
+                ]
+              },
+              "contractHash": {
+                "title": "An MD5 hash of the stable-stringified contract object being signed",
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "chain": {
+      "title": "Data Containing the Related Chain",
+      "description": "the data through which the chain for this tranasaction can be built.",
+      "type": "object",
+      "properties": {
+        "onwardPurchase": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "title": "Onwards Purchase",
+            "properties": {
+              "transactionId": {
+                "title": "UUID for an onward transaction",
+                "type": "string"
+              },
+              "externalIds": {
+                "type": "object",
+                "patternProperties": {
+                  ".*": {
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "boolean"
+                      },
+                      {
+                        "type": "object",
+                        "patternProperties": {
+                          ".*": {}
+                        }
+                      }
+                    ]
+                  }
+                }
+              },
+              "address": {
+                "title": "Address",
+                "type": "object",
+                "properties": {
+                  "buildingNumber": {
+                    "title": "Building number",
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "buildingName": {
+                    "title": "Building name",
+                    "type": "string"
+                  },
+                  "subBuilding": {
+                    "title": "Sub building name",
+                    "type": "string"
+                  },
+                  "street": {
+                    "title": "Street",
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "line1": {
+                    "title": "Address 1",
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "line2": {
+                    "title": "Address 2",
+                    "type": "string"
+                  },
+                  "line 3": {
+                    "title": "Address 3",
+                    "type": "string"
+                  },
+                  "town": {
+                    "title": "Town",
+                    "type": "string"
+                  },
+                  "postcode": {
+                    "title": "Postcode",
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "homeNation": {
+                    "title": "Home nation",
+                    "type": "string",
+                    "enum": [
+                      "England",
+                      "Wales",
+                      "Scotland",
+                      "Northern Ireland"
+                    ]
+                  }
+                }
+              },
+              "uprn": {
+                "title": "Unique Property Reference Number",
+                "type": "integer"
+              },
+              "sellingAgent": {
+                "title": "Estate Agent selling the property",
+                "type": "string"
+              }
+            }
+          }
+        }
+      },
+      "buyersSale": {
+        "type": "array",
+        "minItems": 1,
+        "items": {
+          "type": "object",
+          "title": "The property(ies) the buyer/buyers are selling to finance the purchase",
+          "properties": {
+            "transactionId": {
+              "title": "UUID for an onward transaction",
+              "type": "string"
+            },
+            "externalIds": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "object",
+                      "patternProperties": {
+                        ".*": {}
+                      }
+                    }
+                  ]
+                }
+              }
+            },
+            "address": {
+              "title": "Address",
+              "type": "object",
+              "properties": {
+                "buildingNumber": {
+                  "title": "Building number",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "buildingName": {
+                  "title": "Building name",
+                  "type": "string"
+                },
+                "subBuilding": {
+                  "title": "Sub building name",
+                  "type": "string"
+                },
+                "street": {
+                  "title": "Street",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "line1": {
+                  "title": "Address 1",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "line2": {
+                  "title": "Address 2",
+                  "type": "string"
+                },
+                "line 3": {
+                  "title": "Address 3",
+                  "type": "string"
+                },
+                "town": {
+                  "title": "Town",
+                  "type": "string"
+                },
+                "postcode": {
+                  "title": "Postcode",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "homeNation": {
+                  "title": "Home nation",
+                  "type": "string",
+                  "enum": [
+                    "England",
+                    "Wales",
+                    "Scotland",
+                    "Northern Ireland"
+                  ]
+                }
+              }
+            },
+            "uprn": {
+              "title": "Unique Property Reference Number",
+              "type": "integer"
+            },
+            "sellingAgent": {
+              "title": "Estate Agent selling the property",
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "milestones": {
+      "title": "Transaction Milestones",
+      "type": "object",
+      "properties": {
+        "listed": {
+          "description": "The date the property commenced marketing by being publicly listed for sale",
+          "type": "object",
+          "properties": {
+            "expected": {
+              "description": "Planned date of listing, for example when scheduled in advance around e.g. Boxing Day activities",
+              "type": "string",
+              "format": "date-time"
+            },
+            "completed": {
+              "description": "Actual date of first public listing for sale",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "legalForms": {
+          "description": "The progress of the legal forms completion, including TA6, TA7 where relevant, and TA10 forms or their equivalents",
+          "type": "object",
+          "properties": {
+            "started": {
+              "description": "The date the legal forms were shared with the vendors for completion",
+              "type": "string",
+              "format": "date-time"
+            },
+            "completed": {
+              "description": "The date the legal forms were completed and signed by all parties",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "soldSubjectToContract": {
+          "type": "object",
+          "properties": {
+            "completed": {
+              "description": "The date an offer for sale was accepted by a proceedable buyer",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "searches": {
+          "description": "The progress of all searches in a standard search pack together",
+          "type": "object",
+          "properties": {
+            "started": {
+              "description": "The date the first of the searches in the pack was ordered",
+              "type": "string",
+              "format": "date-time"
+            },
+            "expected": {
+              "description": "The latest date the searches are expected to be completed",
+              "type": "string",
+              "format": "date-time"
+            },
+            "completed": {
+              "description": "The date the last of the searches in the pack was delivered",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "enquiries": {
+          "type": "object",
+          "properties": {
+            "started": {
+              "description": "The date the enquiries process between conveyancers was commenced",
+              "type": "string",
+              "format": "date-time"
+            },
+            "completed": {
+              "description": "The date the last of the enquiries was resolved",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "exchangeOfContracts": {
+          "type": "object",
+          "properties": {
+            "expected": {
+              "description": "A proposed or agreed date for the exchange of contracts",
+              "type": "string",
+              "format": "date-time"
+            },
+            "completed": {
+              "description": "The actual date the contracts were exchanged",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        },
+        "completion": {
+          "type": "object",
+          "properties": {
+            "started": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "expected": {
+              "description": "A proposed or agreed date for completion",
+              "type": "string",
+              "format": "date-time"
+            },
+            "completed": {
+              "description": "The actual date the property sale was completed",
+              "type": "string",
+              "format": "date-time"
+            }
+          }
+        }
+      }
+    },
+    "offers": {
+      "title": "Offers for purchase of the property",
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+      },
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "properties": {
+            "amount": {
+              "type": "number",
+              "minimum": 0
+            },
+            "currency": {
+              "type": "string",
+              "pattern": "^[A-Z]{3}$"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "Pending",
+                "Withdrawn",
+                "Rejected",
+                "Accepted",
+                "Note of Interest"
+              ]
+            },
+            "inclusions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "exclusions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "conditions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "externalIds": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "object",
+                      "patternProperties": {
+                        ".*": {}
+                      }
+                    }
+                  ]
+                }
+              }
+            },
+            "metadata": {
+              "title": "Offer metadata",
+              "description": "Flexible container for vendor-specific metadata items relating to this offer, keyed by vendor namespace (e.g. /offers/{id}/metadata/Moverly/lenderCompatibilityAnalysis). Values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below metadata (e.g. /offers/{id}/metadata/vendor/item/field).",
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "object",
+                      "patternProperties": {
+                        ".*": {
+                          "oneOf": [
+                            {
+                              "type": "string"
+                            },
+                            {
+                              "type": "number"
+                            },
+                            {
+                              "type": "boolean"
+                            },
+                            {
+                              "type": "array"
+                            },
+                            {
+                              "type": "null"
+                            },
+                            {
+                              "type": "object",
+                              "patternProperties": {
+                                ".*": {}
+                              }
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            },
+            "buyerCircumstances": {
+              "title": "Buyer circumstances",
+              "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
+              "type": "object",
+              "properties": {
+                "intendedUse": {
+                  "type": "string",
+                  "title": "Intended use of property",
+                  "enum": [
+                    "Owner occupied",
+                    "Buy-to-let",
+                    "Holiday let",
+                    "Second home"
+                  ]
+                },
+                "firstTimeBuyer": {
+                  "type": "boolean",
+                  "title": "First-time buyer"
+                },
+                "rightToBuy": {
+                  "type": "boolean",
+                  "title": "Right to Buy purchase"
+                },
+                "ltdCompanyPurchase": {
+                  "type": "boolean",
+                  "title": "Limited company purchase"
+                },
+                "numberOfOwners": {
+                  "type": "integer",
+                  "title": "Number of owners",
+                  "nullable": true
+                },
+                "numberOfExpats": {
+                  "type": "integer",
+                  "title": "Number of expat buyers",
+                  "nullable": true
+                },
+                "giftedEquity": {
+                  "type": "boolean",
+                  "title": "Gifted equity"
+                },
+                "numberOfGiftedDeposits": {
+                  "type": "integer",
+                  "title": "Number of gifted deposits",
+                  "nullable": true
+                },
+                "requiresMortgage": {
+                  "type": "string",
+                  "title": "Requires mortgage",
+                  "enum": [
+                    "Yes",
+                    "No"
+                  ]
+                },
+                "isAdditionalProperty": {
+                  "type": "boolean",
+                  "title": "Additional property purchase",
+                  "description": "Whether the buyer already owns residential property (SDLT higher rates apply)"
+                },
+                "hasPets": {
+                  "type": "boolean",
+                  "title": "Buyer has pets",
+                  "description": "Relevant to lease and covenant pet restriction assessment"
+                },
+                "intendsSublet": {
+                  "type": "boolean",
+                  "title": "Buyer intends to sublet",
+                  "description": "Relevant to lease and covenant subletting restriction assessment"
+                },
+                "subletType": {
+                  "type": "string",
+                  "title": "Type of subletting intended",
+                  "enum": [
+                    "AST",
+                    "Lodger",
+                    "Airbnb",
+                    "HMO",
+                    "Company let",
+                    "Other"
+                  ]
+                },
+                "intendsBusiness": {
+                  "type": "boolean",
+                  "title": "Buyer intends business use",
+                  "description": "Relevant to covenant and lease business-use restriction assessment"
+                },
+                "businessType": {
+                  "type": "string",
+                  "title": "Type of business intended"
+                },
+                "intendsAlterations": {
+                  "type": "boolean",
+                  "title": "Buyer intends significant alterations",
+                  "description": "Relevant to covenant, planning and building regulations assessment"
+                },
+                "financingMethod": {
+                  "type": "string",
+                  "title": "Primary financing method",
+                  "description": "How the purchase is funded, distinct from intendedUse (how the property will be used)",
+                  "enum": [
+                    "Mortgage",
+                    "Cash",
+                    "Shared ownership",
+                    "Help to Buy",
+                    "Right to Buy"
+                  ]
+                }
+              },
+              "discriminator": {
+                "propertyName": "requiresMortgage"
+              },
+              "required": [
+                "requiresMortgage"
+              ],
+              "oneOf": [
+                {
+                  "properties": {
+                    "requiresMortgage": {
+                      "enum": [
+                        "No"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "properties": {
+                    "requiresMortgage": {
+                      "enum": [
+                        "Yes"
+                      ]
+                    },
+                    "helpToBuyEquityLoan": {
+                      "type": "boolean",
+                      "title": "Help to Buy equity loan"
+                    },
+                    "armedForcesHelpToBuy": {
+                      "type": "boolean",
+                      "title": "Armed Forces Help to Buy"
+                    },
+                    "numberOfHelpToBuyIsas": {
+                      "type": "integer",
+                      "title": "Number of Help to Buy ISAs",
+                      "nullable": true
+                    },
+                    "bridgingFinanceRepresentation": {
+                      "type": "string",
+                      "title": "Bridging finance representation",
+                      "enum": [
+                        "Dual",
+                        "Separate"
+                      ],
+                      "nullable": true
+                    },
+                    "depositAmount": {
+                      "type": "number",
+                      "title": "Deposit amount",
+                      "minimum": 0
+                    },
+                    "loanToValue": {
+                      "type": "number",
+                      "title": "Loan-to-Value (LTV)",
+                      "minimum": 0,
+                      "maximum": 100
+                    },
+                    "numberOfBorrowers": {
+                      "type": "integer",
+                      "title": "Number of borrowers",
+                      "minimum": 1,
+                      "maximum": 4,
+                      "default": 1
+                    },
+                    "jointProprietorSoleMortgagor": {
+                      "type": "boolean",
+                      "title": "Joint proprietor, sole mortgagor"
+                    },
+                    "soleProprietorJointMortgagor": {
+                      "type": "boolean",
+                      "title": "Sole proprietor, joint mortgagor"
+                    },
+                    "deedOfPostponement": {
+                      "type": "boolean",
+                      "title": "Deed of postponement required"
+                    },
+                    "separateRepresentation": {
+                      "type": "boolean",
+                      "title": "Separate legal representation required",
+                      "nullable": true
+                    },
+                    "oldestBorrowerAge": {
+                      "type": "integer",
+                      "title": "Oldest borrower age",
+                      "minimum": 18,
+                      "maximum": 85
+                    },
+                    "mortgageTerm": {
+                      "type": "integer",
+                      "title": "Mortgage term",
+                      "minimum": 5,
+                      "maximum": 40
+                    },
+                    "adverseCredit": {
+                      "type": "string",
+                      "title": "Adverse credit",
+                      "enum": [
+                        "No",
+                        "Yes",
+                        "Prefer not to say"
+                      ]
+                    },
+                    "employmentType": {
+                      "type": "string",
+                      "title": "Employment type",
+                      "enum": [
+                        "Employed",
+                        "Self-employed",
+                        "Retired",
+                        "Contractor",
+                        "Other"
+                      ]
+                    },
+                    "existingMortgagedProperties": {
+                      "type": "integer",
+                      "title": "Existing mortgaged properties",
+                      "minimum": 0
+                    },
+                    "annualIncome": {
+                      "type": "number",
+                      "title": "Annual gross income",
+                      "minimum": 0
+                    },
+                    "residencyStatus": {
+                      "type": "string",
+                      "title": "Residency status",
+                      "enum": [
+                        "UK citizen",
+                        "Permanent resident",
+                        "Visa holder",
+                        "Non-resident"
+                      ]
+                    },
+                    "nominatedLender": {
+                      "type": "string",
+                      "title": "Nominated lender",
+                      "description": "The nominated lender's name as entered or selected"
+                    },
+                    "nominatedLenderHandbookId": {
+                      "type": "string",
+                      "title": "Nominated lender (UK Finance Handbook id)",
+                      "description": "The nominated lender's identifier in the UK Finance Mortgage Lenders' Handbook, e.g. nationwide-building-society, so lender requirements can be looked up without matching on name"
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    },
+    "enquiries": {
+      "title": "Property transaction enquiries between conveyancers",
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+      },
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "properties": {
+            "subject": {
+              "description": "The subject or topic of the enquiry",
+              "type": "string"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "pending",
+                "open",
+                "resolved",
+                "resolvedWithCondition",
+                "withdrawn"
+              ]
+            },
+            "messages": {
+              "description": "Messages exchanged regarding this enquiry",
+              "type": "object",
+              "propertyNames": {
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
+              "patternProperties": {
+                ".*": {
+                  "type": "object",
+                  "properties": {
+                    "datetime": {
+                      "type": "string",
+                      "format": "date-time"
+                    },
+                    "originatorRole": {
+                      "type": "string",
+                      "enum": [
+                        "Seller",
+                        "Seller's Conveyancer",
+                        "Buyer",
+                        "Buyer's Conveyancer",
+                        "Estate Agent",
+                        "Buyer's Agent",
+                        "Surveyor",
+                        "Mortgage Broker",
+                        "Lender"
+                      ]
+                    },
+                    "destinationRole": {
+                      "type": "string",
+                      "enum": [
+                        "Seller",
+                        "Seller's Conveyancer",
+                        "Buyer",
+                        "Buyer's Conveyancer",
+                        "Estate Agent",
+                        "Buyer's Agent",
+                        "Surveyor",
+                        "Mortgage Broker",
+                        "Lender"
+                      ]
+                    },
+                    "messageText": {
+                      "type": "string"
+                    },
+                    "pdtfPath": {
+                      "description": "PDTF schema path indicating where response data should be stored, enabling structured data resolution alongside the enquiry message",
+                      "type": "string",
+                      "pattern": "^/"
+                    }
+                  },
+                  "required": [
+                    "datetime",
+                    "originatorRole",
+                    "destinationRole",
+                    "messageText"
+                  ]
+                }
+              }
+            },
+            "externalIds": {
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "oneOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "type": "number"
+                    },
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "object",
+                      "patternProperties": {
+                        ".*": {}
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "required": [
+            "subject",
+            "status",
+            "messages"
+          ],
+          "discriminator": {
+            "propertyName": "status"
+          },
+          "oneOf": [
+            {
+              "properties": {
+                "status": {
+                  "const": "resolvedWithCondition"
+                },
+                "resolutionCondition": {
+                  "description": "Condition that must be met for the enquiry to be fully resolved",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "resolutionCondition"
+              ]
+            },
+            {
+              "properties": {
+                "status": {
+                  "enum": [
+                    "pending",
+                    "open",
+                    "resolved",
+                    "withdrawn"
+                  ]
+                }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "id": {
+      "title": "Transaction DID",
+      "description": "Decentralised Identifier for the transaction",
+      "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})+$"
+    },
+    "property": {
+      "title": "Property Reference",
+      "description": "URN referencing the Property entity associated with this transaction",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "titlesToBeSold": {
+      "title": "Titles to be Sold",
+      "description": "Array of URNs referencing Title entities to be sold in this transaction",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "title": "Title URN",
+        "description": "URN reference to a Title entity",
+        "type": "string",
+        "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+      }
+    },
+    "participants": {
+      "title": "Participants",
+      "description": "Ordered roster of the parties to this transaction. Each entry references a Person or Organisation entity and carries only its transaction-scoped identity and firm; role and every relationship live on the credentials, so that revoking a credential removes what it asserts. The array order is the V3 participants order and is authoritative for recomposition.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "title": "Transaction Participant",
+        "properties": {
+          "participant": {
+            "title": "Participant DID",
+            "description": "DID reference to the Person or Organisation 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})+$"
+          },
+          "organisation": {
+            "title": "Organisation",
+            "type": "string"
+          },
+          "organisationReference": {
+            "title": "Reference",
+            "type": "string"
+          },
+          "did": {
+            "title": "Participant DID",
+            "description": "Decentralised Identifier for this party - the primary way to identify them. Unlike participantId it is global and stable: the same person carries the same DID across transactions, and across two entries in one transaction where they are both buying and selling. Minted when the party is created, so it should always be present.",
+            "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})+$"
+          },
+          "participantId": {
+            "title": "Participant id",
+            "description": "Transaction-local identifier for this participant, for implementations that do not mint DIDs. Prefer did. Referencing by array position is unsafe because participants may be added or removed.",
+            "type": "string",
+            "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+          }
+        },
+        "required": [
+          "participant"
+        ]
+      }
+    },
+    "saleContext": {
+      "title": "Sale Context",
+      "description": "Residual ownership/sale facts that apply at the transaction level (e.g. outstanding mortgage, Help to Buy equity loan status).",
+      "type": "object",
+      "properties": {
+        "numberOfSellers": {
+          "title": "How many sellers are involved in the transaction?",
+          "description": "This may differ from the number of legal owners, for example if the property is being sold by executors of a deceased owner",
+          "type": "integer"
+        },
+        "numberOfNonUkResidentSellers": {
+          "title": "How many sellers are involved in the transaction who are resident outside the UK?",
+          "description": "This may differ from the number of legal owners, for example if the property is being sold by executors of a deceased owner",
+          "type": "integer"
+        },
+        "outstandingMortgage": {
+          "title": "Are there any outstanding mortgages on the property?",
+          "type": "string",
+          "enum": [
+            "Yes",
+            "No"
+          ]
+        },
+        "existingLender": {
+          "title": "What is the name of the existing lender?",
+          "type": "string"
+        },
+        "hasHelpToBuyEquityLoan": {
+          "title": "Is the property being sold with a Help to Buy equity loan outstanding?",
+          "type": "string",
+          "enum": [
+            "Yes",
+            "No"
+          ]
+        },
+        "isFirstRegistration": {
+          "title": "Is this the first time the property is to be registered with HMLR?",
+          "type": "string",
+          "enum": [
+            "Yes",
+            "No"
+          ]
+        },
+        "isLimitedCompanySale": {
+          "title": "Is the property being sold by a Limited Company?",
+          "type": "string",
+          "enum": [
+            "Yes",
+            "No"
+          ]
+        },
+        "legalOwners": {
+          "title": "Legal Owners",
+          "type": "object",
+          "properties": {
+            "namesOfLegalOwners": {
+              "title": "Names of all legal owners",
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "title": "Legal owner",
+                "type": "object",
+                "properties": {
+                  "ownerType": {
+                    "type": "string",
+                    "title": "Type of owner",
+                    "enum": [
+                      "Private individual",
+                      "Organisation"
+                    ]
+                  }
+                },
+                "discriminator": {
+                  "propertyName": "ownerType"
+                },
+                "oneOf": [
+                  {
+                    "properties": {
+                      "ownerType": {
+                        "enum": [
+                          "Private individual"
+                        ]
+                      },
+                      "firstName": {
+                        "title": "First name",
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "middleNames": {
+                        "title": "Middle names",
+                        "type": "string"
+                      },
+                      "lastName": {
+                        "title": "Last name",
+                        "type": "string",
+                        "minLength": 1
+                      }
+                    }
+                  },
+                  {
+                    "properties": {
+                      "ownerType": {
+                        "enum": [
+                          "Organisation"
+                        ]
+                      },
+                      "organisationName": {
+                        "title": "Organisation name",
+                        "type": "string",
+                        "minLength": 1
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}