@lendi/integrations-transform 1.0.7 → 1.1.1

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

@@ -0,0 +1,652 @@
+{
+  "definitions": {
+    "Payload": {
+      "$ref": "#/definitions/payload"
+    },
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "applicantKeyObject": {
+      "type": "object",
+      "properties": {
+        "applicantId": {
+          "$ref": "#/definitions/id"
+        }
+      }
+    },
+    "applicantMeta": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The metadata of the applicant",
+      "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"]
+    },
+    "dependant": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "Id for entity."
+        },
+        "age": {
+          "type": "number",
+          "minimum": 0
+        },
+        "isAddedOnThisApplicant": {
+          "type": "boolean",
+          "description": "Whether dependant was added for this applicant."
+        },
+        "sharedWith": {
+          "$ref": "#/definitions/applicantKeyObject"
+        }
+      }
+    },
+    "applicantType": {
+      "enum": ["BORROWER", "BORROWER_AND_GUARANTOR", "GUARANTOR"]
+    },
+    "creditStatus": {
+      "enum": ["FAIR", "UNKNOWN", "AVERAGE", "EXCELLENT"],
+      "description": "current credit status of the applicant (Customer declared value)"
+    },
+    "employmentType": {
+      "enum": ["EMPLOYEE", "SELF_EMPLOYED", "UNKNOWN"],
+      "description": "applicant's employment type"
+    },
+    "isPrimaryApplicant": {
+      "type": "boolean"
+    },
+    "hasSelfEmploymentProof": {
+      "type": "boolean"
+    },
+    "totalIncomeEstimate": {
+      "type": "number",
+      "minimum": 0,
+      "description": "The applicants estimated total income per financial year. Whole Australian dollars"
+    },
+    "dateOfBirth": {
+      "type": "string",
+      "description": "applicant's DOB, in ISO-8601 date format"
+    },
+    "gender": {
+      "enum": ["FEMALE", "MALE", "UNDISCLOSED", "UNKNOWN"]
+    },
+    "maritalStatus": {
+      "enum": ["DE_FACTO", "DIVORCED", "MARRIED", "SINGLE", "UNKNOWN"]
+    },
+    "residencyStatus": {
+      "enum": ["AUSTRALIAN_CITIZEN", "PERMANENT_RESIDENT", "TEMPORARY_RESIDENT", "UNKNOWN"]
+    },
+    "dependants": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/dependant"
+      }
+    },
+    "firstName": {
+      "type": "string",
+      "description": "customer's first name"
+    },
+    "middleName": {
+      "type": "string",
+      "description": "customer's middle name"
+    },
+    "lastName": {
+      "type": "string",
+      "description": "customer's last name"
+    },
+    "title": {
+      "enum": ["DR", "MISS", "MR", "MRS", "MS", "UNKNOWN"]
+    },
+    "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"
+      ]
+    },
+    "housingStatusList": {
+      "type": "string",
+      "additionalProperties": false,
+      "enum": [
+        "Renting",
+        "Boarding",
+        "Caravan",
+        "Other",
+        "Own Home",
+        "Own Home Mortgage",
+        "Supplied by Employer",
+        "With Parents"
+      ]
+    },
+    "otherState": {
+      "type": "string",
+      "example": "Ohio"
+    },
+    "AustralianStates": {
+      "example": "NSW",
+      "type": "string",
+      "enum": ["QLD", "NSW", "VIC", "WA", "SA", "TAS", "ACT", "NT"]
+    },
+    "date": {
+      "type": "string",
+      "format": "date",
+      "example": "2018-07-17"
+    },
+    "AddressStandard": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "buildingName": {
+          "description": "The building name",
+          "type": "string"
+        },
+        "deliveryAddress": {
+          "description": "Postal address, usually a PO Box or Locked Bag",
+          "type": "string",
+          "example": "PO Box 1"
+        },
+        "lotSection": {
+          "description": "The lot number",
+          "type": "string"
+        },
+        "streetName": {
+          "type": "string"
+        },
+        "streetNumber": {
+          "type": "string"
+        },
+        "streetSuffix": {
+          "description": "The street suffix",
+          "type": "string",
+          "example": "North"
+        },
+        "streetType": {
+          "type": "string"
+        },
+        "level": {
+          "type": "string"
+        },
+        "unit": {
+          "type": "string"
+        }
+      }
+    },
+    "address": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "postcode": {
+          "type": "string"
+        },
+        "state": {
+          "example": "NSW",
+          "type": "string",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/AustralianStates"
+            },
+            {
+              "$ref": "#/definitions/otherState"
+            }
+          ]
+        },
+        "city": {
+          "type": "string"
+        },
+        "country": {
+          "$ref": "#/definitions/countries"
+        },
+        "formatted": {
+          "type": "string"
+        },
+        "standard": {
+          "$ref": "#/definitions/AddressStandard"
+        }
+      }
+    },
+    "commonAddressProperties": {
+      "type": "object",
+      "properties": {
+        "externalId": {
+          "$ref": "#/definitions/id"
+        },
+        "housingStatus": {
+          "$ref": "#/definitions/housingStatusList"
+        },
+        "startDate": {
+          "$ref": "#/definitions/date"
+        },
+        "residentialAddress": {
+          "$ref": "#/definitions/address"
+        }
+      }
+    },
+    "currentAddress": {
+      "$ref": "#/definitions/commonAddressProperties"
+    },
+    "previousAddresses": {
+      "type": "array",
+      "minItems": 0,
+      "items": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/definitions/commonAddressProperties"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "endDate": {
+                "$ref": "#/definitions/date"
+              }
+            }
+          }
+        ]
+      }
+    },
+    "contact": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "currentAddress": {
+          "$ref": "#/definitions/currentAddress"
+        },
+        "mailingAddress": {
+          "description": "applicant's mailing address being captured as part of funnels 5 (post product select)",
+          "$ref": "#/definitions/address"
+        },
+        "mobileNumber": {
+          "type": "string",
+          "description": "applicant's mobile number formatted in +611234567890"
+        },
+        "postSettlementAddress": {
+          "$ref": "#/definitions/address",
+          "description": "applicant's post settlement address being captured as part of funnels 5 (post product select)"
+        },
+        "previousAddresses": {
+          "$ref": "#/definitions/previousAddresses"
+        },
+        "emailAddress": {
+          "type": "string",
+          "description": "The applicant email"
+        }
+      }
+    },
+    "invitationStatus": {
+      "enum": ["ACCEPTED", "PENDING", "CANCELLED", "EXPIRED"],
+      "description": "different invitation statuses an applicant can have"
+    },
+    "entity": {
+      "enum": ["PERSON", "COMPANY"],
+      "description": "applicant's entity. For a person applicant this is 'PERSON'"
+    },
+    "isFirstHomeBuyer": {
+      "type": "boolean",
+      "description": "Whether it's the applicants first home purchase."
+    },
+    "payload": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of applicant"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of application"
+        },
+        "customerId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of customer"
+        },
+        "clonedFromApplicantId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of source applicant"
+        },
+        "meta": {
+          "$ref": "#/definitions/applicantMeta"
+        },
+        "applicantType": {
+          "$ref": "#/definitions/applicantType"
+        },
+        "creditStatus": {
+          "$ref": "#/definitions/creditStatus"
+        },
+        "entity": {
+          "$ref": "#/definitions/entity"
+        },
+        "employmentType": {
+          "$ref": "#/definitions/employmentType"
+        },
+        "isPrimaryApplicant": {
+          "$ref": "#/definitions/isPrimaryApplicant"
+        },
+        "hasSelfEmploymentProof": {
+          "$ref": "#/definitions/hasSelfEmploymentProof"
+        },
+        "totalIncomeEstimate": {
+          "$ref": "#/definitions/totalIncomeEstimate"
+        },
+        "dateOfBirth": {
+          "$ref": "#/definitions/dateOfBirth"
+        },
+        "gender": {
+          "$ref": "#/definitions/gender"
+        },
+        "maritalStatus": {
+          "$ref": "#/definitions/maritalStatus"
+        },
+        "maritalDetails": {
+          "$ref": "#/definitions/applicantKeyObject"
+        },
+        "residencyStatus": {
+          "$ref": "#/definitions/residencyStatus"
+        },
+        "dependants": {
+          "$ref": "#/definitions/dependants"
+        },
+        "firstName": {
+          "$ref": "#/definitions/firstName"
+        },
+        "middleName": {
+          "$ref": "#/definitions/middleName"
+        },
+        "lastName": {
+          "$ref": "#/definitions/lastName"
+        },
+        "title": {
+          "$ref": "#/definitions/title"
+        },
+        "contact": {
+          "$ref": "#/definitions/contact"
+        },
+        "invitationStatus": {
+          "$ref": "#/definitions/invitationStatus"
+        },
+        "countryOfBirth": {
+          "$ref": "#/definitions/countries"
+        },
+        "citizenship": {
+          "$ref": "#/definitions/countries"
+        },
+        "mothersMaidenName": {
+          "type": "string",
+          "description": "Mothers Maiden Name"
+        },
+        "isFirstHomeBuyer": {
+          "$ref": "#/definitions/isFirstHomeBuyer"
+        }
+      },
+      "required": ["id", "applicationId", "customerId"],
+      "description": "create/update applicant payload"
+    }
+  },
+  "type": "object",
+  "title": "The applicant event schema",
+  "description": "Create, update or delete. UpdatePrimaryApplicant is DEPRECATED",
+  "additionalProperties": false,
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["UpdateApplicant", "CreateApplicant"]
+    },
+    "payload": {
+      "$ref": "#/definitions/Payload"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}