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

package/lib/types/events/credit-report-retrieved.d.ts

@@ -1,9 +1,9 @@
 export interface CreditReportRetrieved {
-    payload: any[] | boolean | number | number | null | PayloadObject | string;
-    type: Type;
+    payload: Payload;
+    type: CreditReportRetrievedType;
     version: string;
 }
-export interface PayloadObject {
+export interface Payload {
     applicantId: string;
     applicationId: string;
     /**
@@ -11,18 +11,488 @@ export interface PayloadObject {
      */
     createdAt?: string;
     customerId: string;
+    errors?: ValidationError[];
+    isDeidentified?: boolean;
     /**
      * Indicate whether there is a match found or not for the customer.
      */
     isNoMatch?: boolean;
+    /**
+     * 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.
+     */
+    json?: CreditReport;
+    message?: string;
     /**
      * Credit report raw content, compressed and 64-base encoded.
      */
-    raw: string;
+    raw?: string;
     /**
      * A list of credit report service provider
      */
     source: Source;
+    /**
+     * 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.
+     */
+    transformedJson?: TransformedCreditReport;
+}
+export interface ValidationError {
+    /**
+     * Validation error message
+     */
+    message?: string;
+    path?: string[];
+}
+/**
+ * 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.
+ *
+ * The raw credit report data from the service provider that has been transformed to json
+ */
+export interface CreditReport {
+    commercialEnquiries?: CommercialCreditFile;
+    consumerEnquiries?: ConsumerCreditFile;
+    courtActions?: CourtAction[];
+    /**
+     * Number of Credit Enquiries
+     */
+    creditEnquiriesLast5Years?: number;
+    directorships?: Directorship[];
+    disqualifiedDirectorships?: DisqualifiedDirectorships[];
+    /**
+     * The enquiry id from the service provider.
+     */
+    enquiryId: string;
+    insolvencies?: Insolvency[];
+    lastRequestedAt?: string;
+    /**
+     * Number of identities of a person with Credit Bureau (Primary Match + Other Identities
+     * count)
+     */
+    numberOfIdentities: number;
+    possibleMatch?: PossibleMatch;
+    possibleMatchReference?: string;
+    /**
+     * A unique identifier for that individual, used if the individual can be explicitly
+     * identified
+     */
+    primaryBureauReference?: string;
+    primaryMatch?: PrimaryMatch;
+    /**
+     * An overall score value.
+     */
+    scoreMasterScale: number;
+    summary?: SummaryDataPoint[];
+}
+export interface CommercialCreditFile {
+    accounts?: Account[];
+    creditEnquiries?: CommercialCreditEnquiry[];
+    fileNotes?: FileNote[];
+}
+export interface Account {
+    accountId: string;
+    accountOpeningDate?: string;
+    accountType?: CommercialAccountType;
+    latestCreditProvider: string;
+    loanPaymentMethod?: LoanPaymentMethodCodeList;
+    loanTerm?: string;
+    loanTermType?: string;
+    maximumCreditAmount?: string;
+    originalCreditProvider: string;
+    paymentDefaults?: PaymentDefault[];
+    repaymentHistory?: Repayment[];
+    /**
+     * Financial institution short name. If no matching financial institution is found in credit
+     * report service, attribute will not be present
+     */
+    resolvedFinancialInstitution?: string;
+}
+export declare enum CommercialAccountType {
+    AllOtherAccountTypes = "All Other Account Types",
+    AutoLoan = "Auto Loan",
+    BankOverdraft = "Bank Overdraft",
+    BillOfSale = "Bill of Sale",
+    BridgingFinance = "Bridging Finance",
+    BuyNowPayLaterFacility = "Buy Now Pay Later Facility",
+    BuyNowPayLaterTransaction = "Buy Now Pay Later Transaction",
+    CashOnDelivery = "Cash on Delivery",
+    ChargeCard = "Charge Card",
+    Cheque = "Cheque",
+    CommercialAccountTypeTelecommunicationServices = "Telecommunication Services",
+    CommercialRental = "Commercial Rental",
+    ContinuingCreditContract = "Continuing Credit Contract",
+    CreditCard = "Credit Card",
+    Dealership = "Dealership",
+    DeferredPaymentDebitCard = "Deferred Payment Debit Card",
+    DirectorSAccess = "Director's Access",
+    EquipmentHireOrRental = "Equipment Hire or Rental",
+    FactoredAccount = "Factored Account",
+    HirePurchase = "Hire Purchase",
+    Leasing = "Leasing",
+    LendingProposal = "Lending Proposal",
+    Overdraft = "Overdraft",
+    PersonalLoan = "Personal Loan",
+    PersonalLoanFixedTerm = "Personal Loan Fixed Term",
+    PersonalLoanRevolving = "Personal Loan Revolving",
+    PremiumFinance = "Premium Finance",
+    RealEstateMortgage = "Real Estate Mortgage",
+    RealPropertyMortgage = "Real Property Mortgage",
+    SearchRequest = "Search Request",
+    TelecommunicationServices = "Telecommunication services",
+    TelecommunicationsServices = "Telecommunications Services",
+    The30DayAccount = "30-Day Account",
+    The60DayAccount = "60-Day Account",
+    The7DayAccount = "7-Day Account",
+    The90DayAccount = "90-Day Account",
+    TradeFinance = "Trade Finance",
+    Utilities = "Utilities",
+    WholesaleFinance = "Wholesale Finance"
+}
+export declare enum LoanPaymentMethodCodeList {
+    InterestOnly = "Interest only",
+    NotApplicable = "Not Applicable",
+    PrincipalAndInterestFull = "Principal and Interest Full",
+    PrincipalAndInterestPartial = "Principal and Interest Partial"
+}
+export interface PaymentDefault {
+    current?: DefaultInstance;
+    original?: DefaultInstance;
+    statusCode: PaymentDefaultStatusList;
+    statusDate?: string;
+}
+export interface DefaultInstance {
+    amount: Amount;
+    dateRecorded: string;
+}
+/**
+ * Dollar amount of Court Action
+ */
+export interface Amount {
+    currencyCode: string;
+    value: number;
+}
+export declare enum PaymentDefaultStatusList {
+    Current = "Current",
+    Disputed = "Disputed",
+    NewArrangement = "New Arrangement",
+    NewArrangementVaried = "New Arrangement Varied",
+    Outstanding = "Outstanding",
+    Paid = "Paid",
+    Settled = "Settled"
+}
+export interface Repayment {
+    /**
+     * Repayment history code.
+     */
+    code?: RepaymentStatusCode;
+    /**
+     * Repayment history period.
+     */
+    period: string;
+    /**
+     * Repayment history status.
+     */
+    status: RepaymentStatusList;
+}
+/**
+ * Repayment history code.
+ */
+export declare enum RepaymentStatusCode {
+    A = "A",
+    C = "C",
+    O = "O",
+    P = "P",
+    R = "R",
+    T = "T",
+    The0 = "0",
+    The1 = "1",
+    The2 = "2",
+    The3 = "3",
+    The4 = "4",
+    The5 = "5",
+    The6 = "6",
+    The991 = "-991",
+    The992 = "-992",
+    The993 = "-993",
+    X = "X"
+}
+/**
+ * Repayment history status.
+ */
+export declare enum RepaymentStatusList {
+    Closed = "Closed",
+    NotAssociated = "Not Associated",
+    NotOverdue = "Not Overdue",
+    NotReported = "Not Reported",
+    OverdueOver179Days = "Overdue Over 179 Days",
+    OverdueUpto119Days = "Overdue Upto 119 Days",
+    OverdueUpto149Days = "Overdue Upto 149 Days",
+    OverdueUpto179Days = "Overdue Upto 179 Days",
+    OverdueUpto29Days = "Overdue Upto 29 Days",
+    OverdueUpto59Days = "Overdue Upto 59 Days",
+    OverdueUpto89Days = "Overdue Upto 89 Days",
+    Pending = "Pending",
+    Transferred = "Transferred"
+}
+export interface CommercialCreditEnquiry {
+    accountType: CreditEnquiryAccountType;
+    amount: Amount;
+    creditEnquirer: string;
+    enquiryDate: string;
+}
+export declare enum CreditEnquiryAccountType {
+    BankOverdraft = "Bank Overdraft",
+    BillOfSale = "Bill of Sale",
+    BridgingFinance = "Bridging Finance",
+    CashOnDelivery = "Cash on Delivery",
+    Cheque = "Cheque",
+    CommercialAccountTypeTelecommunicationServices = "Telecommunication Services",
+    CommercialRental = "Commercial Rental",
+    CreditCard = "Credit Card",
+    Dealership = "Dealership",
+    DeferredPaymentDebitCard = "Deferred Payment Debit Card",
+    DirectorSAccess = "Director's Access",
+    FactoredAccount = "Factored Account",
+    HirePurchase = "Hire Purchase",
+    Leasing = "Leasing",
+    LendingProposal = "Lending Proposal",
+    PersonalLoan = "Personal Loan",
+    PremiumFinance = "Premium Finance",
+    RealEstateMortgage = "Real Estate Mortgage",
+    SearchRequest = "Search Request",
+    TelecommunicationServices = "Telecommunication services",
+    The30DayAccount = "30-Day Account",
+    The60DayAccount = "60-Day Account",
+    The7DayAccount = "7-Day Account",
+    The90DayAccount = "90-Day Account",
+    TradeFinance = "Trade Finance",
+    Utilities = "Utilities",
+    WholesaleFinance = "Wholesale Finance"
+}
+export interface FileNote {
+    dateRecorded: string;
+    note: string;
+}
+export interface ConsumerCreditFile {
+    accounts?: Account[];
+    creditEnquiries?: ConsumerCreditEnquiry[];
+}
+export interface ConsumerCreditEnquiry {
+    accountType: ConsumerAccountTypeList;
+    amount: Amount;
+    creditEnquirer: string;
+    enquiryDate: string;
+}
+export declare enum ConsumerAccountTypeList {
+    AllOtherAccountTypes = "All Other Account Types",
+    AutoLoan = "Auto Loan",
+    BuyNowPayLaterFacility = "Buy Now Pay Later Facility",
+    BuyNowPayLaterTransaction = "Buy Now Pay Later Transaction",
+    ChargeCard = "Charge Card",
+    ContinuingCreditContract = "Continuing Credit Contract",
+    CreditCard = "Credit Card",
+    EquipmentHireOrRental = "Equipment Hire or Rental",
+    Overdraft = "Overdraft",
+    PersonalLoanFixedTerm = "Personal Loan Fixed Term",
+    PersonalLoanRevolving = "Personal Loan Revolving",
+    RealPropertyMortgage = "Real Property Mortgage",
+    TelecommunicationsServices = "Telecommunications Services",
+    Utilities = "Utilities"
+}
+export interface CourtAction {
+    /**
+     * The date when a court judgement was signed or a writ, summons or claim was issued
+     */
+    actionDate: string;
+    /**
+     * Dollar amount of Court Action
+     */
+    amount: Amount;
+    /**
+     * Includes information about default judgements and other court actions (such as writs and
+     * summons)
+     */
+    courtActionType: CourtActionType;
+    /**
+     * Reference to associate the source of this information to the identity defined by identity
+     * index.
+     */
+    idReference: string;
+    /**
+     * Status of the court action.
+     */
+    status?: Status;
+}
+/**
+ * Includes information about default judgements and other court actions (such as writs and
+ * summons)
+ */
+export declare enum CourtActionType {
+    DefaultJudgement = "defaultJudgement",
+    OtherCourtAction = "otherCourtAction"
+}
+/**
+ * Status of the court action.
+ */
+export declare enum Status {
+    Disconnected = "Disconnected",
+    Paid = "Paid",
+    Settled = "Settled"
+}
+export interface Directorship {
+    dateAppointed: string;
+    dateCeased?: string;
+    idReference: string;
+    organisationName: string;
+    organisationType: OrganisationTypeList;
+    /**
+     * The type of Directorship
+     */
+    type?: DirectorshipType;
+}
+export declare enum OrganisationTypeList {
+    Incorporated = "Incorporated",
+    LimitedLiabilityRegisteredBody = "Limited Liability Registered Body",
+    Proprietary = "Proprietary",
+    ProprietaryLimited = "Proprietary Limited",
+    ProprietaryLimitedNoLiability = "Proprietary Limited No Liability"
+}
+/**
+ * The type of Directorship
+ */
+export declare enum DirectorshipType {
+    Current = "Current",
+    Previous = "Previous"
+}
+export interface DisqualifiedDirectorships {
+    dateDisqualified: string;
+    dateDisqualifiedUntil: string;
+    idReference: string;
+}
+export interface Insolvency {
+    dateDeclared: string;
+    idReference: string;
+    insolvencyType?: InsolvencyTypeList;
+    status?: InsolvencyStatus;
+    statusDate?: string;
+}
+export declare enum InsolvencyTypeList {
+    AssignmentOrArrangement = "Assignment or Arrangement",
+    Bankruptcy = "Bankruptcy",
+    BankruptcySequestrationOrderArrangement = "Bankruptcy Sequestration Order Arrangement",
+    Composition = "Composition",
+    DebtAgreement = "Debt Agreement",
+    PersonalInsolvencyAgreement = "Personal Insolvency Agreement"
+}
+export declare enum InsolvencyStatus {
+    Completed = "Completed",
+    Discharged = "Discharged",
+    Terminated = "Terminated"
+}
+export interface PossibleMatch {
+    address: Address;
+    employerName?: string;
+    person: Person;
+}
+export interface Address {
+    countryCode: string;
+    postcode?: string;
+    state: string;
+    streetName?: string;
+    streetNumber?: string;
+    streetType?: string;
+    suburb: string;
+    unitNumber?: string;
+}
+export interface Person {
+    bureauReference?: string;
+    dateOfBirth?: string;
+    driversLicense?: string;
+    firstName: string;
+    gender?: string;
+    /**
+     * An identifier appended to each known identity of the individual.
+     */
+    idIndex?: string;
+    lastName: string;
+    middleName?: string;
+    /**
+     * 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.
+     */
+    primaryMatchType?: PrimaryMatchType;
+    title?: string;
+}
+/**
+ * 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.
+ */
+export declare enum PrimaryMatchType {
+    Create = "Create",
+    Strong = "Strong"
+}
+export interface PrimaryMatch {
+    address: Address;
+    otherIdentities?: Person[];
+    person: Person;
+}
+export interface SummaryDataPoint {
+    /**
+     * Indicates the data level type of the characteristic. A characteristic can be derived
+     * based on Negative, Partial or Comprehensive
+     */
+    dataLevel?: DataLevel;
+    type: SummaryType;
+    /**
+     * A number will have type 'number' if valid, otherwise 'string'. Default value is 0
+     */
+    value: number | string;
+}
+/**
+ * Indicates the data level type of the characteristic. A characteristic can be derived
+ * based on Negative, Partial or Comprehensive
+ */
+export declare enum DataLevel {
+    Comprehensive = "Comprehensive",
+    Negative = "Negative",
+    Partial = "Partial"
+}
+export declare enum SummaryType {
+    AgeOfCreditFileInMths = "ageOfCreditFileInMths",
+    ClosedAccounts = "closedAccounts",
+    CommercialAdverseFlagOnFileInLast48Or84Months = "commercialAdverseFlagOnFileInLast48Or84Months",
+    ConsumerAdverseFlagOnFileInLast48Or84Months = "consumerAdverseFlagOnFileInLast48Or84Months",
+    CreditEnquiriesInLast5Years = "creditEnquiriesInLast5Years",
+    CurrentDirectorships = "currentDirectorships",
+    DefaultsLast12Months = "defaultsLast12Months",
+    DefaultsLast5To7Years = "defaultsLast5To7Years",
+    DefaultsLast6Months = "defaultsLast6Months",
+    FinancialHardshipIndicatorsInLast12Months = "financialHardshipIndicatorsInLast12Months",
+    InsolvenciesAndActions = "insolvenciesAndActions",
+    NumBankruptOnlyInsolvenciesOnFile = "numBankruptOnlyInsolvenciesOnFile",
+    NumConsumerEnquiriesInLast12Months = "numConsumerEnquiriesInLast12Months",
+    NumCourtWritsInLast60Months = "numCourtWritsInLast60Months",
+    NumJudgementsInLast60Months = "numJudgementsInLast60Months",
+    NumOpenAutoAccounts = "numOpenAutoAccounts",
+    NumOpenChargeCardAccounts = "numOpenChargeCardAccounts",
+    NumOpenCreditCardAccounts = "numOpenCreditCardAccounts",
+    NumOpenMortgageAccounts = "numOpenMortgageAccounts",
+    NumOpenOverdraftAccounts = "numOpenOverdraftAccounts",
+    NumOpenPersonalLoanAccounts = "numOpenPersonalLoanAccounts",
+    NumOpenRentalAccounts = "numOpenRentalAccounts",
+    NumUnpaidOrUnsettledCourtWritsInLast60Months = "numUnpaidOrUnsettledCourtWritsInLast60Months",
+    NumUnpaidOrUnsettledJudgementsInLast60Months = "numUnpaidOrUnsettledJudgementsInLast60Months",
+    NumberOfCommercialDisqualifiedDirectorshipsInLast60Months = "numberOfCommercialDisqualifiedDirectorshipsInLast60Months",
+    OpenedAccounts = "openedAccounts",
+    PreviousDirectorships = "previousDirectorships",
+    WorstClosedInLast24Months = "worstClosedInLast24Months",
+    WorstOpenAccountStatus = "worstOpenAccountStatus",
+    WorstOpenInLast12Months = "worstOpenInLast12Months",
+    WorstOpenInLast24Months = "worstOpenInLast24Months"
 }
 /**
  * A list of credit report service provider
@@ -30,7 +500,93 @@ export interface PayloadObject {
 export declare enum Source {
     Equifax = "equifax"
 }
-export declare enum Type {
+/**
+ * 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.
+ *
+ * Transformed credit report object
+ */
+export interface TransformedCreditReport {
+    consumerEnquiries?: TransformedConsumerCreditFile;
+}
+/**
+ * Transformed credit report of the consumer enquiries
+ */
+export interface TransformedConsumerCreditFile {
+    accounts?: TransformedConsumerEnquiryAccount[];
+}
+/**
+ * Transformed credit report of the consumer enquiries account
+ */
+export interface TransformedConsumerEnquiryAccount {
+    accountId: string;
+    /**
+     * Account type of the consumer enquiries that has been transformed to Lendi values
+     */
+    accountType?: LendiConsumerAccountTypeList;
+    /**
+     * The repayment history of the consumer enquiries with its code has been transformed to
+     * Lendi values
+     */
+    repaymentHistory?: TransformedConsumerEnquiryRepaymentHistory[];
+}
+/**
+ * Account type of the consumer enquiries that has been transformed to Lendi values
+ *
+ * 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
+ */
+export declare enum LendiConsumerAccountTypeList {
+    BnplAccounts = "BNPL_ACCOUNTS",
+    CarLoans = "CAR_LOANS",
+    CreditChargeCards = "CREDIT_CHARGE_CARDS",
+    HomeLoans = "HOME_LOANS",
+    Leases = "LEASES",
+    Overdrafts = "OVERDRAFTS",
+    PersonalLoans = "PERSONAL_LOANS",
+    Unknown = "UNKNOWN"
+}
+/**
+ * Transformed repayment history of the consumer enquiries account
+ */
+export interface TransformedConsumerEnquiryRepaymentHistory {
+    /**
+     * Repayment history code.
+     */
+    code?: LendiRepaymentStatusCode;
+    /**
+     * Repayment history period.
+     */
+    period?: string;
+    /**
+     * Repayment history status.
+     */
+    status?: RepaymentStatusList;
+}
+/**
+ * Repayment history code.
+ *
+ * Equifax Repayment history code in Lendi value
+ */
+export declare enum LendiRepaymentStatusCode {
+    Closed = "CLOSED",
+    NotApplicable = "NOT_APPLICABLE",
+    NotAssociated = "NOT_ASSOCIATED",
+    NotOverdue = "NOT_OVERDUE",
+    NotReported = "NOT_REPORTED",
+    OtherCase = "OTHER_CASE",
+    OverdueMorethan180Days = "OVERDUE_MORETHAN_180DAYS",
+    OverdueUpto119Days = "OVERDUE_UPTO_119DAYS",
+    OverdueUpto149Days = "OVERDUE_UPTO_149DAYS",
+    OverdueUpto179Days = "OVERDUE_UPTO_179DAYS",
+    OverdueUpto29Days = "OVERDUE_UPTO_29DAYS",
+    OverdueUpto59Days = "OVERDUE_UPTO_59DAYS",
+    OverdueUpto89Days = "OVERDUE_UPTO_89DAYS",
+    Pending = "PENDING",
+    Transferred = "TRANSFERRED"
+}
+export declare enum CreditReportRetrievedType {
     CreditReportNoMatch = "CreditReportNoMatch",
     CreditReportRetrieved = "CreditReportRetrieved"
 }