@lendi/act-credit-decisions-transform 1.9.0

package/lib/schemas/public-liability-delete-event.json

@@ -0,0 +1,37 @@
+{
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["LiabilityDeleted"]
+    },
+    "payload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "applicationId": {
+          "type": "string"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "actionedBy": {
+              "type": "string"
+            },
+            "actionedByRole": {
+              "type": "string"
+            }
+          },
+          "required": ["actionedBy", "actionedByRole"]
+        }
+      },
+      "required": ["id", "applicationId"]
+    }
+  },
+  "required": ["version", "type", "payload"]
+}

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

@@ -0,0 +1,262 @@
+{
+  "definitions": {
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "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"]
+    },
+    "percentOwned": {
+      "type": "object",
+      "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"
+          }
+        }
+      },
+      "required": ["owners"]
+    },
+    "liabilityType": {
+      "description": "LEASE_OR_HIRE_FINANCE is deprecated.",
+      "enum": [
+        "CAR_LOAN",
+        "CREDIT_CARD",
+        "HELP_HECS_DEBT",
+        "HOME_LOAN",
+        "LEASE_OR_HIRE_FINANCE",
+        "LEASE",
+        "HIRE_PURCHASE",
+        "LINE_OF_CREDIT",
+        "OTHER",
+        "OVERDRAFT",
+        "PERSONAL_LOAN",
+        "SHORT_TERM_FINANCE",
+        "STORE_CARD",
+        "TAX_DEBT"
+      ]
+    },
+    "outstandingBalance": {
+      "type": "number"
+    },
+    "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"
+    },
+    "repaymentAmount": {
+      "type": "number"
+    },
+    "repaymentFrequency": {
+      "enum": ["FORTNIGHTLY", "MONTHLY", "WEEKLY", "YEARLY"]
+    },
+    "repaymentTypeDetails": {
+      "enum": ["INTEREST_ONLY", "PRINCIPAL_AND_INTEREST"]
+    },
+    "remainingTermDuration": {
+      "type": "number"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the entity."
+    },
+    "interestOnlyDuration": {
+      "type": "number"
+    },
+    "annualInterestRate": {
+      "type": "number"
+    },
+    "clearingFromThisLoan": {
+      "type": "boolean"
+    },
+    "clearingFromOtherSource": {
+      "enum": ["PAYING_OUT", "REDUCING"]
+    },
+    "creditLimit": {
+      "type": "number"
+    },
+    "newLimit": {
+      "type": "number"
+    },
+    "originalBalance": {
+      "type": "number"
+    },
+    "applicationId": {
+      "type": "string"
+    },
+    "balloonRepaymentAmount": {
+      "type": "number"
+    },
+    "interestOnlyRemainingTerm": {
+      "type": "number"
+    },
+    "interestType": {
+      "type": "string",
+      "enum": ["FIXED_RATE", "VARIABLE"]
+    },
+    "applicantOwnership": {
+      "type": "object",
+      "properties": {
+        "applicantId": {
+          "type": "string",
+          "description": "The applicant Identifier"
+        },
+        "customerId": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "percent": {
+          "type": "number",
+          "description": "how much percent for the corresponding applicant",
+          "examples": [0.5]
+        }
+      },
+      "required": ["percent", "applicantId"]
+    },
+    "liability": {
+      "type": "object",
+      "properties": {
+        "percentOwned": {
+          "$ref": "#/definitions/percentOwned"
+        },
+        "type": {
+          "$ref": "#/definitions/liabilityType"
+        },
+        "outstandingBalance": {
+          "$ref": "#/definitions/outstandingBalance"
+        },
+        "financialInstitution": {
+          "$ref": "#/definitions/financialInstitution"
+        },
+        "financialInstitutionShortName": {
+          "$ref": "#/definitions/financialInstitutionShortName"
+        },
+        "financialInstitutionBsb": {
+          "$ref": "#/definitions/FinancialInstitutionBsb"
+        },
+        "financialInstitutionAccountNumber": {
+          "$ref": "#/definitions/FinancialInstitutionAccountNumber"
+        },
+        "repaymentAmount": {
+          "$ref": "#/definitions/repaymentAmount"
+        },
+        "repaymentFrequency": {
+          "$ref": "#/definitions/repaymentFrequency"
+        },
+        "repaymentTypeDetails": {
+          "$ref": "#/definitions/repaymentTypeDetails"
+        },
+        "remainingTermDuration": {
+          "$ref": "#/definitions/remainingTermDuration"
+        },
+        "interestOnlyDuration": {
+          "$ref": "#/definitions/interestOnlyDuration"
+        },
+        "annualInterestRate": {
+          "$ref": "#/definitions/annualInterestRate"
+        },
+        "clearingFromThisLoan": {
+          "$ref": "#/definitions/clearingFromThisLoan"
+        },
+        "clearingFromOtherSource": {
+          "$ref": "#/definitions/clearingFromOtherSource"
+        },
+        "creditLimit": {
+          "$ref": "#/definitions/creditLimit"
+        },
+        "newLimit": {
+          "$ref": "#/definitions/newLimit"
+        },
+        "originalBalance": {
+          "$ref": "#/definitions/originalBalance"
+        },
+        "balloonRepaymentAmount": {
+          "$ref": "#/definitions/balloonRepaymentAmount"
+        },
+        "interestOnlyRemainingTerm": {
+          "$ref": "#/definitions/interestOnlyRemainingTerm"
+        },
+        "interestType": {
+          "$ref": "#/definitions/interestType"
+        },
+        "description": {
+          "$ref": "#/definitions/description"
+        },
+        "toBeToppedUp": {
+          "type": "boolean",
+          "description": "Is the loan (split) to be topped up"
+        }
+      },
+      "required": ["type", "outstandingBalance"]
+    },
+    "LiabilityPayload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of liability"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/applicationId"
+        },
+        "liability": {
+          "$ref": "#/definitions/liability"
+        }
+      },
+      "required": ["id", "applicationId", "liability"],
+      "description": "create / update liability payload"
+    }
+  },
+  "type": "object",
+  "title": "The liability event schema",
+  "description": "The liability event schema",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["LiabilityCreated", "LiabilityUpdated"]
+    },
+    "payload": {
+      "$ref": "#/definitions/LiabilityPayload"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}

