@lendi/act-credit-decisions-transform 2.0.20 → 2.0.22

package/lib/schemas/credit-report-retrieved-event.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
   "type": "object",
   "properties": {
     "payload": {
@@ -38,20 +38,838 @@
               "type": "string",
               "format": "date-time",
               "example": ["2020-11-03T03:43:33.333Z"]
+            }
+          },
+          "required": ["applicationId", "applicantId", "customerId", "source"]
+        },
+        {
+          "oneOf": [
+            {
+              "$ref": "#/definitions/Response"
             },
-            "raw": {
-              "description": "Credit report raw content, compressed and 64-base encoded.",
-              "type": "string"
+            {
+              "$ref": "#/definitions/ResponseError"
             },
-            "isNoMatch": {
-              "description": "Indicate whether there is a match found or not for the customer.",
-              "type": "boolean",
-              "default": false
+            {
+              "$ref": "#/definitions/ResponseDeidentified"
+            },
+            {
+              "$ref": "#/definitions/ValidationErrors"
             }
-          },
-          "required": ["applicationId", "applicantId", "customerId", "source", "raw"]
+          ]
         }
       ]
+    },
+    "Address": {
+      "type": "object",
+      "properties": {
+        "unitNumber": {
+          "type": "string"
+        },
+        "streetNumber": {
+          "type": "string"
+        },
+        "streetName": {
+          "type": "string"
+        },
+        "streetType": {
+          "type": "string"
+        },
+        "suburb": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        },
+        "postcode": {
+          "type": "string"
+        },
+        "countryCode": {
+          "type": "string"
+        }
+      },
+      "required": ["suburb", "state", "countryCode"]
+    },
+    "Amount": {
+      "type": "object",
+      "properties": {
+        "currencyCode": {
+          "type": "string"
+        },
+        "value": {
+          "type": "number"
+        }
+      },
+      "required": ["currencyCode", "value"]
+    },
+    "CommercialAccountType": {
+      "type": "string",
+      "enum": [
+        "Bridging Finance",
+        "Bill of Sale",
+        "Cash on Delivery",
+        "Cheque",
+        "Credit Card",
+        "Commercial Rental",
+        "Dealership",
+        "Deferred Payment Debit Card",
+        "Director's Access",
+        "Factored Account",
+        "Hire Purchase",
+        "Leasing",
+        "Lending Proposal",
+        "Bank Overdraft",
+        "Premium Finance",
+        "Personal Loan",
+        "Real Estate Mortgage",
+        "Search Request",
+        "Trade Finance",
+        "Telecommunication services",
+        "Telecommunication Services",
+        "Utilities",
+        "Wholesale Finance",
+        "7-Day Account",
+        "30-Day Account",
+        "60-Day Account",
+        "90-Day Account"
+      ]
+    },
+    "Account": {
+      "type": "object",
+      "properties": {
+        "accountId": {
+          "type": "string"
+        },
+        "originalCreditProvider": {
+          "type": "string"
+        },
+        "latestCreditProvider": {
+          "type": "string"
+        },
+        "accountType": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CommercialAccountType"
+            },
+            {
+              "$ref": "#/definitions/ConsumerAccountTypeList"
+            }
+          ]
+        },
+        "accountOpeningDate": {
+          "$ref": "#/definitions/DateType"
+        },
+        "loanPaymentMethod": {
+          "$ref": "#/definitions/LoanPaymentMethodCodeList"
+        },
+        "loanTermType": {
+          "type": "string"
+        },
+        "loanTerm": {
+          "type": "string"
+        },
+        "maximumCreditAmount": {
+          "type": "string"
+        },
+        "repaymentHistory": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Repayment"
+          }
+        },
+        "paymentDefaults": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PaymentDefault"
+          }
+        },
+        "resolvedFinancialInstitution": {
+          "description": "Financial institution short name. If no matching financial institution is found in credit report service, attribute will not be present",
+          "type": "string"
+        }
+      },
+      "required": ["accountId", "originalCreditProvider", "latestCreditProvider"]
+    },
+    "ConsumerCreditEnquiry": {
+      "type": "object",
+      "properties": {
+        "accountType": {
+          "$ref": "#/definitions/ConsumerAccountTypeList"
+        },
+        "creditEnquirer": {
+          "type": "string"
+        },
+        "amount": {
+          "$ref": "#/definitions/Amount"
+        },
+        "enquiryDate": {
+          "$ref": "#/definitions/DateType"
+        }
+      },
+      "required": ["accountType", "creditEnquirer", "amount", "enquiryDate"]
+    },
+    "CommercialCreditEnquiry": {
+      "type": "object",
+      "properties": {
+        "accountType": {
+          "$ref": "#/definitions/CommercialAccountType"
+        },
+        "creditEnquirer": {
+          "type": "string"
+        },
+        "amount": {
+          "$ref": "#/definitions/Amount"
+        },
+        "enquiryDate": {
+          "$ref": "#/definitions/DateType"
+        }
+      },
+      "required": ["accountType", "creditEnquirer", "amount", "enquiryDate"]
+    },
+    "CommercialCreditFile": {
+      "type": "object",
+      "properties": {
+        "fileNotes": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/FileNote"
+          }
+        },
+        "creditEnquiries": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CommercialCreditEnquiry"
+          }
+        },
+        "accounts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Account"
+          }
+        }
+      },
+      "required": []
+    },
+    "ConsumerCreditFile": {
+      "type": "object",
+      "properties": {
+        "accounts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Account"
+          }
+        },
+        "creditEnquiries": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConsumerCreditEnquiry"
+          }
+        }
+      },
+      "required": []
+    },
+    "LoanPaymentMethodCodeList": {
+      "type": "string",
+      "enum": ["Interest only", "Not Applicable", "Principal and Interest Full", "Principal and Interest Partial"]
+    },
+    "ConsumerAccountTypeList": {
+      "type": "string",
+      "enum": [
+        "All Other Account Types",
+        "Auto Loan",
+        "Buy Now Pay Later Facility",
+        "Buy Now Pay Later Transaction",
+        "Charge Card",
+        "Continuing Credit Contract",
+        "Credit Card",
+        "Equipment Hire or Rental",
+        "Overdraft",
+        "Personal Loan Fixed Term",
+        "Personal Loan Revolving",
+        "Real Property Mortgage",
+        "Telecommunications Services",
+        "Utilities"
+      ]
+    },
+    "LendiConsumerAccountTypeList": {
+      "description": "Account type of the consumer enquiries that has been transformed to Lendi values. Any value that can not be mapped to Lendi values will be set to UNKNOWN",
+      "type": "string",
+      "enum": [
+        "UNKNOWN",
+        "HOME_LOANS",
+        "PERSONAL_LOANS",
+        "OVERDRAFTS",
+        "CREDIT_CHARGE_CARDS",
+        "CAR_LOANS",
+        "LEASES",
+        "BNPL_ACCOUNTS"
+      ]
+    },
+    "LendiRepaymentStatusCode": {
+      "description": "Equifax Repayment history code in Lendi value",
+      "type": "string",
+      "enum": [
+        "NOT_OVERDUE",
+        "OVERDUE_UPTO_29DAYS",
+        "OVERDUE_UPTO_59DAYS",
+        "OVERDUE_UPTO_89DAYS",
+        "OVERDUE_UPTO_119DAYS",
+        "OVERDUE_UPTO_149DAYS",
+        "OVERDUE_UPTO_179DAYS",
+        "OVERDUE_MORETHAN_180DAYS",
+        "CLOSED",
+        "NOT_REPORTED",
+        "NOT_ASSOCIATED",
+        "PENDING",
+        "TRANSFERRED",
+        "OTHER_CASE",
+        "NOT_APPLICABLE"
+      ]
+    },
+    "CourtAction": {
+      "type": "object",
+      "properties": {
+        "courtActionType": {
+          "description": "Includes information about default judgements and other court actions (such as writs and summons)",
+          "type": "string",
+          "enum": ["defaultJudgement", "otherCourtAction"]
+        },
+        "idReference": {
+          "description": "Reference to associate the source of this information to the identity defined by identity index.",
+          "type": "string"
+        },
+        "status": {
+          "description": "Status of the court action.",
+          "type": "string",
+          "enum": ["Disconnected", "Paid", "Settled"]
+        },
+        "actionDate": {
+          "description": "The date when a court judgement was signed or a writ, summons or claim was issued",
+          "$ref": "#/definitions/DateType"
+        },
+        "amount": {
+          "description": "Dollar amount of Court Action",
+          "$ref": "#/definitions/Amount"
+        }
+      },
+      "required": ["courtActionType", "idReference", "actionDate", "amount"]
+    },
+    "CreditFileType": {
+      "type": "string",
+      "enum": ["Consumer", "Commercial"]
+    },
+    "DefaultInstance": {
+      "type": "object",
+      "properties": {
+        "dateRecorded": {
+          "$ref": "#/definitions/DateType"
+        },
+        "amount": {
+          "$ref": "#/definitions/Amount"
+        }
+      },
+      "required": ["dateRecorded", "amount"]
+    },
+    "DateType": {
+      "type": "string",
+      "format": "date",
+      "examples": ["1990-01-01"]
+    },
+    "Directorship": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of Directorship",
+          "enum": ["Current", "Previous"]
+        },
+        "idReference": {
+          "type": "string"
+        },
+        "dateAppointed": {
+          "$ref": "#/definitions/DateType"
+        },
+        "dateCeased": {
+          "$ref": "#/definitions/DateType"
+        },
+        "organisationName": {
+          "type": "string"
+        },
+        "organisationType": {
+          "$ref": "#/definitions/OrganisationTypeList"
+        }
+      },
+      "required": ["idReference", "dateAppointed", "organisationName", "organisationType"]
+    },
+    "DisqualifiedDirectorships": {
+      "type": "object",
+      "properties": {
+        "idReference": {
+          "type": "string"
+        },
+        "dateDisqualified": {
+          "$ref": "#/definitions/DateType"
+        },
+        "dateDisqualifiedUntil": {
+          "$ref": "#/definitions/DateType"
+        }
+      },
+      "required": ["idReference", "dateDisqualified", "dateDisqualifiedUntil"]
+    },
+    "FileNote": {
+      "type": "object",
+      "properties": {
+        "dateRecorded": {
+          "$ref": "#/definitions/DateType"
+        },
+        "note": {
+          "type": "string"
+        }
+      },
+      "required": ["dateRecorded", "note"]
+    },
+    "Insolvency": {
+      "type": "object",
+      "properties": {
+        "idReference": {
+          "type": "string"
+        },
+        "insolvencyType": {
+          "$ref": "#/definitions/InsolvencyTypeList"
+        },
+        "dateDeclared": {
+          "$ref": "#/definitions/DateType"
+        },
+        "status": {
+          "$ref": "#/definitions/InsolvencyStatus"
+        },
+        "statusDate": {
+          "$ref": "#/definitions/DateType"
+        }
+      },
+      "required": ["idReference", "dateDeclared"]
+    },
+    "InsolvencyStatus": {
+      "type": "string",
+      "enum": ["Discharged", "Completed", "Terminated"]
+    },
+    "InsolvencyTypeList": {
+      "type": "string",
+      "enum": [
+        "Assignment or Arrangement",
+        "Bankruptcy",
+        "Bankruptcy Sequestration Order Arrangement",
+        "Composition",
+        "Debt Agreement",
+        "Personal Insolvency Agreement"
+      ]
+    },
+    "MatchType": {
+      "type": "string",
+      "enum": ["Other Identity", "Primary Match", "Possible Match"]
+    },
+    "PossibleMatch": {
+      "type": "object",
+      "properties": {
+        "person": {
+          "$ref": "#/definitions/Person"
+        },
+        "address": {
+          "$ref": "#/definitions/Address"
+        },
+        "employerName": {
+          "type": "string"
+        }
+      },
+      "required": ["person", "address"]
+    },
+    "OrganisationTypeList": {
+      "type": "string",
+      "enum": [
+        "Proprietary",
+        "Proprietary Limited",
+        "Proprietary Limited No Liability",
+        "Incorporated",
+        "Limited Liability Registered Body"
+      ]
+    },
+    "Person": {
+      "type": "object",
+      "properties": {
+        "bureauReference": {
+          "type": "string"
+        },
+        "dateOfBirth": {
+          "$ref": "#/definitions/DateType"
+        },
+        "driversLicense": {
+          "type": "string"
+        },
+        "firstName": {
+          "type": "string"
+        },
+        "gender": {
+          "type": "string"
+        },
+        "idIndex": {
+          "description": "An identifier appended to each known identity of the individual.",
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "middleName": {
+          "type": "string"
+        },
+        "primaryMatchType": {
+          "type": "string",
+          "enum": ["Strong", "Create"],
+          "description": "Strong - credit report is found, and a record exists in the credit provider's database; Create - credit report is found, no record exists in the credit provider's database, a new record is added."
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "required": ["firstName", "lastName"]
+    },
+    "Repayment": {
+      "type": "object",
+      "properties": {
+        "period": {
+          "description": "Repayment history period.",
+          "type": "string"
+        },
+        "status": {
+          "description": "Repayment history status.",
+          "$ref": "#/definitions/RepaymentStatusList"
+        },
+        "code": {
+          "description": "Repayment history code.",
+          "$ref": "#/definitions/RepaymentStatusCode"
+        }
+      },
+      "required": ["period", "status"]
+    },
+    "RepaymentStatusList": {
+      "type": "string",
+      "enum": [
+        "Closed",
+        "Not Associated",
+        "Not Reported",
+        "Not Overdue",
+        "Overdue Upto 29 Days",
+        "Overdue Upto 59 Days",
+        "Overdue Upto 89 Days",
+        "Overdue Upto 119 Days",
+        "Overdue Upto 149 Days",
+        "Overdue Upto 179 Days",
+        "Overdue Over 179 Days",
+        "Pending",
+        "Transferred"
+      ]
+    },
+    "RepaymentStatusCode": {
+      "type": "string",
+      "enum": ["0", "1", "2", "3", "4", "5", "6", "A", "C", "O", "P", "R", "T", "X", "-991", "-992", "-993"]
+    },
+    "PaymentDefaultStatusList": {
+      "type": "string",
+      "enum": ["Outstanding", "Current", "Disputed", "New Arrangement", "Paid", "Settled", "New Arrangement Varied"]
+    },
+    "PaymentDefault": {
+      "type": "object",
+      "properties": {
+        "statusCode": {
+          "$ref": "#/definitions/PaymentDefaultStatusList"
+        },
+        "statusDate": {
+          "$ref": "#/definitions/DateType"
+        },
+        "current": {
+          "$ref": "#/definitions/DefaultInstance"
+        },
+        "original": {
+          "$ref": "#/definitions/DefaultInstance"
+        }
+      },
+      "required": ["statusCode"]
+    },
+    "PrimaryMatch": {
+      "type": "object",
+      "properties": {
+        "person": {
+          "$ref": "#/definitions/Person"
+        },
+        "address": {
+          "$ref": "#/definitions/Address"
+        },
+        "otherIdentities": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Person"
+          }
+        }
+      },
+      "required": ["person", "address"]
+    },
+    "SummaryDataPoint": {
+      "type": "object",
+      "properties": {
+        "dataLevel": {
+          "type": "string",
+          "description": "Indicates the data level type of the characteristic. A characteristic can be derived based on Negative, Partial or Comprehensive ",
+          "enum": ["Negative", "Partial", "Comprehensive"]
+        },
+        "value": {
+          "type": ["number", "string"],
+          "description": "A number will have type 'number' if valid, otherwise 'string'. Default value is 0"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "ageOfCreditFileInMths",
+            "openedAccounts",
+            "numOpenCreditCardAccounts",
+            "numOpenPersonalLoanAccounts",
+            "numOpenMortgageAccounts",
+            "numOpenRentalAccounts",
+            "numOpenOverdraftAccounts",
+            "numOpenChargeCardAccounts",
+            "numConsumerEnquiriesInLast12Months",
+            "numBankruptOnlyInsolvenciesOnFile",
+            "numJudgementsInLast60Months",
+            "numUnpaidOrUnsettledJudgementsInLast60Months",
+            "numCourtWritsInLast60Months",
+            "numUnpaidOrUnsettledCourtWritsInLast60Months",
+            "numOpenAutoAccounts",
+            "closedAccounts",
+            "creditEnquiriesInLast5Years",
+            "currentDirectorships",
+            "previousDirectorships",
+            "insolvenciesAndActions",
+            "defaultsLast6Months",
+            "defaultsLast12Months",
+            "defaultsLast5To7Years",
+            "worstOpenAccountStatus",
+            "worstClosedInLast24Months",
+            "worstOpenInLast12Months",
+            "worstOpenInLast24Months",
+            "consumerAdverseFlagOnFileInLast48Or84Months",
+            "commercialAdverseFlagOnFileInLast48Or84Months",
+            "financialHardshipIndicatorsInLast12Months",
+            "numberOfCommercialDisqualifiedDirectorshipsInLast60Months"
+          ]
+        }
+      },
+      "required": ["type", "value"]
+    },
+    "CreditReport": {
+      "type": "object",
+      "description": "The raw credit report data from the service provider that has been transformed to json",
+      "properties": {
+        "commercialEnquiries": {
+          "$ref": "#/definitions/CommercialCreditFile"
+        },
+        "consumerEnquiries": {
+          "$ref": "#/definitions/ConsumerCreditFile"
+        },
+        "courtActions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/CourtAction"
+          }
+        },
+        "directorships": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Directorship"
+          }
+        },
+        "disqualifiedDirectorships": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DisqualifiedDirectorships"
+          }
+        },
+        "enquiryId": {
+          "description": "The enquiry id from the service provider.",
+          "type": "string"
+        },
+        "insolvencies": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Insolvency"
+          }
+        },
+        "possibleMatch": {
+          "$ref": "#/definitions/PossibleMatch"
+        },
+        "possibleMatchReference": {
+          "type": "string"
+        },
+        "primaryBureauReference": {
+          "description": "A unique identifier for that individual, used if the individual can be explicitly identified",
+          "type": "string"
+        },
+        "primaryMatch": {
+          "$ref": "#/definitions/PrimaryMatch"
+        },
+        "scoreMasterScale": {
+          "description": "An overall score value.",
+          "type": "number"
+        },
+        "summary": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/SummaryDataPoint"
+          }
+        },
+        "lastRequestedAt": {
+          "type": "string"
+        },
+        "numberOfIdentities": {
+          "type": "number",
+          "description": "Number of identities of a person with Credit Bureau (Primary Match + Other Identities count)"
+        },
+        "creditEnquiriesLast5Years": {
+          "type": "number",
+          "description": "Number of Credit Enquiries "
+        }
+      },
+      "required": ["enquiryId", "scoreMasterScale", "numberOfIdentities"]
+    },
+    "TransformedConsumerEnquiryRepaymentHistory": {
+      "description": "Transformed repayment history of the consumer enquiries account",
+      "type": "object",
+      "properties": {
+        "period": {
+          "description": "Repayment history period.",
+          "type": "string"
+        },
+        "status": {
+          "description": "Repayment history status.",
+          "$ref": "#/definitions/RepaymentStatusList"
+        },
+        "code": {
+          "description": "Repayment history code.",
+          "$ref": "#/definitions/LendiRepaymentStatusCode"
+        }
+      }
+    },
+    "TransformedConsumerEnquiryAccount": {
+      "description": "Transformed credit report of the consumer enquiries account",
+      "type": "object",
+      "required": ["accountId"],
+      "properties": {
+        "accountId": {
+          "type": "string"
+        },
+        "accountType": {
+          "description": "Account type of the consumer enquiries that has been transformed to Lendi values",
+          "$ref": "#/definitions/LendiConsumerAccountTypeList"
+        },
+        "repaymentHistory": {
+          "description": "The repayment history of the consumer enquiries with its code has been transformed to Lendi values",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TransformedConsumerEnquiryRepaymentHistory"
+          }
+        }
+      }
+    },
+    "TransformedConsumerCreditFile": {
+      "description": "Transformed credit report of the consumer enquiries",
+      "type": "object",
+      "properties": {
+        "accounts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/TransformedConsumerEnquiryAccount"
+          }
+        }
+      },
+      "required": []
+    },
+    "TransformedCreditReport": {
+      "type": "object",
+      "description": "Transformed credit report object",
+      "properties": {
+        "consumerEnquiries": {
+          "$ref": "#/definitions/TransformedConsumerCreditFile"
+        }
+      }
+    },
+    "Response": {
+      "type": "object",
+      "properties": {
+        "raw": {
+          "description": "Credit report raw content, compressed and 64-base encoded.",
+          "type": "string"
+        },
+        "transformedJson": {
+          "description": "The transformed credit report from the raw content. All enumerated fields are mapped to their corresponding internal Lendi values while preserving the original values wherever possible. This is a work in progress; additional fields can be added as needed.",
+          "$ref": "#/definitions/TransformedCreditReport"
+        },
+        "json": {
+          "description": "Transformed credit report in json format from the raw content. This field is deprecated and will be removed in the future. Consider to use field transformedJson instead.",
+          "deprecated": true,
+          "$ref": "#/definitions/CreditReport"
+        },
+        "isNoMatch": {
+          "description": "Indicate whether there is a match found or not for the customer.",
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "required": ["raw", "json"]
+    },
+    "ResponseError": {
+      "type": "object",
+      "properties": {
+        "message": {
+          "type": "string"
+        },
+        "isNoMatch": {
+          "type": "boolean"
+        }
+      },
+      "required": ["message"]
+    },
+    "ResponseDeidentified": {
+      "type": "object",
+      "properties": {
+        "isDeidentified": {
+          "type": "boolean"
+        }
+      },
+      "required": ["isDeidentified"]
+    },
+    "ValidationErrors": {
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ValidationError"
+          }
+        }
+      },
+      "required": ["errors"]
+    },
+    "ValidationError": {
+      "type": "object",
+      "properties": {
+        "path": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "message": {
+          "description": "Validation error message",
+          "type": "string"
+        }
+      }
     }
   }
 }