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

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 giftor. Implies the Giftor role.",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.32",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "83f31fddf82e57e67f2bc92844459095041b254b970d8881dd4318248c188f67"
+  },
+  "properties": {
+    "id": {
+      "title": "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 giftor 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,425 @@
+{
+  "$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.32",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "83f31fddf82e57e67f2bc92844459095041b254b970d8881dd4318248c188f67"
+  },
+  "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",
+          "description": "The primary purpose of the purchase: whether the buyer will live at the property as their main home, and if not, on what basis it is held. Other circumstances are recorded in the separate fields below and are never values of this field. A home-worker is \"Owner occupied\" with intendsBusiness true. A property bought for a relative to live in is \"Second home\" (no rent) or \"Buy-to-let\" (rent paid), with occupiedByFamilyMember true. A purchase to renovate and sell is \"Second home\" with intendsAlterations and intendsResale true.",
+          "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)"
+        },
+        "dependentOnSale": {
+          "type": "boolean",
+          "title": "Buyer needs to sell a property to proceed",
+          "description": "Whether the buyer's purchase depends on the sale of another property, i.e. the buyer's side of the chain. False positively records that it does not, for example a first-time buyer or a buyer who has already sold; absent means the buyer's position is not known. Owning another property is not the same thing: see isAdditionalProperty. The property or properties being sold are recorded in chain.buyersSale."
+        },
+        "hasPets": {
+          "type": "boolean",
+          "title": "Buyer has pets",
+          "description": "Relevant to lease and covenant pet restriction assessment"
+        },
+        "petDetails": {
+          "type": "string",
+          "title": "Pets or other animals",
+          "description": "The pets, horses or other animals the buyer intends to keep at the property, and how many (e.g. \"2 dogs, 1 cat\")"
+        },
+        "occupiedByFamilyMember": {
+          "type": "boolean",
+          "title": "Occupied by a member of the buyer's family",
+          "description": "Whether a member of the buyer's family, rather than the buyer, will live at the property. Recorded with intendedUse \"Second home\" when no rent is paid, or \"Buy-to-let\" when it is. Relevant to lender acceptability, occupancy and tax 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"
+        },
+        "businessUseType": {
+          "type": "string",
+          "title": "Extent of intended business use",
+          "description": "How the business use recorded in intendsBusiness will affect the property: working from home with no visitors, clients or staff visiting, or using the property or part of it as business premises such as a shop, office or surgery. For a mixed-use purchase, intendedUse records the residential occupation and this field records the business part. Relevant to use covenants, lease restrictions and planning use class",
+          "enum": [
+            "Working from home",
+            "Clients or staff visit",
+            "Business premises"
+          ]
+        },
+        "intendsAlterations": {
+          "type": "boolean",
+          "title": "Buyer intends significant alterations",
+          "description": "Relevant to covenant, planning and building regulations assessment"
+        },
+        "alterationDescription": {
+          "type": "string",
+          "title": "Planned alterations",
+          "description": "What the buyer intends to alter, extend or develop"
+        },
+        "intendsResale": {
+          "type": "boolean",
+          "title": "Buyer intends to sell after works",
+          "description": "Whether the buyer intends to sell the property, or parts of it, once planned works are complete, rather than live in it or let it. Relevant to covenant, planning, lender and tax assessment"
+        },
+        "vehicleRequirements": {
+          "type": "string",
+          "title": "Vehicles to keep at the property",
+          "description": "Any caravan, motorhome, commercial vehicle or boat the buyer intends to keep at the property. Relevant to parking and use covenants"
+        },
+        "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"
+  ]
+}

package/src/schemas/v4/Organisation.json

@@ -0,0 +1,167 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/organisation.json",
+  "type": "object",
+  "title": "Organisation Entity",
+  "description": "A legal entity (company, firm, partnership) participating in a property transaction.",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.32",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "83f31fddf82e57e67f2bc92844459095041b254b970d8881dd4318248c188f67"
+  },
+  "properties": {
+    "id": {
+      "title": "Organisation DID",
+      "description": "Decentralised Identifier for the organisation",
+      "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})+$"
+    },
+    "name": {
+      "title": "Organisation name",
+      "description": "The legal / registered name of the organisation",
+      "type": "string",
+      "minLength": 1
+    },
+    "tradingName": {
+      "title": "Trading name",
+      "description": "Trading name, if different from the registered legal name",
+      "type": "string"
+    },
+    "organisationType": {
+      "title": "Organisation type",
+      "type": "string",
+      "enum": [
+        "Limited Company",
+        "Limited Liability Partnership",
+        "Partnership",
+        "Sole Trader",
+        "Public Limited Company",
+        "Charity",
+        "Public Body",
+        "Trust",
+        "Other"
+      ]
+    },
+    "companiesHouseNumber": {
+      "title": "Companies House registration number",
+      "description": "UK Companies House company registration number (or equivalent)",
+      "type": "string"
+    },
+    "vatNumber": {
+      "title": "VAT registration number",
+      "type": "string"
+    },
+    "regulatoryIds": {
+      "title": "Regulatory identifiers",
+      "description": "Identifiers for the professional / regulatory bodies the organisation is registered with",
+      "type": "object",
+      "properties": {
+        "sraNumber": {
+          "title": "Solicitors Regulation Authority (SRA) number",
+          "type": "string"
+        },
+        "clcNumber": {
+          "title": "Council for Licensed Conveyancers (CLC) number",
+          "type": "string"
+        },
+        "ricsNumber": {
+          "title": "Royal Institution of Chartered Surveyors (RICS) number",
+          "type": "string"
+        },
+        "fcaNumber": {
+          "title": "Financial Conduct Authority (FCA) reference number",
+          "type": "string"
+        },
+        "tpoNumber": {
+          "title": "The Property Ombudsman (TPO) membership number",
+          "type": "string"
+        },
+        "icoNumber": {
+          "title": "Information Commissioner's Office (ICO) registration number",
+          "type": "string"
+        }
+      }
+    },
+    "registeredAddress": {
+      "title": "Registered address",
+      "type": "object",
+      "properties": {
+        "buildingNumber": {
+          "title": "Building number",
+          "type": "string"
+        },
+        "buildingName": {
+          "title": "Building name",
+          "type": "string"
+        },
+        "subBuilding": {
+          "title": "Sub building name",
+          "type": "string"
+        },
+        "street": {
+          "title": "Street",
+          "type": "string"
+        },
+        "line1": {
+          "title": "Address 1",
+          "type": "string"
+        },
+        "line2": {
+          "title": "Address 2",
+          "type": "string"
+        },
+        "line3": {
+          "title": "Address 3",
+          "type": "string"
+        },
+        "town": {
+          "title": "Town",
+          "type": "string"
+        },
+        "postcode": {
+          "title": "Postcode",
+          "type": "string"
+        },
+        "homeNation": {
+          "title": "Home nation",
+          "type": "string",
+          "enum": [
+            "England",
+            "Wales",
+            "Scotland",
+            "Northern Ireland"
+          ]
+        },
+        "countryCode": {
+          "title": "Country code",
+          "description": "ISO 3166-1 alpha-3 country code",
+          "type": "string",
+          "minLength": 3,
+          "maxLength": 3
+        }
+      }
+    },
+    "phone": {
+      "title": "Primary phone number",
+      "type": "string"
+    },
+    "email": {
+      "title": "Primary email address",
+      "type": "string",
+      "format": "email"
+    },
+    "website": {
+      "title": "Website",
+      "type": "string",
+      "format": "uri"
+    },
+    "externalIds": {
+      "type": "object"
+    }
+  },
+  "required": [
+    "name"
+  ]
+}