package/lib/schemas/public-required-document-event.json

@@ -0,0 +1,366 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Required Document",
+  "description": "The Required Document event schema",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["RequiredDocumentCreated", "RequiredDocumentUpdated"]
+    },
+    "payload": {
+      "$ref": "#/definitions/payload"
+    }
+  },
+  "required": ["version", "type", "payload"],
+  "additionalProperties": true,
+  "definitions": {
+    "payload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "Required Document ID",
+          "type": "string"
+        },
+        "createdAt": {
+          "description": "Created at ISO date time",
+          "type": "string",
+          "format": "date-time"
+        },
+        "applicationId": {
+          "description": "Application ID",
+          "type": "string"
+        },
+        "applicantId": {
+          "description": "Application ID",
+          "type": "string"
+        },
+        "expiryDate": {
+          "description": "Expiry Date (can be null if no expiry date set)",
+          "type": ["string", "null"],
+          "format": "date"
+        },
+        "status": {
+          "description": "Status",
+          "type": ["string"],
+          "enum": [
+            "pending_upload",
+            "pending_verification",
+            "failed_verification",
+            "expired",
+            "not_required",
+            "verified"
+          ]
+        },
+        "eConsent": {
+          "type": "object",
+          "properties": {
+            "hasConsented": {
+              "type": "boolean",
+              "description": "eConsent"
+            },
+            "consentedAt": {
+              "description": "Consented at ISO date time",
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          "required": ["hasConsented"]
+        },
+        "identification": {
+          "type": "object",
+          "properties": {
+            "gender": {
+              "description": "Gender (can be null if migrated from SF as they do not have this field)",
+              "type": ["string", "null"],
+              "enum": ["MALE", "FEMALE", null]
+            },
+            "idNumber": {
+              "description": "ID Number",
+              "type": "string"
+            },
+            "idType": {
+              "description": "ID Type",
+              "type": "string",
+              "enum": ["australian_driver_license", "national_id_card", "passport"]
+            },
+            "idTitle": {
+              "description": "ID Title (can be null if migrated from SF as they do not have this field)",
+              "type": ["string", "null"],
+              "enum": ["DR", "MISS", "MR", "MRS", "MS", "OTHER", "UNKNOWN", null]
+            },
+            "idFirstName": {
+              "description": "ID First Name",
+              "type": "string"
+            },
+            "idMiddleName": {
+              "description": "ID Middle Name (can be null as it is an optional field)",
+              "type": ["string", "null"]
+            },
+            "idLastName": {
+              "description": "ID Last Name",
+              "type": "string"
+            },
+            "australianState": {
+              "description": "Australian State (can be null as it is an optional field)",
+              "type": ["string", "null"],
+              "enum": ["NSW", "QLD", "VIC", "ACT", "WA", "SA", "NT", "TAS", null]
+            },
+            "issuingCountry": {
+              "description": "Issuing Country (can be null as it is an optional field)",
+              "type": ["string", "null"],
+              "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",
+                null
+              ]
+            }
+          },
+          "required": ["idNumber", "idType"]
+        }
+      },
+      "required": ["id", "applicationId", "applicantId"]
+    }
+  }
+}