@lendi/act-credit-decisions-transform 1.9.0

package/lib/schemas/public-asset-event.json

@@ -0,0 +1,679 @@
+{
+  "definitions": {
+    "payload": {
+      "type": "object",
+      "$ref": "#/definitions/createAssetDefinition"
+    },
+    "id": {
+      "type": "string"
+    },
+    "meta": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The metadata of the alieo",
+      "properties": {
+        "actionedBy": {
+          "description": "uuid of user who made the action (create/update/delete)",
+          "type": "string"
+        },
+        "actionedByRole": {
+          "description": "role of the user that made the action",
+          "enum": ["team", "customer"]
+        }
+      },
+      "required": ["actionedBy", "actionedByRole"]
+    },
+    "applicantOwnership": {
+      "type": "object",
+      "required": ["applicantId", "percent"],
+      "properties": {
+        "applicantId": {
+          "type": "string",
+          "description": "The applicant Identifier"
+        },
+        "customerId": {
+          "type": "string"
+        },
+        "percent": {
+          "type": "number",
+          "description": "how much percent for the corresponding applicant",
+          "examples": [0.5]
+        }
+      }
+    },
+    "percentOwned": {
+      "type": "object",
+      "required": ["owners"],
+      "properties": {
+        "proportions": {
+          "enum": ["EQUAL", "SPECIFIED", "NOT_SPECIFIED"],
+          "description": "Indicate whether ownership proportions are equal, specified individually for each one or not specified."
+        },
+        "owners": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/applicantOwnership"
+          }
+        }
+      }
+    },
+    "make": {
+      "type": "string",
+      "description": "Make of the vehicle"
+    },
+    "model": {
+      "type": "string",
+      "description": "Model of the vehicle."
+    },
+    "year": {
+      "type": "number",
+      "description": "Year the vehicle was made."
+    },
+    "estimatedValue": {
+      "type": "number",
+      "description": "Estimated value of a given asset/liability."
+    },
+    "toBeUsedAsSecurity": {
+      "type": "boolean"
+    },
+    "toBePurchased": {
+      "type": "boolean"
+    },
+    "contractPriceAmount": {
+      "type": "number",
+      "description": "Price of contract."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the entity."
+    },
+    "address": {
+      "type": "object",
+      "properties": {
+        "postcode": {
+          "description": "A 4 digit postcode",
+          "type": "string"
+        },
+        "state": {
+          "description": "One our great nation's states",
+          "type": "string"
+        },
+        "city": {
+          "description": "The suburb name",
+          "type": "string"
+        },
+        "country": {
+          "$ref": "#/definitions/countries"
+        },
+        "formatted": {
+          "description": "A formatted version of the address",
+          "type": "string"
+        },
+        "standard": {
+          "$ref": "#/definitions/addressStandard"
+        }
+      }
+    },
+    "countries": {
+      "type": "string",
+      "example": "Australia",
+      "enum": [
+        "Afghanistan",
+        "Albania",
+        "Algeria",
+        "American Samoa",
+        "Andorra",
+        "Angola",
+        "Anguilla",
+        "Antarctica",
+        "Antigua And Barbuda",
+        "Argentina",
+        "Armenia",
+        "Aruba",
+        "Australia",
+        "Austria",
+        "Azerbaijan",
+        "Bahamas",
+        "Bahrain",
+        "Bangladesh",
+        "Barbados",
+        "Belarus",
+        "Belgium",
+        "Belize",
+        "Benin",
+        "Bermuda",
+        "Bhutan",
+        "Bolivia",
+        "Bosnia And Herzegovina",
+        "Botswana",
+        "Bouvet Island",
+        "Brazil",
+        "British Indian Ocean Territory",
+        "Brunei Darussalam",
+        "Bulgaria",
+        "Burkina Faso",
+        "Burundi",
+        "Cambodia",
+        "Cameroon",
+        "Canada",
+        "Cape Verde",
+        "Cayman Islands",
+        "Central African Republic",
+        "Chad",
+        "Chile",
+        "China",
+        "Christmas Island",
+        "Cocos (Keeling) Islands",
+        "Colombia",
+        "Comoros",
+        "Democratic People's Republic of Korea",
+        "Democratic Republic Of The Congo",
+        "Cook Islands",
+        "Costa Rica",
+        "Cote D'ivoire",
+        "Croatia",
+        "Cuba",
+        "Cyprus",
+        "Czech Republic",
+        "Denmark",
+        "Djibouti",
+        "Dominica",
+        "Dominican Republic",
+        "East Timor",
+        "Ecuador",
+        "Egypt",
+        "El Salvador",
+        "Equatorial Guinea",
+        "Eritrea",
+        "Estonia",
+        "Ethiopia",
+        "Falkland Islands",
+        "Faroe Islands",
+        "Fiji",
+        "Finland",
+        "France",
+        "French Guiana",
+        "French Polynesia",
+        "French Southern Territories",
+        "Gabon",
+        "Gambia",
+        "Georgia",
+        "Germany",
+        "Ghana",
+        "Gibraltar",
+        "Greece",
+        "Greenland",
+        "Grenada",
+        "Guadeloupe",
+        "Guam",
+        "Guatemala",
+        "Guinea",
+        "Guinea-bissau",
+        "Guyana",
+        "Haiti",
+        "Heard Island And Mcdonald Islands",
+        "Holy See (Vatican City State)",
+        "Honduras",
+        "Hong Kong",
+        "Hungary",
+        "Iceland",
+        "India",
+        "Indonesia",
+        "Iran",
+        "Iraq",
+        "Ireland",
+        "Israel",
+        "Italy",
+        "Jamaica",
+        "Japan",
+        "Jordan",
+        "Kazakstan",
+        "Kenya",
+        "Kiribati",
+        "Kosovo",
+        "Kuwait",
+        "Kyrgyzstan",
+        "Laos",
+        "Latvia",
+        "Lebanon",
+        "Lesotho",
+        "Liberia",
+        "Libyan Arab Jamahiriya",
+        "Liechtenstein",
+        "Lithuania",
+        "Luxembourg",
+        "Macau",
+        "Macedonia",
+        "Madagascar",
+        "Malawi",
+        "Malaysia",
+        "Maldives",
+        "Mali",
+        "Malta",
+        "Marshall Islands",
+        "Martinique",
+        "Mauritania",
+        "Mauritius",
+        "Mayotte",
+        "Mexico",
+        "Federated States Of Micronesia",
+        "Republic Of Moldova",
+        "Monaco",
+        "Mongolia",
+        "Montserrat",
+        "Montenegro",
+        "Morocco",
+        "Mozambique",
+        "Myanmar",
+        "Namibia",
+        "Nauru",
+        "Nepal",
+        "Netherlands",
+        "Netherlands Antilles",
+        "New Caledonia",
+        "New Zealand",
+        "Nicaragua",
+        "Niger",
+        "Nigeria",
+        "Niue",
+        "Norfolk Island",
+        "Northern Mariana Islands",
+        "Norway",
+        "Oman",
+        "Pakistan",
+        "Palau",
+        "Palestinian Territory",
+        "Panama",
+        "Papua New Guinea",
+        "Paraguay",
+        "Peru",
+        "Philippines",
+        "Pitcairn",
+        "Poland",
+        "Portugal",
+        "Puerto Rico",
+        "Qatar",
+        "Romania",
+        "Russian Federation",
+        "Rwanda",
+        "Saint Helena",
+        "Saint Kitts And Nevis",
+        "Saint Lucia",
+        "Saint Pierre And Miquelon",
+        "Saint Vincent And The Grenadines",
+        "Samoa",
+        "San Marino",
+        "Sao Tome And Principe",
+        "Saudi Arabia",
+        "Senegal",
+        "Serbia",
+        "Seychelles",
+        "Sierra Leone",
+        "Singapore",
+        "Slovakia",
+        "Slovenia",
+        "Solomon Islands",
+        "Somalia",
+        "South Africa",
+        "South Georgia And The South Sandwich Islands",
+        "The Republic of South Korea",
+        "Spain",
+        "Sri Lanka",
+        "Sudan",
+        "Suriname",
+        "Svalbard And Jan Mayen",
+        "Swaziland",
+        "Sweden",
+        "Switzerland",
+        "Syrian Arab Republic",
+        "Taiwan",
+        "Tajikistan",
+        "Tanzania",
+        "Thailand",
+        "Togo",
+        "Tokelau",
+        "Tonga",
+        "Trinidad And Tobago",
+        "Tunisia",
+        "Turkey",
+        "Turkmenistan",
+        "Turks And Caicos Islands",
+        "Tuvalu",
+        "Uganda",
+        "Ukraine",
+        "United Arab Emirates",
+        "United Kingdom",
+        "United States of America",
+        "United States Minor Outlying Islands",
+        "Uruguay",
+        "Uzbekistan",
+        "Vanuatu",
+        "Venezuela",
+        "Vietnam",
+        "British Virgin Islands",
+        "US Virgin Islands",
+        "Wallis And Futuna",
+        "Western Sahara",
+        "Yemen",
+        "Zambia",
+        "Zimbabwe"
+      ]
+    },
+    "addressStandard": {
+      "type": "object",
+      "properties": {
+        "buildingName": {
+          "description": "The building name",
+          "type": "string"
+        },
+        "level": {
+          "description": "The level of the unit/apartment",
+          "type": "string"
+        },
+        "lotSection": {
+          "description": "The lot number",
+          "type": "string"
+        },
+        "streetName": {
+          "description": "The street name",
+          "type": "string"
+        },
+        "streetNumber": {
+          "description": "The street number",
+          "type": "string"
+        },
+        "streetType": {
+          "description": "The type of the street i.e. road",
+          "type": "string"
+        },
+        "unit": {
+          "description": "The unit number",
+          "type": "string"
+        }
+      }
+    },
+    "primaryPurpose": {
+      "enum": ["INVESTMENT", "OWNER_OCCUPIED"]
+    },
+    "propertyStatus": {
+      "enum": ["ESTABLISHED", "NEW_BUILDING", "OFF_THE_PLAN", "VACANT_LAND"]
+    },
+    "zoneType": {
+      "enum": ["COMMERCIAL", "INDUSTRIAL", "RESIDENTIAL", "RURAL"]
+    },
+    "propertyType": {
+      "enum": [
+        "APARTMENT_UNIT_LESS_THAN_50M2",
+        "APARTMENT_UNIT_MORE_THAN_50M2",
+        "DUPLEX",
+        "FULLY_DETACHED_HOUSE",
+        "KIT_HOME",
+        "LAND",
+        "MULTI_DWELLING_SINGLE_TITLE",
+        "PROPERTY_OVER_10_HA",
+        "SEMI_DETACHED_HOUSE",
+        "SERVICED_APARTMENT",
+        "STUDENT_ACCOMMODATION",
+        "STUDIO",
+        "TERRACE",
+        "TOWNHOUSE",
+        "VILLA",
+        "WAREHOUSE_APARTMENT"
+      ]
+    },
+    "contractDetails": {
+      "type": "object",
+      "description": "Details of the purchase/sale price as specified in the Contract of Sale",
+      "properties": {
+        "contractDate": {
+          "type": "string",
+          "description": "The date of the Contract of Sale."
+        },
+        "estimatedSettlementDate": {
+          "type": "string",
+          "description": "The purchase date of the property, or the proposed settlement date for a property being purchased or sold"
+        },
+        "contractPriceAmount": {
+          "type": "number",
+          "description": "Captures the total purchase/sale price as specified in the Contract of Sale."
+        }
+      }
+    },
+    "constructionDetails": {
+      "type": "object",
+      "properties": {
+        "constructionType": {
+          "type": "string",
+          "enum": ["STRUCTURAL_RENOVATIONS", "BUILD_A_PROPERTY", "KNOCKDOWN_REBUILD"]
+        },
+        "buildPriceAmount": {
+          "type": "number"
+        },
+        "buildIn6Months": {
+          "description": "Indicates whether it should be coded as vacant land loan or a construction loan",
+          "type": "boolean"
+        },
+        "landEstimatedValue": {
+          "type": "number"
+        },
+        "otherConstructionCosts": {
+          "type": "number"
+        },
+        "builderType": {
+          "type": "string",
+          "enum": ["LICENSED_BUILDER", "OWNER_BUILDER"]
+        },
+        "isFixedPriceContract": {
+          "type": "boolean"
+        }
+      }
+    },
+    "toBeSold": {
+      "type": "boolean"
+    },
+    "knockDownToRebuild": {
+      "description": "DEPRECATED",
+      "type": "boolean"
+    },
+    "financialInstitution": {
+      "type": "string"
+    },
+    "financialInstitutionShortName": {
+      "type": "string"
+    },
+    "FinancialInstitutionBsb": {
+      "type": "string",
+      "pattern": "^\\d{6}$",
+      "description": "The BSB number identifying where the account is held within the Financial Institution",
+      "example": "123456"
+    },
+    "FinancialInstitutionAccountNumber": {
+      "type": "string",
+      "pattern": "^\\d{0,10}$",
+      "description": "The unique number assigned to the Financial Institution account",
+      "example": "999994"
+    },
+    "isConstruction": {
+      "type": "boolean"
+    },
+    "dataType": {
+      "type": "string"
+    },
+    "relationId": {
+      "$ref": "#/definitions/id",
+      "description": "uuid of relation"
+    },
+    "assetType": {
+      "enum": [
+        "GIFTS",
+        "HOME_CONTENTS",
+        "MANAGED_FUNDS",
+        "OTHER_ASSET",
+        "PROPERTY",
+        "SAVING_CHECK_ACCOUNT",
+        "SHARES",
+        "SUPERANNUATION",
+        "TERM_DEPOSIT",
+        "VEHICLE"
+      ]
+    },
+    "applicationId": {
+      "type": "string"
+    },
+    "PropertyExpenses": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["type"],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "BODY_CORPORATE_FEES_STRATA_FEES_AND_LAND_TAX",
+              "PRIMARY_RESIDENCE_RUNNING_COSTS",
+              "INVESTMENT_PROPERTY_RUNNING_COSTS",
+              "SECONDARY_RESIDENCE_RUNNING_COSTS"
+            ]
+          },
+          "amount": {
+            "type": "number",
+            "example": 100000
+          },
+          "frequency": {
+            "type": "string",
+            "enum": ["FORTNIGHTLY", "MONTHLY", "QUARTERLY", "WEEKLY", "YEARLY"]
+          },
+          "comments": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "asset": {
+      "type": "object",
+      "properties": {
+        "percentOwned": {
+          "$ref": "#/definitions/percentOwned"
+        },
+        "description": {
+          "type": "string"
+        },
+        "dataType": {
+          "$ref": "#/definitions/dataType"
+        },
+        "type": {
+          "$ref": "#/definitions/assetType"
+        },
+        "estimatedValue": {
+          "$ref": "#/definitions/estimatedValue"
+        },
+        "financialInstitution": {
+          "$ref": "#/definitions/financialInstitution"
+        },
+        "financialInstitutionShortName": {
+          "$ref": "#/definitions/financialInstitutionShortName"
+        },
+        "financialInstitutionBsb": {
+          "$ref": "#/definitions/FinancialInstitutionBsb"
+        },
+        "financialInstitutionAccountNumber": {
+          "$ref": "#/definitions/FinancialInstitutionAccountNumber"
+        },
+        "toBeSold": {
+          "$ref": "#/definitions/toBeSold"
+        },
+        "knockDownToRebuild": {
+          "$ref": "#/definitions/knockDownToRebuild"
+        },
+        "toBeUsedAsSecurity": {
+          "$ref": "#/definitions/toBeUsedAsSecurity"
+        },
+        "toBePurchased": {
+          "$ref": "#/definitions/toBePurchased"
+        },
+        "contractPriceAmount": {
+          "$ref": "#/definitions/contractPriceAmount"
+        },
+        "address": {
+          "$ref": "#/definitions/address"
+        },
+        "primaryPurpose": {
+          "$ref": "#/definitions/primaryPurpose"
+        },
+        "propertyStatus": {
+          "$ref": "#/definitions/propertyStatus"
+        },
+        "zoneType": {
+          "$ref": "#/definitions/zoneType"
+        },
+        "propertyType": {
+          "$ref": "#/definitions/propertyType"
+        },
+        "relationId": {
+          "$ref": "#/definitions/relationId"
+        },
+        "contractDetails": {
+          "$ref": "#/definitions/contractDetails"
+        },
+        "constructionDetails": {
+          "$ref": "#/definitions/constructionDetails"
+        },
+        "isConstruction": {
+          "$ref": "#/definitions/isConstruction"
+        },
+        "make": {
+          "$ref": "#/definitions/make"
+        },
+        "model": {
+          "$ref": "#/definitions/model"
+        },
+        "year": {
+          "$ref": "#/definitions/year"
+        },
+        "propertyExpenses": {
+          "$ref": "#/definitions/PropertyExpenses"
+        }
+      },
+      "additionalProperties": true,
+      "required": ["type"]
+    },
+    "createAssetDefinition": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of asset"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/applicationId"
+        },
+        "asset": {
+          "$ref": "#/definitions/asset"
+        }
+      },
+      "required": ["id", "applicationId", "asset"],
+      "description": "create Asset payload"
+    }
+  },
+  "type": "object",
+  "title": "The asset event schema",
+  "description": "Create or update",
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["AssetUpdated", "AssetCreated"],
+      "description": "schema version"
+    },
+    "version": {
+      "type": "string"
+    },
+    "payload": {
+      "$ref": "#/definitions/payload"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}