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

package/src/schemas/v3/combined.json

@@ -243,6 +243,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": {
             "ta6ed6Ref": "1",
             "ta6ed6v2Ref": "1",
@@ -1287,6 +1310,12 @@
             "baspi4Required": ["mediaUrl"],
             "baspi5Required": ["mediaUrl"],
             "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",
@@ -33424,6 +33453,12 @@
                 "type": "object",
                 "required": ["name", "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": {
                     "sr24Ref": "1.3.1",
                     "title": "Name of signatory",
@@ -46096,6 +46131,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",
@@ -46182,6 +46223,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",
@@ -46243,6 +46290,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": {
@@ -48968,6 +49021,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": ["template", "terms"],
@@ -49048,6 +49107,12 @@
               "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"
                 },
@@ -49495,6 +49560,56 @@
                 }
               }
             },
+            "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",
@@ -49545,6 +49660,52 @@
                   "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": {
@@ -49668,7 +49829,13 @@
                     },
                     "nominatedLender": {
                       "type": "string",
-                      "title": "Nominated lender"
+                      "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"
                     }
                   }
                 }

package/src/schemas/v3/compactSkeleton.txt

@@ -26,6 +26,9 @@
       countryCode
     organisation
     organisationReference
+    did
+    participantId
+    actingFor[]
     role
     externalIds{*}
     participantStatus
@@ -125,6 +128,7 @@
     summaryDescription
     marketingTenure
     media[
+      mediaId
       mediaType
       mediaUrl
       caption
@@ -2712,6 +2716,7 @@
       authorisedToActOnBehalfOfAllSellers
       authorisationToShare
       sellerSignatures[
+        signatureId
         name
         signedOn
         externalIds{*}
@@ -3670,6 +3675,7 @@
       covenantAnalysis
     ]
     searches[
+      searchId
       displayName
       productCode
       providerName
@@ -3681,6 +3687,7 @@
       reportDate
     ]
     documents[
+      documentId
       displayName
       fileName
       mimeType
@@ -3690,6 +3697,7 @@
       summary
     ]
     surveys[
+      surveyId
       outside
         chimneyStacks
           condition
@@ -4430,6 +4438,7 @@
         credibilitySources[]
         pricingMethodology
   contracts[
+    contractId
     contract
       template
         name
@@ -4441,6 +4450,7 @@
         ]
       terms
     signatures[
+      signatureId
       name
       signedOn
       externalIds{*}
@@ -4495,6 +4505,7 @@
     exclusions[]
     conditions[]
     externalIds{*}
+    metadata{*}
     buyerCircumstances
       intendedUse
       firstTimeBuyer
@@ -4505,6 +4516,14 @@
       giftedEquity
       numberOfGiftedDeposits
       requiresMortgage
+      isAdditionalProperty
+      hasPets
+      intendsSublet
+      subletType
+      intendsBusiness
+      businessType
+      intendsAlterations
+      financingMethod
       helpToBuyEquityLoan
       armedForcesHelpToBuy
       numberOfHelpToBuyIsas
@@ -4524,6 +4543,7 @@
       annualIncome
       residencyStatus
       nominatedLender
+      nominatedLenderHandbookId
   enquiries{*}
     subject
     status

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"
                 },
@@ -41522,6 +41587,56 @@
                 }
               }
             },
+            "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",
@@ -41575,6 +41690,59 @@
                     "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"
+                  ]
                 }
               },
               "required": [
@@ -41708,7 +41876,13 @@
                     },
                     "nominatedLender": {
                       "type": "string",
-                      "title": "Nominated lender"
+                      "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"
                     }
                   }
                 }