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

package/src/schemas/v3/pdtf-transaction.json

@@ -233,6 +233,29 @@
             "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._:+-]*$"
+          },
+          "actingFor": {
+            "title": "Acting for",
+            "description": "The parties this participant is instructed by, for example the sellers a conveyancer acts for, identified by their did or - where no DID is minted - their participantId. One entry per represented party: a conveyancer instructed jointly by two sellers lists both, and sellers who instruct separate conveyancers appear as separate representatives each acting for one of them. A conveyancer is instructed by a person, not by an offer - the offer link is participants[].offerId.",
+            "type": "array",
+            "items": {
+              "title": "Represented party",
+              "description": "did, or participantId, of a party this participant is instructed by",
+              "type": "string",
+              "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+            }
+          },
           "role": {
             "title": "Role",
             "type": "string",
@@ -950,6 +973,12 @@
           "items": {
             "type": "object",
             "properties": {
+              "mediaId": {
+                "title": "Media id",
+                "description": "Stable identifier for this media item within the transaction. Array position is not a safe reference: media is added, removed and re-ordered independently by different parties.",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
               "mediaType": {
                 "title": "Type of media",
                 "type": "string",
@@ -25972,6 +26001,12 @@
                   "signedOn"
                 ],
                 "properties": {
+                  "signatureId": {
+                    "title": "Signature id",
+                    "description": "Stable identifier for this signature within the transaction. 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": {
                     "title": "Name of signatory",
                     "type": "string",
@@ -38082,6 +38117,12 @@
           "items": {
             "type": "object",
             "properties": {
+              "searchId": {
+                "title": "Search id",
+                "description": "Stable identifier for this search within the transaction. Array position is not a safe reference: searches are ordered and updated independently by different parties.",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
               "displayName": {
                 "title": "Human-readable name of instructed search product",
                 "type": "string",
@@ -38172,6 +38213,12 @@
           "items": {
             "type": "object",
             "properties": {
+              "documentId": {
+                "title": "Document id",
+                "description": "Stable identifier for this document within the transaction. Array position is not a safe reference: documents are added, removed and re-ordered independently by different parties.",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
               "displayName": {
                 "title": "Human-readable name of document",
                 "type": "string",
@@ -38233,6 +38280,12 @@
           "items": {
             "type": "object",
             "properties": {
+              "surveyId": {
+                "title": "Survey id",
+                "description": "Stable identifier for this survey within the transaction. Array position is not a safe reference: a property may be surveyed more than once, by different parties.",
+                "type": "string",
+                "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
+              },
               "outside": {
                 "type": "object",
                 "properties": {
@@ -40973,6 +41026,12 @@
       "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": [
@@ -41065,6 +41124,12 @@
                 "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"
                 },

package/src/schemas/v3/skeleton.json

@@ -40,6 +40,11 @@
       },
       "organisation": "string",
       "organisationReference": "string",
+      "did": "string",
+      "participantId": "string",
+      "actingFor": [
+        "string"
+      ],
       "role": "variant",
       "externalIds": {
         "*": {
@@ -164,6 +169,7 @@
     "marketingTenure": "string",
     "media": [
       {
+        "mediaId": "string",
         "mediaType": "string",
         "mediaUrl": "string",
         "caption": "string"
@@ -3460,6 +3466,7 @@
       "authorisationToShare": "boolean",
       "sellerSignatures": [
         {
+          "signatureId": "string",
           "name": "string",
           "signedOn": "string",
           "externalIds": {
@@ -4763,6 +4770,7 @@
     ],
     "searches": [
       {
+        "searchId": "string",
         "displayName": "string",
         "productCode": "string",
         "providerName": "string",
@@ -4778,6 +4786,7 @@
     ],
     "documents": [
       {
+        "documentId": "string",
         "displayName": "string",
         "fileName": "string",
         "mimeType": "string",
@@ -4793,6 +4802,7 @@
     ],
     "surveys": [
       {
+        "surveyId": "string",
         "outside": {
           "chimneyStacks": {
             "condition": "string",
@@ -5642,6 +5652,7 @@
   },
   "contracts": [
     {
+      "contractId": "string",
       "contract": {
         "template": {
           "name": "string",
@@ -5662,6 +5673,7 @@
       },
       "signatures": [
         {
+          "signatureId": "string",
           "name": "string",
           "signedOn": "string",
           "externalIds": {

package/src/schemas/v4/Gift.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/gift.json",
+  "type": "object",
+  "title": "Gift Entity",
+  "description": "A gift of funds towards a purchase, made by a gift donor. Implies the Gift Donor role.",
+  "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": {
+    "id": {
+      "title": "Gift URN",
+      "description": "Uniform Resource Name identifier for the gift",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "donor": {
+      "title": "Donor Reference",
+      "description": "DID referencing the Person or Organisation making the gift",
+      "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})+$"
+    },
+    "offerId": {
+      "title": "Offer id",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$",
+      "description": "The offer this gift is contributing towards, as keyed in Transaction.offers. Held here rather than on Offer so that an Offer credential always implies the Buyer role."
+    },
+    "giftDetails": {
+      "title": "Details of the gift being made towards the purchase",
+      "description": "The terms on which a gift donor is contributing funds. These are the questions a conveyancer must resolve before reporting to a lender: whether the money is truly a gift rather than a loan, and whether the donor acquires any interest in or occupation of the property.",
+      "type": "object",
+      "properties": {
+        "amount": {
+          "title": "Amount being gifted",
+          "type": "number",
+          "minimum": 0
+        },
+        "currency": {
+          "title": "Currency of the gift",
+          "type": "string",
+          "default": "GBP"
+        },
+        "relationshipToBuyer": {
+          "title": "Donor's relationship to the buyer",
+          "type": "string"
+        },
+        "fundsTransferred": {
+          "title": "Whether the gift has been paid to the buyer yet",
+          "type": "string",
+          "enum": [
+            "None",
+            "Part",
+            "All"
+          ]
+        },
+        "repayable": {
+          "title": "Whether the buyer must repay the money",
+          "description": "If true the funds are a loan rather than a gift, which most lenders treat differently.",
+          "type": "boolean"
+        },
+        "confersBeneficialInterest": {
+          "title": "Whether the donor acquires an interest in the property",
+          "type": "boolean"
+        },
+        "willOccupyProperty": {
+          "title": "Whether the donor will live in the property after completion",
+          "description": "An adult occupier who is not a legal owner may be required to sign a deed of consent or waiver of rights.",
+          "type": "boolean"
+        }
+      }
+    },
+    "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": [
+    "donor",
+    "transaction"
+  ]
+}

package/src/schemas/v4/Offer.json

@@ -0,0 +1,384 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/offer.json",
+  "type": "object",
+  "title": "Offer Entity",
+  "description": "An offer made by a prospective buyer in a property transaction.",
+  "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": {
+    "id": {
+      "title": "Offer URN",
+      "description": "Uniform Resource Name identifier for the offer",
+      "type": "string",
+      "pattern": "^urn:[a-z0-9][a-z0-9-]{0,31}:[a-zA-Z0-9._~:/?#\\[\\]@!$&'()*+,;=-]+$"
+    },
+    "offerId": {
+      "title": "Offer id",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$",
+      "description": "The V3 offers object key for this offer, as referenced by participants[].offerId"
+    },
+    "buyer": {
+      "title": "Buyer Reference",
+      "description": "DID referencing the Person or Organisation making the offer",
+      "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})+$"
+    },
+    "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})+$"
+    },
+    "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"
+      }
+    },
+    "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"
+            }
+          }
+        }
+      ]
+    }
+  },
+  "required": [
+    "buyer",
+    "transaction"
+  ]
+}