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

package/src/schemas/v4/Person.json

@@ -0,0 +1,321 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://trust.propdata.org.uk/schemas/v4/entities/person.json",
+  "type": "object",
+  "title": "Person Entity",
+  "description": "A natural person participating in a property transaction — name, contact details, address, verification status.",
+  "x-pdtf-source": {
+    "packageName": "@pdtf/schemas",
+    "packageVersion": "3.6.0-dev.30",
+    "v3SchemaId": "https://trust.propdata.org.uk/schemas/v3/pdtf-transaction.json",
+    "combinedPath": "src/schemas/v3/combined.json",
+    "combinedSha256": "4e95946a946b37088b153052034fd0584cc27a6eb53f78ede52cd0ab1fde669f"
+  },
+  "properties": {
+    "name": {
+      "title": "Name",
+      "type": "object",
+      "properties": {
+        "title": {
+          "title": "Title or honorific",
+          "type": "string",
+          "enum": [
+            "Mr",
+            "Mrs",
+            "Miss",
+            "Ms",
+            "Mx",
+            "Dr"
+          ]
+        },
+        "firstName": {
+          "title": "First name",
+          "type": "string",
+          "minLength": 1
+        },
+        "middleName": {
+          "title": "Middle name(s)",
+          "type": "string"
+        },
+        "lastName": {
+          "title": "lastName",
+          "type": "string",
+          "minLength": 1
+        },
+        "maidenName": {
+          "title": "Middle name(s)",
+          "type": "string"
+        },
+        "preferredName": {
+          "title": "Preferred name / known as",
+          "type": "string"
+        }
+      }
+    },
+    "dateOfBirth": {
+      "title": "Date of birth",
+      "type": "string",
+      "format": "date"
+    },
+    "phone": {
+      "title": "Phone number",
+      "type": "string"
+    },
+    "email": {
+      "title": "Email address",
+      "type": "string",
+      "format": "email"
+    },
+    "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"
+        },
+        "line3": {
+          "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"
+          ]
+        },
+        "countryCode": {
+          "title": "Country code",
+          "description": "ISO 3166-1 alpha-3 country code",
+          "type": "string",
+          "minLength": 3,
+          "maxLength": 3
+        }
+      }
+    },
+    "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})+$"
+    },
+    "externalIds": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "patternProperties": {
+                ".*": {}
+              }
+            }
+          ]
+        }
+      }
+    },
+    "participantStatus": {
+      "type": "string",
+      "enum": [
+        "Proposed",
+        "Invited",
+        "Active",
+        "Removed"
+      ]
+    },
+    "verification": {
+      "type": "object",
+      "properties": {
+        "identity": {
+          "type": "object",
+          "properties": {
+            "status": {
+              "type": "string",
+              "enum": [
+                "Requested",
+                "In progress",
+                "User tasks complete",
+                "Report available",
+                "Complete",
+                "Cancelled"
+              ]
+            },
+            "result": {
+              "type": "string",
+              "enum": [
+                "pass",
+                "fail",
+                "consider"
+              ]
+            },
+            "reports": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "reportName": {
+                    "type": "string"
+                  },
+                  "result": {
+                    "type": "string",
+                    "enum": [
+                      "pass",
+                      "fail",
+                      "consider"
+                    ]
+                  },
+                  "details": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "antiMoneyLaundering": {
+          "type": "object",
+          "properties": {
+            "status": {
+              "type": "string",
+              "enum": [
+                "Requested",
+                "In progress",
+                "User tasks complete",
+                "Report available",
+                "Complete",
+                "Cancelled"
+              ]
+            },
+            "result": {
+              "type": "string",
+              "enum": [
+                "pass",
+                "fail",
+                "consider"
+              ]
+            },
+            "reports": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "reportName": {
+                    "type": "string"
+                  },
+                  "result": {
+                    "type": "string",
+                    "enum": [
+                      "pass",
+                      "fail",
+                      "consider"
+                    ]
+                  },
+                  "details": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "sourceOfFunds": {
+          "type": "object",
+          "properties": {
+            "status": {
+              "type": "string",
+              "enum": [
+                "Requested",
+                "In progress",
+                "User tasks complete",
+                "Report available",
+                "Complete",
+                "Cancelled"
+              ]
+            },
+            "result": {
+              "type": "string",
+              "enum": [
+                "pass",
+                "fail",
+                "consider"
+              ]
+            },
+            "reports": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "reportName": {
+                    "type": "string"
+                  },
+                  "result": {
+                    "type": "string",
+                    "enum": [
+                      "pass",
+                      "fail",
+                      "consider"
+                    ]
+                  },
+                  "details": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "id": {
+      "title": "Person DID",
+      "description": "Decentralised Identifier for the person",
+      "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})+$"
+    }
+  }
+}