@matech/thebigpos-sdk 2.29.1 → 2.29.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.husky/pre-commit +2 -2
- package/LICENSE +21 -21
- package/README.md +44 -44
- package/dist/index.d.ts +1363 -359
- package/dist/index.js +34 -2
- package/dist/index.js.map +1 -1
- package/package.json +39 -39
- package/scripts/apply-json-patch-content-type.js +56 -56
- package/src/index.ts +1594 -355
- package/tsconfig.json +27 -27
package/src/index.ts
CHANGED
|
@@ -43,6 +43,12 @@ export type OperationType =
|
|
|
43
43
|
|
|
44
44
|
export type LogLevel = "None" | "Info" | "Warning" | "Error";
|
|
45
45
|
|
|
46
|
+
export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
|
|
47
|
+
|
|
48
|
+
export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
|
|
49
|
+
|
|
50
|
+
export type LoanTitleHeld = "Self" | "JointlyWithSpouse" | "JointlyWithAnother";
|
|
51
|
+
|
|
46
52
|
export type LoanRole =
|
|
47
53
|
| "Borrower"
|
|
48
54
|
| "CoBorrower"
|
|
@@ -57,6 +63,8 @@ export type LoanRole =
|
|
|
57
63
|
| "EscrowAgent"
|
|
58
64
|
| "SettlementAgent";
|
|
59
65
|
|
|
66
|
+
export type LoanRealEstateStatus = "Sold" | "Pending" | "Retained";
|
|
67
|
+
|
|
60
68
|
export type LoanQueueType =
|
|
61
69
|
| "Unknown"
|
|
62
70
|
| "New"
|
|
@@ -68,6 +76,96 @@ export type LoanQueueType =
|
|
|
68
76
|
|
|
69
77
|
export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
|
|
70
78
|
|
|
79
|
+
export type LoanPurpose = "Purchase" | "Refinance";
|
|
80
|
+
|
|
81
|
+
export type LoanPropertyType =
|
|
82
|
+
| "SingleFamily"
|
|
83
|
+
| "MultiFamily"
|
|
84
|
+
| "Condominium"
|
|
85
|
+
| "Townhouse"
|
|
86
|
+
| "ManufacturedHome"
|
|
87
|
+
| "PlannedUnitDevelopment"
|
|
88
|
+
| "ModularHome"
|
|
89
|
+
| "Other";
|
|
90
|
+
|
|
91
|
+
export type LoanPhoneNumberType = "Home" | "Cell" | "Work" | "Fax" | "Other";
|
|
92
|
+
|
|
93
|
+
export type LoanPacificIslanderRace =
|
|
94
|
+
| "NativeHawaiian"
|
|
95
|
+
| "GuamanianOrChamorro"
|
|
96
|
+
| "Samoan"
|
|
97
|
+
| "Other";
|
|
98
|
+
|
|
99
|
+
export type LoanOtherLiabilityType =
|
|
100
|
+
| "Alimony"
|
|
101
|
+
| "ChildSupport"
|
|
102
|
+
| "SeparateMaintenance"
|
|
103
|
+
| "JobRelatedExpense"
|
|
104
|
+
| "Other";
|
|
105
|
+
|
|
106
|
+
export type LoanOtherIncomeType =
|
|
107
|
+
| "Alimony"
|
|
108
|
+
| "AutomobileAllowance"
|
|
109
|
+
| "BoarderIncome"
|
|
110
|
+
| "CapitalGains"
|
|
111
|
+
| "ChildSupport"
|
|
112
|
+
| "Disability"
|
|
113
|
+
| "FosterCare"
|
|
114
|
+
| "Housing"
|
|
115
|
+
| "InterestAndDividends"
|
|
116
|
+
| "MortgageCreditCertificate"
|
|
117
|
+
| "MortgageDifferentialPayments"
|
|
118
|
+
| "NotesReceivable"
|
|
119
|
+
| "PublicAssistance"
|
|
120
|
+
| "Retirement"
|
|
121
|
+
| "RoyaltyPayments"
|
|
122
|
+
| "SeparateMaintenance"
|
|
123
|
+
| "SocialSecurity"
|
|
124
|
+
| "Trust"
|
|
125
|
+
| "Unemployment"
|
|
126
|
+
| "VaCompensation"
|
|
127
|
+
| "Other";
|
|
128
|
+
|
|
129
|
+
export type LoanOtherAssetType =
|
|
130
|
+
| "ProceedsRealEstate"
|
|
131
|
+
| "ProceedsNonRealEstate"
|
|
132
|
+
| "SecuredBorrowerFunds"
|
|
133
|
+
| "UnsecuredBorrowerFunds"
|
|
134
|
+
| "EarnestMoney"
|
|
135
|
+
| "EmployerAssistance"
|
|
136
|
+
| "LotEquity"
|
|
137
|
+
| "ReAddressFunds"
|
|
138
|
+
| "RentCredit"
|
|
139
|
+
| "SweatEquity"
|
|
140
|
+
| "TradeEquity"
|
|
141
|
+
| "Other";
|
|
142
|
+
|
|
143
|
+
export type LoanOccupancyType =
|
|
144
|
+
| "PrimaryResidence"
|
|
145
|
+
| "SecondHome"
|
|
146
|
+
| "InvestmentProperty"
|
|
147
|
+
| "Other";
|
|
148
|
+
|
|
149
|
+
export type LoanNameSuffix =
|
|
150
|
+
| "Jr"
|
|
151
|
+
| "Sr"
|
|
152
|
+
| "II"
|
|
153
|
+
| "III"
|
|
154
|
+
| "IV"
|
|
155
|
+
| "V"
|
|
156
|
+
| "VI"
|
|
157
|
+
| "VII";
|
|
158
|
+
|
|
159
|
+
export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
|
|
160
|
+
|
|
161
|
+
export type LoanMilitaryServiceType =
|
|
162
|
+
| "Current"
|
|
163
|
+
| "RetiredDischargedSeparated"
|
|
164
|
+
| "NonActivatedNationalGuard"
|
|
165
|
+
| "SurvivingSpouse";
|
|
166
|
+
|
|
167
|
+
export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
|
|
168
|
+
|
|
71
169
|
export type LoanLogType =
|
|
72
170
|
| "Loan"
|
|
73
171
|
| "Queue"
|
|
@@ -82,6 +180,24 @@ export type LoanLogType =
|
|
|
82
180
|
| "LoanStatusChanged"
|
|
83
181
|
| "EConsent";
|
|
84
182
|
|
|
183
|
+
export type LoanLienPosition = "First" | "Subordinate";
|
|
184
|
+
|
|
185
|
+
export type LoanLiabilityType =
|
|
186
|
+
| "Revolving"
|
|
187
|
+
| "Installment"
|
|
188
|
+
| "Open30Day"
|
|
189
|
+
| "Lease"
|
|
190
|
+
| "Other";
|
|
191
|
+
|
|
192
|
+
export type LoanLanguagePreference =
|
|
193
|
+
| "English"
|
|
194
|
+
| "Chinese"
|
|
195
|
+
| "Korean"
|
|
196
|
+
| "Spanish"
|
|
197
|
+
| "Tagalog"
|
|
198
|
+
| "Vietnamese"
|
|
199
|
+
| "Other";
|
|
200
|
+
|
|
85
201
|
export type LoanImportStatus =
|
|
86
202
|
| "WaitingProcess"
|
|
87
203
|
| "InProgress"
|
|
@@ -91,6 +207,69 @@ export type LoanImportStatus =
|
|
|
91
207
|
|
|
92
208
|
export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
|
|
93
209
|
|
|
210
|
+
export type LoanHousingType = "NoExpense" | "Own" | "Rent";
|
|
211
|
+
|
|
212
|
+
export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
|
|
213
|
+
|
|
214
|
+
export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
|
|
215
|
+
|
|
216
|
+
export type LoanHispanicEthnicity =
|
|
217
|
+
| "Mexican"
|
|
218
|
+
| "PuertoRican"
|
|
219
|
+
| "Cuban"
|
|
220
|
+
| "Other";
|
|
221
|
+
|
|
222
|
+
export type LoanGiftSource =
|
|
223
|
+
| "CommunityNonProfit"
|
|
224
|
+
| "Employer"
|
|
225
|
+
| "FederalAgency"
|
|
226
|
+
| "LocalAgency"
|
|
227
|
+
| "Relative"
|
|
228
|
+
| "ReligiousNonProfit"
|
|
229
|
+
| "StateAgency"
|
|
230
|
+
| "UnmarriedPartner"
|
|
231
|
+
| "Lender"
|
|
232
|
+
| "Other";
|
|
233
|
+
|
|
234
|
+
export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
|
|
235
|
+
|
|
236
|
+
export type LoanGenderType = "Male" | "Female";
|
|
237
|
+
|
|
238
|
+
export type LoanCitizenship =
|
|
239
|
+
| "Us"
|
|
240
|
+
| "PermanentResidentAlien"
|
|
241
|
+
| "NonPermanentResidentAlien";
|
|
242
|
+
|
|
243
|
+
export type LoanBankruptcyType =
|
|
244
|
+
| "Chapter7"
|
|
245
|
+
| "Chapter11"
|
|
246
|
+
| "Chapter12"
|
|
247
|
+
| "Chapter13";
|
|
248
|
+
|
|
249
|
+
export type LoanAsianRace =
|
|
250
|
+
| "AsianIndian"
|
|
251
|
+
| "Chinese"
|
|
252
|
+
| "Filipino"
|
|
253
|
+
| "Japanese"
|
|
254
|
+
| "Korean"
|
|
255
|
+
| "Vietnamese"
|
|
256
|
+
| "Other";
|
|
257
|
+
|
|
258
|
+
export type LoanAccountAssetType =
|
|
259
|
+
| "Checking"
|
|
260
|
+
| "Savings"
|
|
261
|
+
| "MoneyMarket"
|
|
262
|
+
| "CertificateOfDeposit"
|
|
263
|
+
| "MutualFund"
|
|
264
|
+
| "Stocks"
|
|
265
|
+
| "Bonds"
|
|
266
|
+
| "Retirement"
|
|
267
|
+
| "BridgeLoanProceeds"
|
|
268
|
+
| "IndividualDevelopmentAccount"
|
|
269
|
+
| "TrustAccount"
|
|
270
|
+
| "CashValueOfLifeInsurance"
|
|
271
|
+
| "Other";
|
|
272
|
+
|
|
94
273
|
export type LoanAccessScopeType = "User" | "Branch";
|
|
95
274
|
|
|
96
275
|
export type LOSStatus =
|
|
@@ -135,6 +314,41 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
|
135
314
|
|
|
136
315
|
export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
137
316
|
|
|
317
|
+
export type AddressFamily =
|
|
318
|
+
| "Unspecified"
|
|
319
|
+
| "Unix"
|
|
320
|
+
| "InterNetwork"
|
|
321
|
+
| "ImpLink"
|
|
322
|
+
| "Pup"
|
|
323
|
+
| "Chaos"
|
|
324
|
+
| "NS"
|
|
325
|
+
| "Ipx"
|
|
326
|
+
| "Iso"
|
|
327
|
+
| "Osi"
|
|
328
|
+
| "Ecma"
|
|
329
|
+
| "DataKit"
|
|
330
|
+
| "Ccitt"
|
|
331
|
+
| "Sna"
|
|
332
|
+
| "DecNet"
|
|
333
|
+
| "DataLink"
|
|
334
|
+
| "Lat"
|
|
335
|
+
| "HyperChannel"
|
|
336
|
+
| "AppleTalk"
|
|
337
|
+
| "NetBios"
|
|
338
|
+
| "VoiceView"
|
|
339
|
+
| "FireFox"
|
|
340
|
+
| "Banyan"
|
|
341
|
+
| "Atm"
|
|
342
|
+
| "InterNetworkV6"
|
|
343
|
+
| "Cluster"
|
|
344
|
+
| "Ieee12844"
|
|
345
|
+
| "Irda"
|
|
346
|
+
| "NetworkDesigners"
|
|
347
|
+
| "Max"
|
|
348
|
+
| "Packet"
|
|
349
|
+
| "ControllerAreaNetwork"
|
|
350
|
+
| "Unknown";
|
|
351
|
+
|
|
138
352
|
export interface ASOSettings {
|
|
139
353
|
enabled: boolean;
|
|
140
354
|
softPull: boolean;
|
|
@@ -236,6 +450,18 @@ export interface AddressRequest {
|
|
|
236
450
|
postalCode: string;
|
|
237
451
|
}
|
|
238
452
|
|
|
453
|
+
export interface AddressV3 {
|
|
454
|
+
/** @format uuid */
|
|
455
|
+
id?: string | null;
|
|
456
|
+
street?: string | null;
|
|
457
|
+
unit?: string | null;
|
|
458
|
+
unitType?: string | null;
|
|
459
|
+
city?: string | null;
|
|
460
|
+
state?: string | null;
|
|
461
|
+
county?: string | null;
|
|
462
|
+
postalCode?: string | null;
|
|
463
|
+
}
|
|
464
|
+
|
|
239
465
|
export interface AdminAccessGetForms {
|
|
240
466
|
/** @format date-time */
|
|
241
467
|
createdAt?: string | null;
|
|
@@ -694,7 +920,7 @@ export interface CorporateSearchCriteria {
|
|
|
694
920
|
}
|
|
695
921
|
|
|
696
922
|
export interface CreateAccessScopeRequest {
|
|
697
|
-
scopeType:
|
|
923
|
+
scopeType: "User" | "Branch";
|
|
698
924
|
/** @format uuid */
|
|
699
925
|
userId?: string | null;
|
|
700
926
|
/** @format uuid */
|
|
@@ -718,7 +944,7 @@ export interface CreateAccountRequest {
|
|
|
718
944
|
*/
|
|
719
945
|
nlmsid: number;
|
|
720
946
|
settings: AccountSettingsRequest;
|
|
721
|
-
environment:
|
|
947
|
+
environment: "Development" | "Staging" | "UAT" | "Production";
|
|
722
948
|
losIntegration: LOSIntegration;
|
|
723
949
|
}
|
|
724
950
|
|
|
@@ -750,7 +976,19 @@ export interface CreateDocumentTemplateRequest {
|
|
|
750
976
|
export interface CreateGroupMemberRequest {
|
|
751
977
|
/** @format uuid */
|
|
752
978
|
userId: string;
|
|
753
|
-
loanRole:
|
|
979
|
+
loanRole:
|
|
980
|
+
| "Borrower"
|
|
981
|
+
| "CoBorrower"
|
|
982
|
+
| "NonBorrower"
|
|
983
|
+
| "LoanOfficer"
|
|
984
|
+
| "LoanProcessor"
|
|
985
|
+
| "LoanOfficerAssistant"
|
|
986
|
+
| "SupportingLoanOfficer"
|
|
987
|
+
| "BuyerAgent"
|
|
988
|
+
| "SellerAgent"
|
|
989
|
+
| "TitleInsuranceAgent"
|
|
990
|
+
| "EscrowAgent"
|
|
991
|
+
| "SettlementAgent";
|
|
754
992
|
}
|
|
755
993
|
|
|
756
994
|
export interface CreateInviteRequest {
|
|
@@ -762,7 +1000,7 @@ export interface CreateInviteRequest {
|
|
|
762
1000
|
emailAddress: string;
|
|
763
1001
|
phoneNumber?: string | null;
|
|
764
1002
|
/** @deprecated */
|
|
765
|
-
relationship:
|
|
1003
|
+
relationship: "NotApplicable" | "Spouse" | "NonSpouse";
|
|
766
1004
|
loanID: string;
|
|
767
1005
|
route?: string | null;
|
|
768
1006
|
/** @format uuid */
|
|
@@ -790,7 +1028,7 @@ export interface CreateLoanImportRequest {
|
|
|
790
1028
|
* @minLength 1
|
|
791
1029
|
*/
|
|
792
1030
|
startDate: string;
|
|
793
|
-
importMode:
|
|
1031
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
794
1032
|
}
|
|
795
1033
|
|
|
796
1034
|
export interface CreateUserDeviceRequest {
|
|
@@ -798,7 +1036,19 @@ export interface CreateUserDeviceRequest {
|
|
|
798
1036
|
}
|
|
799
1037
|
|
|
800
1038
|
export interface CreateUserDraft {
|
|
801
|
-
loanRole:
|
|
1039
|
+
loanRole:
|
|
1040
|
+
| "Borrower"
|
|
1041
|
+
| "CoBorrower"
|
|
1042
|
+
| "NonBorrower"
|
|
1043
|
+
| "LoanOfficer"
|
|
1044
|
+
| "LoanProcessor"
|
|
1045
|
+
| "LoanOfficerAssistant"
|
|
1046
|
+
| "SupportingLoanOfficer"
|
|
1047
|
+
| "BuyerAgent"
|
|
1048
|
+
| "SellerAgent"
|
|
1049
|
+
| "TitleInsuranceAgent"
|
|
1050
|
+
| "EscrowAgent"
|
|
1051
|
+
| "SettlementAgent";
|
|
802
1052
|
}
|
|
803
1053
|
|
|
804
1054
|
export interface CreateUserGroupRequest {
|
|
@@ -1085,7 +1335,7 @@ export interface Draft {
|
|
|
1085
1335
|
siteConfiguration: SiteConfigurationReduced;
|
|
1086
1336
|
/** @format uuid */
|
|
1087
1337
|
loanID?: string | null;
|
|
1088
|
-
type:
|
|
1338
|
+
type: "NewLoan" | "EditLoan";
|
|
1089
1339
|
isCoBorrower: boolean;
|
|
1090
1340
|
}
|
|
1091
1341
|
|
|
@@ -1104,7 +1354,7 @@ export interface DraftContent {
|
|
|
1104
1354
|
siteConfiguration: SiteConfigurationReduced;
|
|
1105
1355
|
/** @format uuid */
|
|
1106
1356
|
loanID?: string | null;
|
|
1107
|
-
type:
|
|
1357
|
+
type: "NewLoan" | "EditLoan";
|
|
1108
1358
|
isCoBorrower: boolean;
|
|
1109
1359
|
applicationPayload: any;
|
|
1110
1360
|
}
|
|
@@ -1402,7 +1652,20 @@ export interface FusionFieldDisplay {
|
|
|
1402
1652
|
}
|
|
1403
1653
|
|
|
1404
1654
|
export interface FusionReportFilter {
|
|
1405
|
-
filterType:
|
|
1655
|
+
filterType:
|
|
1656
|
+
| "DateGreaterThanOrEqualTo"
|
|
1657
|
+
| "DateGreaterThan"
|
|
1658
|
+
| "DateLessThan"
|
|
1659
|
+
| "DateLessThanOrEqualTo"
|
|
1660
|
+
| "DateEquals"
|
|
1661
|
+
| "DateDoesntEqual"
|
|
1662
|
+
| "DateNonEmpty"
|
|
1663
|
+
| "DateEmpty"
|
|
1664
|
+
| "StringContains"
|
|
1665
|
+
| "StringEquals"
|
|
1666
|
+
| "StringNotEmpty"
|
|
1667
|
+
| "StringNotEquals"
|
|
1668
|
+
| "StringNotContains";
|
|
1406
1669
|
targetField: string;
|
|
1407
1670
|
targetValue: string;
|
|
1408
1671
|
}
|
|
@@ -1522,8 +1785,65 @@ export interface GetWorkflowRequest {
|
|
|
1522
1785
|
language?: string | null;
|
|
1523
1786
|
}
|
|
1524
1787
|
|
|
1788
|
+
export interface GuidPatchOperation {
|
|
1789
|
+
op: string;
|
|
1790
|
+
path: string;
|
|
1791
|
+
value?: any;
|
|
1792
|
+
from?: string | null;
|
|
1793
|
+
}
|
|
1794
|
+
|
|
1525
1795
|
export type IContractResolver = object;
|
|
1526
1796
|
|
|
1797
|
+
export interface IPAddress {
|
|
1798
|
+
addressFamily:
|
|
1799
|
+
| "Unspecified"
|
|
1800
|
+
| "Unix"
|
|
1801
|
+
| "InterNetwork"
|
|
1802
|
+
| "ImpLink"
|
|
1803
|
+
| "Pup"
|
|
1804
|
+
| "Chaos"
|
|
1805
|
+
| "NS"
|
|
1806
|
+
| "Ipx"
|
|
1807
|
+
| "Iso"
|
|
1808
|
+
| "Osi"
|
|
1809
|
+
| "Ecma"
|
|
1810
|
+
| "DataKit"
|
|
1811
|
+
| "Ccitt"
|
|
1812
|
+
| "Sna"
|
|
1813
|
+
| "DecNet"
|
|
1814
|
+
| "DataLink"
|
|
1815
|
+
| "Lat"
|
|
1816
|
+
| "HyperChannel"
|
|
1817
|
+
| "AppleTalk"
|
|
1818
|
+
| "NetBios"
|
|
1819
|
+
| "VoiceView"
|
|
1820
|
+
| "FireFox"
|
|
1821
|
+
| "Banyan"
|
|
1822
|
+
| "Atm"
|
|
1823
|
+
| "InterNetworkV6"
|
|
1824
|
+
| "Cluster"
|
|
1825
|
+
| "Ieee12844"
|
|
1826
|
+
| "Irda"
|
|
1827
|
+
| "NetworkDesigners"
|
|
1828
|
+
| "Max"
|
|
1829
|
+
| "Packet"
|
|
1830
|
+
| "ControllerAreaNetwork"
|
|
1831
|
+
| "Unknown";
|
|
1832
|
+
/** @format int64 */
|
|
1833
|
+
scopeId: number;
|
|
1834
|
+
isIPv6Multicast: boolean;
|
|
1835
|
+
isIPv6LinkLocal: boolean;
|
|
1836
|
+
isIPv6SiteLocal: boolean;
|
|
1837
|
+
isIPv6Teredo: boolean;
|
|
1838
|
+
isIPv6UniqueLocal: boolean;
|
|
1839
|
+
isIPv4MappedToIPv6: boolean;
|
|
1840
|
+
/**
|
|
1841
|
+
* @deprecated
|
|
1842
|
+
* @format int64
|
|
1843
|
+
*/
|
|
1844
|
+
address: number;
|
|
1845
|
+
}
|
|
1846
|
+
|
|
1527
1847
|
export interface ImpersonatedDetailedUser {
|
|
1528
1848
|
/** @format date-time */
|
|
1529
1849
|
createdAt?: string | null;
|
|
@@ -1762,120 +2082,941 @@ export interface Loan {
|
|
|
1762
2082
|
contacts: LoanContact[];
|
|
1763
2083
|
}
|
|
1764
2084
|
|
|
1765
|
-
export interface
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
2085
|
+
export interface LoanApplication {
|
|
2086
|
+
/** @format uuid */
|
|
2087
|
+
id?: string | null;
|
|
2088
|
+
loanOfficerEmail?: string | null;
|
|
2089
|
+
type?: LoanType | null;
|
|
2090
|
+
purpose?: LoanPurpose | null;
|
|
2091
|
+
lienPosition?: LoanLienPosition | null;
|
|
2092
|
+
number?: string | null;
|
|
2093
|
+
program?: string | null;
|
|
2094
|
+
channel?: string | null;
|
|
2095
|
+
/** @format date-time */
|
|
2096
|
+
startDate?: string | null;
|
|
2097
|
+
property?: LoanProperty | null;
|
|
2098
|
+
financial?: LoanFinancial | null;
|
|
2099
|
+
borrowers: LoanBorrower[];
|
|
2100
|
+
nonOwningBorrowers: LoanNonOwningBorrower[];
|
|
1769
2101
|
}
|
|
1770
2102
|
|
|
1771
|
-
export interface
|
|
2103
|
+
export interface LoanApplicationRequest {
|
|
2104
|
+
/** @format uuid */
|
|
2105
|
+
accountID: string;
|
|
2106
|
+
/** @format uuid */
|
|
2107
|
+
userID: string;
|
|
2108
|
+
/** @format uuid */
|
|
2109
|
+
siteConfigurationID: string;
|
|
2110
|
+
/** @format uuid */
|
|
2111
|
+
draftId?: string | null;
|
|
2112
|
+
loanOfficerEmail?: string | null;
|
|
2113
|
+
type?: LoanType | null;
|
|
2114
|
+
purpose?: LoanPurpose | null;
|
|
2115
|
+
lienPosition?: LoanLienPosition | null;
|
|
2116
|
+
/** @maxLength 50 */
|
|
2117
|
+
number?: string | null;
|
|
2118
|
+
/** @maxLength 100 */
|
|
2119
|
+
program?: string | null;
|
|
2120
|
+
/** @maxLength 50 */
|
|
2121
|
+
channel?: string | null;
|
|
2122
|
+
/** @format date-time */
|
|
2123
|
+
startDate?: string | null;
|
|
2124
|
+
property?: LoanPropertyRequest | null;
|
|
2125
|
+
financial?: LoanFinancialRequest | null;
|
|
2126
|
+
/** @minItems 1 */
|
|
2127
|
+
borrowers: LoanBorrowerRequest[];
|
|
2128
|
+
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2129
|
+
/** @format uuid */
|
|
2130
|
+
existingLoanId?: string | null;
|
|
2131
|
+
/** @format uuid */
|
|
2132
|
+
formId?: string | null;
|
|
2133
|
+
}
|
|
2134
|
+
|
|
2135
|
+
export interface LoanBorrower {
|
|
2136
|
+
/** @format uuid */
|
|
2137
|
+
id?: string | null;
|
|
2138
|
+
ssn?: string | null;
|
|
2139
|
+
email?: string | null;
|
|
2140
|
+
lastName?: string | null;
|
|
2141
|
+
firstName?: string | null;
|
|
2142
|
+
middleName?: string | null;
|
|
2143
|
+
prefix?: LoanNamePrefix | null;
|
|
2144
|
+
suffix?: LoanNameSuffix | null;
|
|
2145
|
+
/** @format date */
|
|
2146
|
+
birthDate?: string | null;
|
|
2147
|
+
citizenship?: LoanCitizenship | null;
|
|
2148
|
+
maritalStatus?: LoanMaritalStatus | null;
|
|
2149
|
+
languagePreference?: LoanLanguagePreference | null;
|
|
2150
|
+
/** @format int32 */
|
|
2151
|
+
numberOfDependents?: number | null;
|
|
2152
|
+
isPrimaryBorrower: boolean;
|
|
2153
|
+
isFirstTimeHomeBuyer?: boolean | null;
|
|
2154
|
+
hasJointAssetsAndLiabilities?: boolean | null;
|
|
2155
|
+
dependentAges?: number[] | null;
|
|
2156
|
+
demographics?: LoanBorrowerDemographics | null;
|
|
2157
|
+
declarations?: LoanBorrowerDeclarations | null;
|
|
2158
|
+
militaryService?: LoanBorrowerMilitaryService | null;
|
|
2159
|
+
gifts: LoanBorrowerGift[];
|
|
2160
|
+
addresses: LoanBorrowerAddress[];
|
|
2161
|
+
consents: LoanBorrowerConsent[];
|
|
2162
|
+
liabilities: LoanBorrowerLiability[];
|
|
2163
|
+
otherAssets: LoanBorrowerOtherAsset[];
|
|
2164
|
+
otherIncome: LoanBorrowerOtherIncome[];
|
|
2165
|
+
phoneNumbers: LoanBorrowerPhoneNumber[];
|
|
2166
|
+
accountAssets: LoanBorrowerAccountAsset[];
|
|
2167
|
+
homeOwnership: LoanBorrowerHomeOwnership[];
|
|
2168
|
+
alternateNames: LoanBorrowerAlternateName[];
|
|
2169
|
+
otherLiabilities: LoanBorrowerOtherLiability[];
|
|
2170
|
+
realEstateAssets: LoanBorrowerRealEstateAsset[];
|
|
2171
|
+
currentEmployment: LoanBorrowerEmploymentCurrent[];
|
|
2172
|
+
previousEmployment: LoanBorrowerEmploymentPrevious[];
|
|
2173
|
+
}
|
|
2174
|
+
|
|
2175
|
+
export interface LoanBorrowerAccountAsset {
|
|
2176
|
+
/** @format uuid */
|
|
2177
|
+
id?: string | null;
|
|
2178
|
+
name?: string | null;
|
|
2179
|
+
accountNumber?: string | null;
|
|
2180
|
+
financialInstitution?: string | null;
|
|
1772
2181
|
/** @format double */
|
|
1773
|
-
|
|
1774
|
-
|
|
2182
|
+
value?: number | null;
|
|
2183
|
+
type?: LoanAccountAssetType | null;
|
|
1775
2184
|
}
|
|
1776
2185
|
|
|
1777
|
-
export interface
|
|
2186
|
+
export interface LoanBorrowerAccountAssetRequest {
|
|
2187
|
+
/** @maxLength 255 */
|
|
2188
|
+
name?: string | null;
|
|
2189
|
+
/** @maxLength 50 */
|
|
2190
|
+
accountNumber?: string | null;
|
|
2191
|
+
/** @maxLength 255 */
|
|
2192
|
+
financialInstitution?: string | null;
|
|
2193
|
+
/**
|
|
2194
|
+
* @format double
|
|
2195
|
+
* @min 0
|
|
2196
|
+
*/
|
|
2197
|
+
value?: number | null;
|
|
2198
|
+
type?: LoanAccountAssetType | null;
|
|
2199
|
+
}
|
|
2200
|
+
|
|
2201
|
+
export interface LoanBorrowerAddress {
|
|
2202
|
+
/** @format uuid */
|
|
2203
|
+
id?: string | null;
|
|
2204
|
+
street?: string | null;
|
|
2205
|
+
unit?: string | null;
|
|
2206
|
+
unitType?: string | null;
|
|
2207
|
+
city?: string | null;
|
|
2208
|
+
state?: string | null;
|
|
2209
|
+
county?: string | null;
|
|
2210
|
+
postalCode?: string | null;
|
|
2211
|
+
housing?: LoanHousingType | null;
|
|
1778
2212
|
/** @format double */
|
|
1779
|
-
|
|
2213
|
+
rentAmount?: number | null;
|
|
2214
|
+
isCurrent?: boolean | null;
|
|
2215
|
+
isMailingAddress?: boolean | null;
|
|
2216
|
+
timeAtAddress?: TimeAtAddress | null;
|
|
2217
|
+
}
|
|
2218
|
+
|
|
2219
|
+
export interface LoanBorrowerAddressRequest {
|
|
2220
|
+
/** @maxLength 255 */
|
|
2221
|
+
street?: string | null;
|
|
2222
|
+
/** @maxLength 50 */
|
|
2223
|
+
unit?: string | null;
|
|
2224
|
+
/** @maxLength 50 */
|
|
2225
|
+
unitType?: string | null;
|
|
2226
|
+
/** @maxLength 100 */
|
|
2227
|
+
city?: string | null;
|
|
2228
|
+
state?: string | null;
|
|
2229
|
+
/** @maxLength 100 */
|
|
2230
|
+
county?: string | null;
|
|
2231
|
+
postalCode?: string | null;
|
|
2232
|
+
housing?: LoanHousingType | null;
|
|
2233
|
+
/**
|
|
2234
|
+
* @format double
|
|
2235
|
+
* @min 0
|
|
2236
|
+
*/
|
|
2237
|
+
rentAmount?: number | null;
|
|
2238
|
+
isCurrent?: boolean | null;
|
|
2239
|
+
isMailingAddress?: boolean | null;
|
|
2240
|
+
timeAtAddress?: TimeAtAddressRequest | null;
|
|
2241
|
+
}
|
|
2242
|
+
|
|
2243
|
+
export interface LoanBorrowerAlternateName {
|
|
2244
|
+
/** @format uuid */
|
|
2245
|
+
id?: string | null;
|
|
2246
|
+
suffix?: string | null;
|
|
2247
|
+
lastName?: string | null;
|
|
2248
|
+
firstName?: string | null;
|
|
2249
|
+
middleName?: string | null;
|
|
2250
|
+
}
|
|
2251
|
+
|
|
2252
|
+
export interface LoanBorrowerAlternateNameRequest {
|
|
2253
|
+
/** @maxLength 20 */
|
|
2254
|
+
suffix?: string | null;
|
|
2255
|
+
/** @maxLength 100 */
|
|
2256
|
+
lastName?: string | null;
|
|
2257
|
+
/** @maxLength 100 */
|
|
2258
|
+
firstName?: string | null;
|
|
2259
|
+
/** @maxLength 100 */
|
|
2260
|
+
middleName?: string | null;
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2263
|
+
export interface LoanBorrowerBankruptcyDeclaration {
|
|
2264
|
+
/** @format uuid */
|
|
2265
|
+
id?: string | null;
|
|
2266
|
+
isAffirmative?: boolean | null;
|
|
2267
|
+
description?: string | null;
|
|
2268
|
+
types?: LoanBankruptcyType[] | null;
|
|
2269
|
+
}
|
|
2270
|
+
|
|
2271
|
+
export interface LoanBorrowerBankruptcyDeclarationRequest {
|
|
2272
|
+
isAffirmative?: boolean | null;
|
|
2273
|
+
/** @maxLength 1000 */
|
|
2274
|
+
description?: string | null;
|
|
2275
|
+
types?: LoanBankruptcyType[] | null;
|
|
2276
|
+
}
|
|
2277
|
+
|
|
2278
|
+
export interface LoanBorrowerConsent {
|
|
2279
|
+
/** @format uuid */
|
|
2280
|
+
id?: string | null;
|
|
2281
|
+
type?: ConsentType | null;
|
|
2282
|
+
providedConsent?: boolean | null;
|
|
2283
|
+
ipAddress?: IPAddress | null;
|
|
2284
|
+
}
|
|
2285
|
+
|
|
2286
|
+
export interface LoanBorrowerConsentRequest {
|
|
2287
|
+
type?: ConsentType | null;
|
|
2288
|
+
providedConsent?: boolean | null;
|
|
2289
|
+
ipAddress?: IPAddress | null;
|
|
2290
|
+
}
|
|
2291
|
+
|
|
2292
|
+
export interface LoanBorrowerDeclarations {
|
|
2293
|
+
/** @format uuid */
|
|
2294
|
+
id?: string | null;
|
|
2295
|
+
borrowingMoney?: LoanBorrowerMoneyDeclaration | null;
|
|
2296
|
+
bankruptcy?: LoanBorrowerBankruptcyDeclaration | null;
|
|
2297
|
+
primaryResidence?: LoanBorrowerPrimaryResidenceDeclaration | null;
|
|
2298
|
+
foreclosure?: LoanBorrowerSimpleDeclaration | null;
|
|
2299
|
+
coSignerOnDebt?: LoanBorrowerSimpleDeclaration | null;
|
|
2300
|
+
partyToLawsuit?: LoanBorrowerSimpleDeclaration | null;
|
|
2301
|
+
outstandingJudgments?: LoanBorrowerSimpleDeclaration | null;
|
|
2302
|
+
applyingForNewCredit?: LoanBorrowerSimpleDeclaration | null;
|
|
2303
|
+
subjectToLienPriority?: LoanBorrowerSimpleDeclaration | null;
|
|
2304
|
+
inDelinquencyOrDefault?: LoanBorrowerSimpleDeclaration | null;
|
|
2305
|
+
relationshipWithSeller?: LoanBorrowerSimpleDeclaration | null;
|
|
2306
|
+
preForeclosureOrShortSale?: LoanBorrowerSimpleDeclaration | null;
|
|
2307
|
+
applyingForAnotherMortgage?: LoanBorrowerSimpleDeclaration | null;
|
|
2308
|
+
conveyedTitleToPropertyForeclosure?: LoanBorrowerSimpleDeclaration | null;
|
|
2309
|
+
}
|
|
2310
|
+
|
|
2311
|
+
export interface LoanBorrowerDeclarationsRequest {
|
|
2312
|
+
borrowingMoney?: LoanBorrowerMoneyDeclarationRequest | null;
|
|
2313
|
+
bankruptcy?: LoanBorrowerBankruptcyDeclarationRequest | null;
|
|
2314
|
+
primaryResidence?: LoanBorrowerPrimaryResidenceDeclarationRequest | null;
|
|
2315
|
+
foreclosure?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2316
|
+
coSignerOnDebt?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2317
|
+
partyToLawsuit?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2318
|
+
outstandingJudgments?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2319
|
+
applyingForNewCredit?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2320
|
+
subjectToLienPriority?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2321
|
+
inDelinquencyOrDefault?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2322
|
+
relationshipWithSeller?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2323
|
+
preForeclosureOrShortSale?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2324
|
+
applyingForAnotherMortgage?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2325
|
+
conveyedTitleToPropertyForeclosure?: LoanBorrowerSimpleDeclarationRequest | null;
|
|
2326
|
+
}
|
|
2327
|
+
|
|
2328
|
+
export interface LoanBorrowerDemographics {
|
|
2329
|
+
/** @format uuid */
|
|
2330
|
+
id?: string | null;
|
|
2331
|
+
race?: LoanBorrowerDemographicsRace | null;
|
|
2332
|
+
gender?: LoanBorrowerDemographicsGender | null;
|
|
2333
|
+
ethnicity?: LoanBorrowerDemographicsEthnicity | null;
|
|
2334
|
+
}
|
|
2335
|
+
|
|
2336
|
+
export interface LoanBorrowerDemographicsEthnicity {
|
|
2337
|
+
/** @format uuid */
|
|
2338
|
+
id?: string | null;
|
|
2339
|
+
isDeclined?: boolean | null;
|
|
2340
|
+
isHispanicOrLatino?: boolean | null;
|
|
2341
|
+
otherHispanicOrLatino?: string | null;
|
|
2342
|
+
hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
|
|
2343
|
+
}
|
|
2344
|
+
|
|
2345
|
+
export interface LoanBorrowerDemographicsEthnicityRequest {
|
|
2346
|
+
isDeclined?: boolean | null;
|
|
2347
|
+
isHispanicOrLatino?: boolean | null;
|
|
2348
|
+
/** @maxLength 255 */
|
|
2349
|
+
otherHispanicOrLatino?: string | null;
|
|
2350
|
+
hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
|
|
2351
|
+
}
|
|
2352
|
+
|
|
2353
|
+
export interface LoanBorrowerDemographicsGender {
|
|
2354
|
+
/** @format uuid */
|
|
2355
|
+
id?: string | null;
|
|
2356
|
+
isDeclined?: boolean | null;
|
|
2357
|
+
gender?: LoanGenderType | null;
|
|
2358
|
+
}
|
|
2359
|
+
|
|
2360
|
+
export interface LoanBorrowerDemographicsGenderRequest {
|
|
2361
|
+
isDeclined?: boolean | null;
|
|
2362
|
+
gender?: LoanGenderType | null;
|
|
2363
|
+
}
|
|
2364
|
+
|
|
2365
|
+
export interface LoanBorrowerDemographicsRace {
|
|
2366
|
+
/** @format uuid */
|
|
2367
|
+
id?: string | null;
|
|
2368
|
+
isAmericanIndianOrAlaskanNative?: boolean | null;
|
|
2369
|
+
otherAmericanIndianOrAlaskanNative?: string | null;
|
|
2370
|
+
isAsian?: boolean | null;
|
|
2371
|
+
asianRaces?: LoanAsianRace[] | null;
|
|
2372
|
+
otherAsianRace?: string | null;
|
|
2373
|
+
isBlackOrAfrican?: boolean | null;
|
|
2374
|
+
isPacificIslander?: boolean | null;
|
|
2375
|
+
pacificIslanderRace?: LoanPacificIslanderRace[] | null;
|
|
2376
|
+
otherPacificIslanderRace?: string | null;
|
|
2377
|
+
isWhite?: boolean | null;
|
|
2378
|
+
isDeclined?: boolean | null;
|
|
2379
|
+
}
|
|
2380
|
+
|
|
2381
|
+
export interface LoanBorrowerDemographicsRaceRequest {
|
|
2382
|
+
isAmericanIndianOrAlaskanNative?: boolean | null;
|
|
2383
|
+
/** @maxLength 255 */
|
|
2384
|
+
otherAmericanIndianOrAlaskanNative?: string | null;
|
|
2385
|
+
isAsian?: boolean | null;
|
|
2386
|
+
asianRaces?: LoanAsianRace[] | null;
|
|
2387
|
+
/** @maxLength 255 */
|
|
2388
|
+
otherAsianRace?: string | null;
|
|
2389
|
+
isBlackOrAfrican?: boolean | null;
|
|
2390
|
+
isPacificIslander?: boolean | null;
|
|
2391
|
+
pacificIslanderRace?: LoanPacificIslanderRace[] | null;
|
|
2392
|
+
/** @maxLength 255 */
|
|
2393
|
+
otherPacificIslanderRace?: string | null;
|
|
2394
|
+
isWhite?: boolean | null;
|
|
2395
|
+
isDeclined?: boolean | null;
|
|
2396
|
+
}
|
|
2397
|
+
|
|
2398
|
+
export interface LoanBorrowerDemographicsRequest {
|
|
2399
|
+
race?: LoanBorrowerDemographicsRaceRequest | null;
|
|
2400
|
+
gender?: LoanBorrowerDemographicsGenderRequest | null;
|
|
2401
|
+
ethnicity?: LoanBorrowerDemographicsEthnicityRequest | null;
|
|
2402
|
+
}
|
|
2403
|
+
|
|
2404
|
+
export interface LoanBorrowerEmploymentCurrent {
|
|
2405
|
+
/** @format uuid */
|
|
2406
|
+
id?: string | null;
|
|
2407
|
+
name?: string | null;
|
|
2408
|
+
title?: string | null;
|
|
2409
|
+
phoneNumber?: string | null;
|
|
2410
|
+
/** @format date */
|
|
2411
|
+
startDate?: string | null;
|
|
2412
|
+
isSelfEmployed?: boolean | null;
|
|
2413
|
+
isEmployedByPartyInTransaction?: boolean | null;
|
|
2414
|
+
address?: AddressV3 | null;
|
|
2415
|
+
ownership?: LoanBorrowerEmploymentCurrentOwnership | null;
|
|
2416
|
+
grossIncome?: LoanBorrowerEmploymentCurrentGrossIncome | null;
|
|
2417
|
+
timeInLineOfWork?: LoanBorrowerEmploymentCurrentTimeInLineOfWork | null;
|
|
2418
|
+
}
|
|
2419
|
+
|
|
2420
|
+
export interface LoanBorrowerEmploymentCurrentGrossIncome {
|
|
2421
|
+
/** @format uuid */
|
|
2422
|
+
id?: string | null;
|
|
1780
2423
|
/** @format double */
|
|
1781
|
-
|
|
2424
|
+
base?: number | null;
|
|
1782
2425
|
/** @format double */
|
|
1783
|
-
|
|
2426
|
+
other?: number | null;
|
|
1784
2427
|
/** @format double */
|
|
1785
|
-
|
|
2428
|
+
bonus?: number | null;
|
|
1786
2429
|
/** @format double */
|
|
1787
|
-
|
|
1788
|
-
|
|
2430
|
+
overtime?: number | null;
|
|
2431
|
+
/** @format double */
|
|
2432
|
+
commission?: number | null;
|
|
2433
|
+
/** @format double */
|
|
2434
|
+
militaryEntitlements?: number | null;
|
|
1789
2435
|
}
|
|
1790
2436
|
|
|
1791
|
-
export interface
|
|
2437
|
+
export interface LoanBorrowerEmploymentCurrentGrossIncomeRequest {
|
|
1792
2438
|
/**
|
|
1793
2439
|
* @format double
|
|
1794
|
-
* @min
|
|
1795
|
-
* @max 25
|
|
1796
|
-
*/
|
|
1797
|
-
interestRate: number;
|
|
1798
|
-
/**
|
|
1799
|
-
* @format int32
|
|
1800
|
-
* @min 1
|
|
1801
|
-
* @max 40
|
|
2440
|
+
* @min 0
|
|
1802
2441
|
*/
|
|
1803
|
-
|
|
2442
|
+
base?: number | null;
|
|
1804
2443
|
/**
|
|
1805
2444
|
* @format double
|
|
1806
2445
|
* @min 0
|
|
1807
|
-
* @max 3
|
|
1808
2446
|
*/
|
|
1809
|
-
|
|
2447
|
+
other?: number | null;
|
|
1810
2448
|
/**
|
|
1811
2449
|
* @format double
|
|
1812
2450
|
* @min 0
|
|
1813
|
-
* @max 5
|
|
1814
2451
|
*/
|
|
1815
|
-
|
|
2452
|
+
bonus?: number | null;
|
|
1816
2453
|
/**
|
|
1817
2454
|
* @format double
|
|
1818
|
-
* @min
|
|
1819
|
-
* @max 100000
|
|
2455
|
+
* @min 0
|
|
1820
2456
|
*/
|
|
1821
|
-
|
|
2457
|
+
overtime?: number | null;
|
|
1822
2458
|
/**
|
|
1823
2459
|
* @format double
|
|
1824
|
-
* @min
|
|
1825
|
-
* @max 10000000
|
|
2460
|
+
* @min 0
|
|
1826
2461
|
*/
|
|
1827
|
-
|
|
2462
|
+
commission?: number | null;
|
|
1828
2463
|
/**
|
|
1829
2464
|
* @format double
|
|
1830
2465
|
* @min 0
|
|
1831
|
-
* @max 10
|
|
1832
2466
|
*/
|
|
1833
|
-
|
|
2467
|
+
militaryEntitlements?: number | null;
|
|
1834
2468
|
}
|
|
1835
2469
|
|
|
1836
|
-
export interface
|
|
2470
|
+
export interface LoanBorrowerEmploymentCurrentOwnership {
|
|
2471
|
+
/** @format uuid */
|
|
2472
|
+
id?: string | null;
|
|
2473
|
+
isOwner?: boolean | null;
|
|
2474
|
+
hasOwnershipOver25Percent?: boolean | null;
|
|
2475
|
+
/** @format double */
|
|
2476
|
+
monthlyIncome?: number | null;
|
|
2477
|
+
}
|
|
2478
|
+
|
|
2479
|
+
export interface LoanBorrowerEmploymentCurrentOwnershipRequest {
|
|
2480
|
+
isOwner?: boolean | null;
|
|
2481
|
+
hasOwnershipOver25Percent?: boolean | null;
|
|
1837
2482
|
/**
|
|
1838
2483
|
* @format double
|
|
1839
|
-
* @min
|
|
2484
|
+
* @min 0
|
|
1840
2485
|
*/
|
|
1841
|
-
|
|
1842
|
-
loans: LoanComparisonCalculatorLoanRequest[];
|
|
1843
|
-
}
|
|
1844
|
-
|
|
1845
|
-
export interface LoanComparisonScenario {
|
|
1846
|
-
loanProgram?: string | null;
|
|
1847
|
-
/** @minLength 1 */
|
|
1848
|
-
loanType: string;
|
|
1849
|
-
propertyValue?: string | null;
|
|
1850
|
-
purchasePrice?: string | null;
|
|
1851
|
-
downpaymentAmount?: string | null;
|
|
1852
|
-
downpaymentPercent?: string | null;
|
|
1853
|
-
loanAmount?: string | null;
|
|
1854
|
-
totalAssets?: string | null;
|
|
1855
|
-
monthlyPayment?: string | null;
|
|
1856
|
-
totalMortgageAmount?: string | null;
|
|
1857
|
-
dtiFront?: string | null;
|
|
1858
|
-
dtiBack?: string | null;
|
|
1859
|
-
ltvFront?: string | null;
|
|
1860
|
-
ltvBack?: string | null;
|
|
1861
|
-
totalCashToClose?: string | null;
|
|
1862
|
-
apr?: string | null;
|
|
1863
|
-
mi?: string | null;
|
|
1864
|
-
miFactor?: string | null;
|
|
1865
|
-
rate?: string | null;
|
|
1866
|
-
loanTerm1?: string | null;
|
|
1867
|
-
loanTerm2?: string | null;
|
|
1868
|
-
closingCosts?: string | null;
|
|
1869
|
-
prepaidCharges?: string | null;
|
|
1870
|
-
totalCost?: string | null;
|
|
1871
|
-
totalFinancing?: string | null;
|
|
1872
|
-
discount?: string | null;
|
|
1873
|
-
lenderCredit?: string | null;
|
|
1874
|
-
fundingFee?: string | null;
|
|
2486
|
+
monthlyIncome?: number | null;
|
|
1875
2487
|
}
|
|
1876
2488
|
|
|
1877
|
-
export interface
|
|
1878
|
-
/** @
|
|
2489
|
+
export interface LoanBorrowerEmploymentCurrentRequest {
|
|
2490
|
+
/** @maxLength 255 */
|
|
2491
|
+
name?: string | null;
|
|
2492
|
+
/** @maxLength 100 */
|
|
2493
|
+
title?: string | null;
|
|
2494
|
+
phoneNumber?: string | null;
|
|
2495
|
+
/** @format date */
|
|
2496
|
+
startDate?: string | null;
|
|
2497
|
+
isSelfEmployed?: boolean | null;
|
|
2498
|
+
isEmployedByPartyInTransaction?: boolean | null;
|
|
2499
|
+
address?: AddressRequest | null;
|
|
2500
|
+
ownership?: LoanBorrowerEmploymentCurrentOwnershipRequest | null;
|
|
2501
|
+
grossIncome?: LoanBorrowerEmploymentCurrentGrossIncomeRequest | null;
|
|
2502
|
+
timeInLineOfWork?: LoanBorrowerEmploymentCurrentTimeInLineOfWorkRequest | null;
|
|
2503
|
+
}
|
|
2504
|
+
|
|
2505
|
+
export interface LoanBorrowerEmploymentCurrentTimeInLineOfWork {
|
|
2506
|
+
/** @format uuid */
|
|
2507
|
+
id?: string | null;
|
|
2508
|
+
/** @format int32 */
|
|
2509
|
+
years?: number | null;
|
|
2510
|
+
/** @format int32 */
|
|
2511
|
+
months?: number | null;
|
|
2512
|
+
}
|
|
2513
|
+
|
|
2514
|
+
export interface LoanBorrowerEmploymentCurrentTimeInLineOfWorkRequest {
|
|
2515
|
+
/** @format int32 */
|
|
2516
|
+
years?: number | null;
|
|
2517
|
+
/** @format int32 */
|
|
2518
|
+
months?: number | null;
|
|
2519
|
+
}
|
|
2520
|
+
|
|
2521
|
+
export interface LoanBorrowerEmploymentPrevious {
|
|
2522
|
+
/** @format uuid */
|
|
2523
|
+
id?: string | null;
|
|
2524
|
+
name?: string | null;
|
|
2525
|
+
title?: string | null;
|
|
2526
|
+
phoneNumber?: string | null;
|
|
2527
|
+
/** @format date */
|
|
2528
|
+
startDate?: string | null;
|
|
2529
|
+
/** @format date */
|
|
2530
|
+
endDate?: string | null;
|
|
2531
|
+
/** @format double */
|
|
2532
|
+
grossIncome?: number | null;
|
|
2533
|
+
isSelfEmployed?: boolean | null;
|
|
2534
|
+
address?: AddressV3 | null;
|
|
2535
|
+
}
|
|
2536
|
+
|
|
2537
|
+
export interface LoanBorrowerEmploymentPreviousRequest {
|
|
2538
|
+
/** @maxLength 255 */
|
|
2539
|
+
name?: string | null;
|
|
2540
|
+
/** @maxLength 100 */
|
|
2541
|
+
title?: string | null;
|
|
2542
|
+
phoneNumber?: string | null;
|
|
2543
|
+
/** @format date */
|
|
2544
|
+
startDate?: string | null;
|
|
2545
|
+
/** @format date */
|
|
2546
|
+
endDate?: string | null;
|
|
2547
|
+
/**
|
|
2548
|
+
* @format double
|
|
2549
|
+
* @min 0
|
|
2550
|
+
*/
|
|
2551
|
+
grossIncome?: number | null;
|
|
2552
|
+
isSelfEmployed?: boolean | null;
|
|
2553
|
+
address?: AddressRequest | null;
|
|
2554
|
+
}
|
|
2555
|
+
|
|
2556
|
+
export interface LoanBorrowerGift {
|
|
2557
|
+
/** @format uuid */
|
|
2558
|
+
id?: string | null;
|
|
2559
|
+
/** @format double */
|
|
2560
|
+
value?: number | null;
|
|
2561
|
+
isDeposited?: boolean | null;
|
|
2562
|
+
source?: LoanGiftSource | null;
|
|
2563
|
+
assetType?: LoanGiftAssetType | null;
|
|
2564
|
+
}
|
|
2565
|
+
|
|
2566
|
+
export interface LoanBorrowerGiftRequest {
|
|
2567
|
+
/**
|
|
2568
|
+
* @format double
|
|
2569
|
+
* @min 0
|
|
2570
|
+
*/
|
|
2571
|
+
value?: number | null;
|
|
2572
|
+
isDeposited?: boolean | null;
|
|
2573
|
+
source?: LoanGiftSource | null;
|
|
2574
|
+
assetType?: LoanGiftAssetType | null;
|
|
2575
|
+
}
|
|
2576
|
+
|
|
2577
|
+
export interface LoanBorrowerHomeOwnership {
|
|
2578
|
+
/** @format uuid */
|
|
2579
|
+
id?: string | null;
|
|
2580
|
+
/** @format date */
|
|
2581
|
+
dateCompleted?: string | null;
|
|
2582
|
+
type?: LoanHomeOwnershipType | null;
|
|
2583
|
+
format?: LoanHomeOwnershipFormat | null;
|
|
2584
|
+
provider?: LoanBorrowerHomeOwnershipProvider | null;
|
|
2585
|
+
}
|
|
2586
|
+
|
|
2587
|
+
export interface LoanBorrowerHomeOwnershipProvider {
|
|
2588
|
+
/** @format uuid */
|
|
2589
|
+
id?: string | null;
|
|
2590
|
+
name?: string | null;
|
|
2591
|
+
phoneNumber?: string | null;
|
|
2592
|
+
address?: AddressV3 | null;
|
|
2593
|
+
}
|
|
2594
|
+
|
|
2595
|
+
export interface LoanBorrowerHomeOwnershipProviderRequest {
|
|
2596
|
+
/** @maxLength 255 */
|
|
2597
|
+
name?: string | null;
|
|
2598
|
+
phoneNumber?: string | null;
|
|
2599
|
+
address?: AddressRequest | null;
|
|
2600
|
+
}
|
|
2601
|
+
|
|
2602
|
+
export interface LoanBorrowerHomeOwnershipRequest {
|
|
2603
|
+
/** @format date */
|
|
2604
|
+
dateCompleted?: string | null;
|
|
2605
|
+
type?: LoanHomeOwnershipType | null;
|
|
2606
|
+
format?: LoanHomeOwnershipFormat | null;
|
|
2607
|
+
provider?: LoanBorrowerHomeOwnershipProviderRequest | null;
|
|
2608
|
+
}
|
|
2609
|
+
|
|
2610
|
+
export interface LoanBorrowerLiability {
|
|
2611
|
+
/** @format uuid */
|
|
2612
|
+
id?: string | null;
|
|
2613
|
+
type?: LoanLiabilityType | null;
|
|
2614
|
+
name?: string | null;
|
|
2615
|
+
accountNumber?: string | null;
|
|
2616
|
+
financialInstitution?: string | null;
|
|
2617
|
+
/** @format double */
|
|
2618
|
+
balance?: number | null;
|
|
2619
|
+
/** @format double */
|
|
2620
|
+
monthlyPayment?: number | null;
|
|
2621
|
+
/** @format int32 */
|
|
2622
|
+
monthsLeftToPay?: number | null;
|
|
2623
|
+
isPaidOffBeforeClosing?: boolean | null;
|
|
2624
|
+
}
|
|
2625
|
+
|
|
2626
|
+
export interface LoanBorrowerLiabilityRequest {
|
|
2627
|
+
type?: LoanLiabilityType | null;
|
|
2628
|
+
/** @maxLength 255 */
|
|
2629
|
+
name?: string | null;
|
|
2630
|
+
/** @maxLength 50 */
|
|
2631
|
+
accountNumber?: string | null;
|
|
2632
|
+
/** @maxLength 255 */
|
|
2633
|
+
financialInstitution?: string | null;
|
|
2634
|
+
/**
|
|
2635
|
+
* @format double
|
|
2636
|
+
* @min 0
|
|
2637
|
+
*/
|
|
2638
|
+
balance?: number | null;
|
|
2639
|
+
/**
|
|
2640
|
+
* @format double
|
|
2641
|
+
* @min 0
|
|
2642
|
+
*/
|
|
2643
|
+
monthlyPayment?: number | null;
|
|
2644
|
+
/**
|
|
2645
|
+
* @format int32
|
|
2646
|
+
* @min 0
|
|
2647
|
+
*/
|
|
2648
|
+
monthsLeftToPay?: number | null;
|
|
2649
|
+
isPaidOffBeforeClosing?: boolean | null;
|
|
2650
|
+
}
|
|
2651
|
+
|
|
2652
|
+
export interface LoanBorrowerMilitaryService {
|
|
2653
|
+
/** @format uuid */
|
|
2654
|
+
id?: string | null;
|
|
2655
|
+
hasServed?: boolean | null;
|
|
2656
|
+
/** @format date */
|
|
2657
|
+
endDate?: string | null;
|
|
2658
|
+
type?: LoanMilitaryServiceType | null;
|
|
2659
|
+
}
|
|
2660
|
+
|
|
2661
|
+
export interface LoanBorrowerMilitaryServiceRequest {
|
|
2662
|
+
hasServed?: boolean | null;
|
|
2663
|
+
/** @format date */
|
|
2664
|
+
endDate?: string | null;
|
|
2665
|
+
type?: LoanMilitaryServiceType | null;
|
|
2666
|
+
}
|
|
2667
|
+
|
|
2668
|
+
export interface LoanBorrowerMoneyDeclaration {
|
|
2669
|
+
/** @format uuid */
|
|
2670
|
+
id?: string | null;
|
|
2671
|
+
isAffirmative?: boolean | null;
|
|
2672
|
+
description?: string | null;
|
|
2673
|
+
/** @format double */
|
|
2674
|
+
amount?: number | null;
|
|
2675
|
+
}
|
|
2676
|
+
|
|
2677
|
+
export interface LoanBorrowerMoneyDeclarationRequest {
|
|
2678
|
+
isAffirmative?: boolean | null;
|
|
2679
|
+
/** @maxLength 1000 */
|
|
2680
|
+
description?: string | null;
|
|
2681
|
+
/**
|
|
2682
|
+
* @format double
|
|
2683
|
+
* @min 0
|
|
2684
|
+
*/
|
|
2685
|
+
amount?: number | null;
|
|
2686
|
+
}
|
|
2687
|
+
|
|
2688
|
+
export interface LoanBorrowerOtherAsset {
|
|
2689
|
+
/** @format uuid */
|
|
2690
|
+
id?: string | null;
|
|
2691
|
+
type?: LoanOtherAssetType | null;
|
|
2692
|
+
other?: string | null;
|
|
2693
|
+
/** @format double */
|
|
2694
|
+
value?: number | null;
|
|
2695
|
+
}
|
|
2696
|
+
|
|
2697
|
+
export interface LoanBorrowerOtherAssetRequest {
|
|
2698
|
+
type?: LoanOtherAssetType | null;
|
|
2699
|
+
/** @maxLength 255 */
|
|
2700
|
+
other?: string | null;
|
|
2701
|
+
/**
|
|
2702
|
+
* @format double
|
|
2703
|
+
* @min 0
|
|
2704
|
+
*/
|
|
2705
|
+
value?: number | null;
|
|
2706
|
+
}
|
|
2707
|
+
|
|
2708
|
+
export interface LoanBorrowerOtherIncome {
|
|
2709
|
+
/** @format uuid */
|
|
2710
|
+
id?: string | null;
|
|
2711
|
+
/** @format double */
|
|
2712
|
+
value?: number | null;
|
|
2713
|
+
type?: LoanOtherIncomeType | null;
|
|
2714
|
+
}
|
|
2715
|
+
|
|
2716
|
+
export interface LoanBorrowerOtherIncomeRequest {
|
|
2717
|
+
/**
|
|
2718
|
+
* @format double
|
|
2719
|
+
* @min 0
|
|
2720
|
+
*/
|
|
2721
|
+
value?: number | null;
|
|
2722
|
+
type?: LoanOtherIncomeType | null;
|
|
2723
|
+
}
|
|
2724
|
+
|
|
2725
|
+
export interface LoanBorrowerOtherLiability {
|
|
2726
|
+
/** @format uuid */
|
|
2727
|
+
id?: string | null;
|
|
2728
|
+
/** @format double */
|
|
2729
|
+
monthlyPayment?: number | null;
|
|
2730
|
+
type?: LoanOtherLiabilityType | null;
|
|
2731
|
+
}
|
|
2732
|
+
|
|
2733
|
+
export interface LoanBorrowerOtherLiabilityRequest {
|
|
2734
|
+
/**
|
|
2735
|
+
* @format double
|
|
2736
|
+
* @min 0
|
|
2737
|
+
*/
|
|
2738
|
+
monthlyPayment?: number | null;
|
|
2739
|
+
type?: LoanOtherLiabilityType | null;
|
|
2740
|
+
}
|
|
2741
|
+
|
|
2742
|
+
export interface LoanBorrowerPhoneNumber {
|
|
2743
|
+
/** @format uuid */
|
|
2744
|
+
id?: string | null;
|
|
2745
|
+
ext?: string | null;
|
|
2746
|
+
number?: string | null;
|
|
2747
|
+
type?: LoanPhoneNumberType | null;
|
|
2748
|
+
}
|
|
2749
|
+
|
|
2750
|
+
export interface LoanBorrowerPhoneNumberRequest {
|
|
2751
|
+
/** @maxLength 10 */
|
|
2752
|
+
ext?: string | null;
|
|
2753
|
+
number?: string | null;
|
|
2754
|
+
type?: LoanPhoneNumberType | null;
|
|
2755
|
+
}
|
|
2756
|
+
|
|
2757
|
+
export interface LoanBorrowerPrimaryResidenceDeclaration {
|
|
2758
|
+
/** @format uuid */
|
|
2759
|
+
id?: string | null;
|
|
2760
|
+
isAffirmative?: boolean | null;
|
|
2761
|
+
description?: string | null;
|
|
2762
|
+
hasInterestInLastThreeYears?: boolean | null;
|
|
2763
|
+
titleHeld?: LoanTitleHeld | null;
|
|
2764
|
+
propertyType?: LoanOccupancyType | null;
|
|
2765
|
+
}
|
|
2766
|
+
|
|
2767
|
+
export interface LoanBorrowerPrimaryResidenceDeclarationRequest {
|
|
2768
|
+
isAffirmative?: boolean | null;
|
|
2769
|
+
/** @maxLength 1000 */
|
|
2770
|
+
description?: string | null;
|
|
2771
|
+
hasInterestInLastThreeYears?: boolean | null;
|
|
2772
|
+
titleHeld?: LoanTitleHeld | null;
|
|
2773
|
+
propertyType?: LoanOccupancyType | null;
|
|
2774
|
+
}
|
|
2775
|
+
|
|
2776
|
+
export interface LoanBorrowerRealEstateAsset {
|
|
2777
|
+
/** @format uuid */
|
|
2778
|
+
id?: string | null;
|
|
2779
|
+
status?: LoanRealEstateStatus | null;
|
|
2780
|
+
occupancy?: LoanOccupancyType | null;
|
|
2781
|
+
/** @format double */
|
|
2782
|
+
marketValue?: number | null;
|
|
2783
|
+
/** @format double */
|
|
2784
|
+
monthlyInsTaxDues?: number | null;
|
|
2785
|
+
/** @format double */
|
|
2786
|
+
monthlyRentalIncome?: number | null;
|
|
2787
|
+
address?: AddressV3 | null;
|
|
2788
|
+
mortgages?: LoanBorrowerRealEstateAssetMortgage[] | null;
|
|
2789
|
+
}
|
|
2790
|
+
|
|
2791
|
+
export interface LoanBorrowerRealEstateAssetMortgage {
|
|
2792
|
+
/** @format uuid */
|
|
2793
|
+
id?: string | null;
|
|
2794
|
+
creditor?: string | null;
|
|
2795
|
+
accountNumber?: string | null;
|
|
2796
|
+
/** @format double */
|
|
2797
|
+
balance?: number | null;
|
|
2798
|
+
/** @format double */
|
|
2799
|
+
creditLimit?: number | null;
|
|
2800
|
+
/** @format double */
|
|
2801
|
+
monthlyMortgagePayment?: number | null;
|
|
2802
|
+
isBalancePaidBeforeClosing?: boolean | null;
|
|
2803
|
+
loanType?: LoanType | null;
|
|
2804
|
+
}
|
|
2805
|
+
|
|
2806
|
+
export interface LoanBorrowerRealEstateAssetMortgageRequest {
|
|
2807
|
+
/** @maxLength 255 */
|
|
2808
|
+
creditor?: string | null;
|
|
2809
|
+
/** @maxLength 50 */
|
|
2810
|
+
accountNumber?: string | null;
|
|
2811
|
+
/**
|
|
2812
|
+
* @format double
|
|
2813
|
+
* @min 0
|
|
2814
|
+
*/
|
|
2815
|
+
balance?: number | null;
|
|
2816
|
+
/**
|
|
2817
|
+
* @format double
|
|
2818
|
+
* @min 0
|
|
2819
|
+
*/
|
|
2820
|
+
creditLimit?: number | null;
|
|
2821
|
+
/**
|
|
2822
|
+
* @format double
|
|
2823
|
+
* @min 0
|
|
2824
|
+
*/
|
|
2825
|
+
monthlyMortgagePayment?: number | null;
|
|
2826
|
+
isBalancePaidBeforeClosing?: boolean | null;
|
|
2827
|
+
loanType?: LoanType | null;
|
|
2828
|
+
}
|
|
2829
|
+
|
|
2830
|
+
export interface LoanBorrowerRealEstateAssetRequest {
|
|
2831
|
+
status?: LoanRealEstateStatus | null;
|
|
2832
|
+
occupancy?: LoanOccupancyType | null;
|
|
2833
|
+
/**
|
|
2834
|
+
* @format double
|
|
2835
|
+
* @min 0
|
|
2836
|
+
*/
|
|
2837
|
+
marketValue?: number | null;
|
|
2838
|
+
/**
|
|
2839
|
+
* @format double
|
|
2840
|
+
* @min 0
|
|
2841
|
+
*/
|
|
2842
|
+
monthlyInsTaxDues?: number | null;
|
|
2843
|
+
/**
|
|
2844
|
+
* @format double
|
|
2845
|
+
* @min 0
|
|
2846
|
+
*/
|
|
2847
|
+
monthlyRentalIncome?: number | null;
|
|
2848
|
+
address?: AddressRequest | null;
|
|
2849
|
+
mortgages?: LoanBorrowerRealEstateAssetMortgageRequest[] | null;
|
|
2850
|
+
}
|
|
2851
|
+
|
|
2852
|
+
export interface LoanBorrowerRequest {
|
|
2853
|
+
ssn?: string | null;
|
|
2854
|
+
email?: string | null;
|
|
2855
|
+
/** @maxLength 100 */
|
|
2856
|
+
lastName?: string | null;
|
|
2857
|
+
/** @maxLength 100 */
|
|
2858
|
+
firstName?: string | null;
|
|
2859
|
+
/** @maxLength 100 */
|
|
2860
|
+
middleName?: string | null;
|
|
2861
|
+
prefix?: LoanNamePrefix | null;
|
|
2862
|
+
suffix?: LoanNameSuffix | null;
|
|
2863
|
+
/** @format date */
|
|
2864
|
+
birthDate?: string | null;
|
|
2865
|
+
citizenship?: LoanCitizenship | null;
|
|
2866
|
+
maritalStatus?: LoanMaritalStatus | null;
|
|
2867
|
+
languagePreference?: LoanLanguagePreference | null;
|
|
2868
|
+
/** @format int32 */
|
|
2869
|
+
numberOfDependents?: number | null;
|
|
2870
|
+
isPrimaryBorrower: boolean;
|
|
2871
|
+
isFirstTimeHomeBuyer?: boolean | null;
|
|
2872
|
+
hasJointAssetsAndLiabilities?: boolean | null;
|
|
2873
|
+
dependentAges?: number[] | null;
|
|
2874
|
+
demographics?: LoanBorrowerDemographicsRequest | null;
|
|
2875
|
+
declarations?: LoanBorrowerDeclarationsRequest | null;
|
|
2876
|
+
militaryService?: LoanBorrowerMilitaryServiceRequest | null;
|
|
2877
|
+
gifts: LoanBorrowerGiftRequest[];
|
|
2878
|
+
addresses: LoanBorrowerAddressRequest[];
|
|
2879
|
+
consents: LoanBorrowerConsentRequest[];
|
|
2880
|
+
liabilities: LoanBorrowerLiabilityRequest[];
|
|
2881
|
+
otherAssets: LoanBorrowerOtherAssetRequest[];
|
|
2882
|
+
otherIncome: LoanBorrowerOtherIncomeRequest[];
|
|
2883
|
+
phoneNumbers: LoanBorrowerPhoneNumberRequest[];
|
|
2884
|
+
accountAssets: LoanBorrowerAccountAssetRequest[];
|
|
2885
|
+
homeOwnership: LoanBorrowerHomeOwnershipRequest[];
|
|
2886
|
+
alternateNames: LoanBorrowerAlternateNameRequest[];
|
|
2887
|
+
otherLiabilities: LoanBorrowerOtherLiabilityRequest[];
|
|
2888
|
+
realEstateAssets: LoanBorrowerRealEstateAssetRequest[];
|
|
2889
|
+
currentEmployment: LoanBorrowerEmploymentCurrentRequest[];
|
|
2890
|
+
previousEmployment: LoanBorrowerEmploymentPreviousRequest[];
|
|
2891
|
+
}
|
|
2892
|
+
|
|
2893
|
+
export interface LoanBorrowerSimpleDeclaration {
|
|
2894
|
+
/** @format uuid */
|
|
2895
|
+
id?: string | null;
|
|
2896
|
+
isAffirmative?: boolean | null;
|
|
2897
|
+
description?: string | null;
|
|
2898
|
+
}
|
|
2899
|
+
|
|
2900
|
+
export interface LoanBorrowerSimpleDeclarationRequest {
|
|
2901
|
+
isAffirmative?: boolean | null;
|
|
2902
|
+
/** @maxLength 1000 */
|
|
2903
|
+
description?: string | null;
|
|
2904
|
+
}
|
|
2905
|
+
|
|
2906
|
+
export interface LoanComparison {
|
|
2907
|
+
loanID: string;
|
|
2908
|
+
scenarios: LoanComparisonScenario[];
|
|
2909
|
+
loanLocked: boolean;
|
|
2910
|
+
}
|
|
2911
|
+
|
|
2912
|
+
export interface LoanComparisonCalculator {
|
|
2913
|
+
/** @format double */
|
|
2914
|
+
loanAmount: number;
|
|
2915
|
+
loans: LoanComparisonCalculatorLoan[];
|
|
2916
|
+
}
|
|
2917
|
+
|
|
2918
|
+
export interface LoanComparisonCalculatorLoan {
|
|
2919
|
+
/** @format double */
|
|
2920
|
+
points: number;
|
|
2921
|
+
/** @format double */
|
|
2922
|
+
originationFees: number;
|
|
2923
|
+
/** @format double */
|
|
2924
|
+
closingCosts: number;
|
|
2925
|
+
/** @format double */
|
|
2926
|
+
totalClosingCosts: number;
|
|
2927
|
+
/** @format double */
|
|
2928
|
+
monthlyPrincipalAndInterest: number;
|
|
2929
|
+
amortization: Amortization;
|
|
2930
|
+
}
|
|
2931
|
+
|
|
2932
|
+
export interface LoanComparisonCalculatorLoanRequest {
|
|
2933
|
+
/**
|
|
2934
|
+
* @format double
|
|
2935
|
+
* @min 1
|
|
2936
|
+
* @max 25
|
|
2937
|
+
*/
|
|
2938
|
+
interestRate: number;
|
|
2939
|
+
/**
|
|
2940
|
+
* @format int32
|
|
2941
|
+
* @min 1
|
|
2942
|
+
* @max 40
|
|
2943
|
+
*/
|
|
2944
|
+
term: number;
|
|
2945
|
+
/**
|
|
2946
|
+
* @format double
|
|
2947
|
+
* @min 0
|
|
2948
|
+
* @max 3
|
|
2949
|
+
*/
|
|
2950
|
+
points: number;
|
|
2951
|
+
/**
|
|
2952
|
+
* @format double
|
|
2953
|
+
* @min 0
|
|
2954
|
+
* @max 5
|
|
2955
|
+
*/
|
|
2956
|
+
originationFees: number;
|
|
2957
|
+
/**
|
|
2958
|
+
* @format double
|
|
2959
|
+
* @min 500
|
|
2960
|
+
* @max 100000
|
|
2961
|
+
*/
|
|
2962
|
+
closingCosts: number;
|
|
2963
|
+
/**
|
|
2964
|
+
* @format double
|
|
2965
|
+
* @min 25000
|
|
2966
|
+
* @max 10000000
|
|
2967
|
+
*/
|
|
2968
|
+
homeValue: number;
|
|
2969
|
+
/**
|
|
2970
|
+
* @format double
|
|
2971
|
+
* @min 0
|
|
2972
|
+
* @max 10
|
|
2973
|
+
*/
|
|
2974
|
+
pmi: number;
|
|
2975
|
+
}
|
|
2976
|
+
|
|
2977
|
+
export interface LoanComparisonCalculatorRequest {
|
|
2978
|
+
/**
|
|
2979
|
+
* @format double
|
|
2980
|
+
* @min 30000
|
|
2981
|
+
*/
|
|
2982
|
+
loanAmount: number;
|
|
2983
|
+
loans: LoanComparisonCalculatorLoanRequest[];
|
|
2984
|
+
}
|
|
2985
|
+
|
|
2986
|
+
export interface LoanComparisonScenario {
|
|
2987
|
+
loanProgram?: string | null;
|
|
2988
|
+
/** @minLength 1 */
|
|
2989
|
+
loanType: string;
|
|
2990
|
+
propertyValue?: string | null;
|
|
2991
|
+
purchasePrice?: string | null;
|
|
2992
|
+
downpaymentAmount?: string | null;
|
|
2993
|
+
downpaymentPercent?: string | null;
|
|
2994
|
+
loanAmount?: string | null;
|
|
2995
|
+
totalAssets?: string | null;
|
|
2996
|
+
monthlyPayment?: string | null;
|
|
2997
|
+
totalMortgageAmount?: string | null;
|
|
2998
|
+
dtiFront?: string | null;
|
|
2999
|
+
dtiBack?: string | null;
|
|
3000
|
+
ltvFront?: string | null;
|
|
3001
|
+
ltvBack?: string | null;
|
|
3002
|
+
totalCashToClose?: string | null;
|
|
3003
|
+
apr?: string | null;
|
|
3004
|
+
mi?: string | null;
|
|
3005
|
+
miFactor?: string | null;
|
|
3006
|
+
rate?: string | null;
|
|
3007
|
+
loanTerm1?: string | null;
|
|
3008
|
+
loanTerm2?: string | null;
|
|
3009
|
+
closingCosts?: string | null;
|
|
3010
|
+
prepaidCharges?: string | null;
|
|
3011
|
+
totalCost?: string | null;
|
|
3012
|
+
totalFinancing?: string | null;
|
|
3013
|
+
discount?: string | null;
|
|
3014
|
+
lenderCredit?: string | null;
|
|
3015
|
+
fundingFee?: string | null;
|
|
3016
|
+
}
|
|
3017
|
+
|
|
3018
|
+
export interface LoanConsentRequest {
|
|
3019
|
+
/** @format email */
|
|
1879
3020
|
borrowerEmail?: string | null;
|
|
1880
3021
|
borrowerEConsent?: boolean | null;
|
|
1881
3022
|
borrowerCreditAuth?: boolean | null;
|
|
@@ -1899,7 +3040,19 @@ export interface LoanContact {
|
|
|
1899
3040
|
email?: string | null;
|
|
1900
3041
|
phone?: string | null;
|
|
1901
3042
|
companyName?: string | null;
|
|
1902
|
-
role:
|
|
3043
|
+
role:
|
|
3044
|
+
| "Borrower"
|
|
3045
|
+
| "CoBorrower"
|
|
3046
|
+
| "NonBorrower"
|
|
3047
|
+
| "LoanOfficer"
|
|
3048
|
+
| "LoanProcessor"
|
|
3049
|
+
| "LoanOfficerAssistant"
|
|
3050
|
+
| "SupportingLoanOfficer"
|
|
3051
|
+
| "BuyerAgent"
|
|
3052
|
+
| "SellerAgent"
|
|
3053
|
+
| "TitleInsuranceAgent"
|
|
3054
|
+
| "EscrowAgent"
|
|
3055
|
+
| "SettlementAgent";
|
|
1903
3056
|
}
|
|
1904
3057
|
|
|
1905
3058
|
export interface LoanContactList {
|
|
@@ -1975,6 +3128,37 @@ export interface LoanDraftSearchCriteria {
|
|
|
1975
3128
|
draftTypes?: DraftType[] | null;
|
|
1976
3129
|
}
|
|
1977
3130
|
|
|
3131
|
+
export interface LoanFinancial {
|
|
3132
|
+
/** @format uuid */
|
|
3133
|
+
id?: string | null;
|
|
3134
|
+
isDebtsAssetsReviewed?: boolean | null;
|
|
3135
|
+
/** @format double */
|
|
3136
|
+
cashToClose?: number | null;
|
|
3137
|
+
/** @format double */
|
|
3138
|
+
cashDownPayment?: number | null;
|
|
3139
|
+
/** @format double */
|
|
3140
|
+
maximumPurchasePrice?: number | null;
|
|
3141
|
+
}
|
|
3142
|
+
|
|
3143
|
+
export interface LoanFinancialRequest {
|
|
3144
|
+
isDebtsAssetsReviewed?: boolean | null;
|
|
3145
|
+
/**
|
|
3146
|
+
* @format double
|
|
3147
|
+
* @min 0
|
|
3148
|
+
*/
|
|
3149
|
+
cashToClose?: number | null;
|
|
3150
|
+
/**
|
|
3151
|
+
* @format double
|
|
3152
|
+
* @min 0
|
|
3153
|
+
*/
|
|
3154
|
+
cashDownPayment?: number | null;
|
|
3155
|
+
/**
|
|
3156
|
+
* @format double
|
|
3157
|
+
* @min 0
|
|
3158
|
+
*/
|
|
3159
|
+
maximumPurchasePrice?: number | null;
|
|
3160
|
+
}
|
|
3161
|
+
|
|
1978
3162
|
export interface LoanIdentifier {
|
|
1979
3163
|
/** @format uuid */
|
|
1980
3164
|
id: string;
|
|
@@ -1994,14 +3178,19 @@ export interface LoanImport {
|
|
|
1994
3178
|
/** @format int32 */
|
|
1995
3179
|
importedCount: number;
|
|
1996
3180
|
statusMessage?: string | null;
|
|
1997
|
-
status:
|
|
1998
|
-
|
|
3181
|
+
status:
|
|
3182
|
+
| "WaitingProcess"
|
|
3183
|
+
| "InProgress"
|
|
3184
|
+
| "Completed"
|
|
3185
|
+
| "Failed"
|
|
3186
|
+
| "Cancelled";
|
|
3187
|
+
importMode: "All" | "NewOnly" | "UpdateOnly";
|
|
1999
3188
|
/** @format date-time */
|
|
2000
3189
|
createdAt?: string | null;
|
|
2001
3190
|
}
|
|
2002
3191
|
|
|
2003
3192
|
export interface LoanImportLog {
|
|
2004
|
-
level:
|
|
3193
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
2005
3194
|
message: string;
|
|
2006
3195
|
/** @format date-time */
|
|
2007
3196
|
createdAt: string;
|
|
@@ -2050,8 +3239,20 @@ export interface LoanListPaginated {
|
|
|
2050
3239
|
export interface LoanLog {
|
|
2051
3240
|
/** @format uuid */
|
|
2052
3241
|
id: string;
|
|
2053
|
-
level:
|
|
2054
|
-
type:
|
|
3242
|
+
level: "None" | "Info" | "Warning" | "Error";
|
|
3243
|
+
type:
|
|
3244
|
+
| "Loan"
|
|
3245
|
+
| "Queue"
|
|
3246
|
+
| "POSFlagChanged"
|
|
3247
|
+
| "Verification"
|
|
3248
|
+
| "DocumentUploaded"
|
|
3249
|
+
| "LoanCreated"
|
|
3250
|
+
| "WorkflowSubmitted"
|
|
3251
|
+
| "UserInvitationSent"
|
|
3252
|
+
| "CoBorrowerAdded"
|
|
3253
|
+
| "TaskCompleted"
|
|
3254
|
+
| "LoanStatusChanged"
|
|
3255
|
+
| "EConsent";
|
|
2055
3256
|
message: string;
|
|
2056
3257
|
/** @format date-time */
|
|
2057
3258
|
createdAt: string;
|
|
@@ -2070,6 +3271,31 @@ export interface LoanLogSearchCriteria {
|
|
|
2070
3271
|
levels?: LogLevel[] | null;
|
|
2071
3272
|
}
|
|
2072
3273
|
|
|
3274
|
+
export interface LoanNonOwningBorrower {
|
|
3275
|
+
/** @format uuid */
|
|
3276
|
+
id?: string | null;
|
|
3277
|
+
email?: string | null;
|
|
3278
|
+
lastName?: string | null;
|
|
3279
|
+
firstName?: string | null;
|
|
3280
|
+
middleName?: string | null;
|
|
3281
|
+
prefix?: LoanNamePrefix | null;
|
|
3282
|
+
suffix?: LoanNameSuffix | null;
|
|
3283
|
+
consents: LoanBorrowerConsent[];
|
|
3284
|
+
}
|
|
3285
|
+
|
|
3286
|
+
export interface LoanNonOwningBorrowerRequest {
|
|
3287
|
+
email?: string | null;
|
|
3288
|
+
/** @maxLength 100 */
|
|
3289
|
+
lastName?: string | null;
|
|
3290
|
+
/** @maxLength 100 */
|
|
3291
|
+
firstName?: string | null;
|
|
3292
|
+
/** @maxLength 100 */
|
|
3293
|
+
middleName?: string | null;
|
|
3294
|
+
prefix?: LoanNamePrefix | null;
|
|
3295
|
+
suffix?: LoanNameSuffix | null;
|
|
3296
|
+
consents: LoanBorrowerConsentRequest[];
|
|
3297
|
+
}
|
|
3298
|
+
|
|
2073
3299
|
export interface LoanOfficer {
|
|
2074
3300
|
/** @format uuid */
|
|
2075
3301
|
id: string;
|
|
@@ -2105,6 +3331,126 @@ export interface LoanOfficerSearchCriteria {
|
|
|
2105
3331
|
brand?: string | null;
|
|
2106
3332
|
}
|
|
2107
3333
|
|
|
3334
|
+
export interface LoanPatchRequestGuidPatchDocument {
|
|
3335
|
+
operations: GuidPatchOperation[];
|
|
3336
|
+
}
|
|
3337
|
+
|
|
3338
|
+
export interface LoanProperty {
|
|
3339
|
+
/** @format uuid */
|
|
3340
|
+
id?: string | null;
|
|
3341
|
+
trustType?: LoanTrustType | null;
|
|
3342
|
+
occupancy?: LoanOccupancyType | null;
|
|
3343
|
+
propertyType?: LoanPropertyType | null;
|
|
3344
|
+
referenceId?: string | null;
|
|
3345
|
+
/** @format int32 */
|
|
3346
|
+
yearBuilt?: number | null;
|
|
3347
|
+
/** @format int32 */
|
|
3348
|
+
yearAcquired?: number | null;
|
|
3349
|
+
/** @format int32 */
|
|
3350
|
+
numberOfUnits?: number | null;
|
|
3351
|
+
/** @format double */
|
|
3352
|
+
salePrice?: number | null;
|
|
3353
|
+
/** @format double */
|
|
3354
|
+
propertyValue?: number | null;
|
|
3355
|
+
/** @format double */
|
|
3356
|
+
purchasePrice?: number | null;
|
|
3357
|
+
/** @format double */
|
|
3358
|
+
estimatedValue?: number | null;
|
|
3359
|
+
/** @format double */
|
|
3360
|
+
monthlyRentalIncome?: number | null;
|
|
3361
|
+
isMixedUseProperty?: boolean | null;
|
|
3362
|
+
isManufacturedHome?: boolean | null;
|
|
3363
|
+
isFhaSecondaryResidence?: boolean | null;
|
|
3364
|
+
address?: AddressV3 | null;
|
|
3365
|
+
mortgages: LoanPropertyMortgage[];
|
|
3366
|
+
}
|
|
3367
|
+
|
|
3368
|
+
export interface LoanPropertyMortgage {
|
|
3369
|
+
/** @format uuid */
|
|
3370
|
+
id?: string | null;
|
|
3371
|
+
creditor?: string | null;
|
|
3372
|
+
/** @format double */
|
|
3373
|
+
loanAmount?: number | null;
|
|
3374
|
+
/** @format double */
|
|
3375
|
+
creditLimit?: number | null;
|
|
3376
|
+
/** @format double */
|
|
3377
|
+
monthlyPayment?: number | null;
|
|
3378
|
+
lienType?: LoanLienPosition | null;
|
|
3379
|
+
}
|
|
3380
|
+
|
|
3381
|
+
export interface LoanPropertyMortgageRequest {
|
|
3382
|
+
/** @maxLength 255 */
|
|
3383
|
+
creditor?: string | null;
|
|
3384
|
+
/**
|
|
3385
|
+
* @format double
|
|
3386
|
+
* @min 0
|
|
3387
|
+
*/
|
|
3388
|
+
loanAmount?: number | null;
|
|
3389
|
+
/**
|
|
3390
|
+
* @format double
|
|
3391
|
+
* @min 0
|
|
3392
|
+
*/
|
|
3393
|
+
creditLimit?: number | null;
|
|
3394
|
+
/**
|
|
3395
|
+
* @format double
|
|
3396
|
+
* @min 0
|
|
3397
|
+
*/
|
|
3398
|
+
monthlyPayment?: number | null;
|
|
3399
|
+
lienType?: LoanLienPosition | null;
|
|
3400
|
+
}
|
|
3401
|
+
|
|
3402
|
+
export interface LoanPropertyRequest {
|
|
3403
|
+
trustType?: LoanTrustType | null;
|
|
3404
|
+
occupancy?: LoanOccupancyType | null;
|
|
3405
|
+
propertyType?: LoanPropertyType | null;
|
|
3406
|
+
/** @maxLength 100 */
|
|
3407
|
+
referenceId?: string | null;
|
|
3408
|
+
/**
|
|
3409
|
+
* @format int32
|
|
3410
|
+
* @min 1800
|
|
3411
|
+
* @max 2035
|
|
3412
|
+
*/
|
|
3413
|
+
yearBuilt?: number | null;
|
|
3414
|
+
/**
|
|
3415
|
+
* @format int32
|
|
3416
|
+
* @min 1900
|
|
3417
|
+
* @max 2035
|
|
3418
|
+
*/
|
|
3419
|
+
yearAcquired?: number | null;
|
|
3420
|
+
/** @format int32 */
|
|
3421
|
+
numberOfUnits?: number | null;
|
|
3422
|
+
/**
|
|
3423
|
+
* @format double
|
|
3424
|
+
* @min 0
|
|
3425
|
+
*/
|
|
3426
|
+
salePrice?: number | null;
|
|
3427
|
+
/**
|
|
3428
|
+
* @format double
|
|
3429
|
+
* @min 0
|
|
3430
|
+
*/
|
|
3431
|
+
propertyValue?: number | null;
|
|
3432
|
+
/**
|
|
3433
|
+
* @format double
|
|
3434
|
+
* @min 0
|
|
3435
|
+
*/
|
|
3436
|
+
purchasePrice?: number | null;
|
|
3437
|
+
/**
|
|
3438
|
+
* @format double
|
|
3439
|
+
* @min 0
|
|
3440
|
+
*/
|
|
3441
|
+
estimatedValue?: number | null;
|
|
3442
|
+
/**
|
|
3443
|
+
* @format double
|
|
3444
|
+
* @min 0
|
|
3445
|
+
*/
|
|
3446
|
+
monthlyRentalIncome?: number | null;
|
|
3447
|
+
isMixedUseProperty?: boolean | null;
|
|
3448
|
+
isManufacturedHome?: boolean | null;
|
|
3449
|
+
isFhaSecondaryResidence?: boolean | null;
|
|
3450
|
+
address?: AddressRequest | null;
|
|
3451
|
+
mortgages: LoanPropertyMortgageRequest[];
|
|
3452
|
+
}
|
|
3453
|
+
|
|
2108
3454
|
export interface LoanQueue {
|
|
2109
3455
|
/** @format date-time */
|
|
2110
3456
|
createdAt: string;
|
|
@@ -2188,7 +3534,14 @@ export interface LoanUpdateRequestJsonPatchDocument {
|
|
|
2188
3534
|
}
|
|
2189
3535
|
|
|
2190
3536
|
export interface LoanUpdateRequestOperation {
|
|
2191
|
-
operationType:
|
|
3537
|
+
operationType:
|
|
3538
|
+
| "Add"
|
|
3539
|
+
| "Remove"
|
|
3540
|
+
| "Replace"
|
|
3541
|
+
| "Move"
|
|
3542
|
+
| "Copy"
|
|
3543
|
+
| "Test"
|
|
3544
|
+
| "Invalid";
|
|
2192
3545
|
path?: string | null;
|
|
2193
3546
|
op?: string | null;
|
|
2194
3547
|
from?: string | null;
|
|
@@ -2203,7 +3556,19 @@ export interface LoanUser {
|
|
|
2203
3556
|
email: string;
|
|
2204
3557
|
phone?: string | null;
|
|
2205
3558
|
role: string;
|
|
2206
|
-
loanRole:
|
|
3559
|
+
loanRole:
|
|
3560
|
+
| "Borrower"
|
|
3561
|
+
| "CoBorrower"
|
|
3562
|
+
| "NonBorrower"
|
|
3563
|
+
| "LoanOfficer"
|
|
3564
|
+
| "LoanProcessor"
|
|
3565
|
+
| "LoanOfficerAssistant"
|
|
3566
|
+
| "SupportingLoanOfficer"
|
|
3567
|
+
| "BuyerAgent"
|
|
3568
|
+
| "SellerAgent"
|
|
3569
|
+
| "TitleInsuranceAgent"
|
|
3570
|
+
| "EscrowAgent"
|
|
3571
|
+
| "SettlementAgent";
|
|
2207
3572
|
isUser: boolean;
|
|
2208
3573
|
/** @format date-time */
|
|
2209
3574
|
createdAt: string;
|
|
@@ -2834,7 +4199,7 @@ export interface SSOTokenRequest {
|
|
|
2834
4199
|
}
|
|
2835
4200
|
|
|
2836
4201
|
export interface SamlMetadataRequest {
|
|
2837
|
-
ssoIntegration:
|
|
4202
|
+
ssoIntegration: "ConsumerConnect" | "TheBigPOS";
|
|
2838
4203
|
}
|
|
2839
4204
|
|
|
2840
4205
|
export interface SendForgotPasswordRequest {
|
|
@@ -2873,7 +4238,7 @@ export interface SiteConfiguration {
|
|
|
2873
4238
|
deletedAt?: string | null;
|
|
2874
4239
|
/** @format uuid */
|
|
2875
4240
|
id: string;
|
|
2876
|
-
type:
|
|
4241
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
2877
4242
|
/** @format uuid */
|
|
2878
4243
|
entityID: string;
|
|
2879
4244
|
/** @format int32 */
|
|
@@ -3068,7 +4433,7 @@ export interface SiteConfigurationByUrl {
|
|
|
3068
4433
|
deletedAt?: string | null;
|
|
3069
4434
|
/** @format uuid */
|
|
3070
4435
|
id: string;
|
|
3071
|
-
type:
|
|
4436
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3072
4437
|
/** @format uuid */
|
|
3073
4438
|
entityID: string;
|
|
3074
4439
|
/** @format int32 */
|
|
@@ -3281,7 +4646,7 @@ export interface SiteConfigurationForm {
|
|
|
3281
4646
|
export interface SiteConfigurationReduced {
|
|
3282
4647
|
/** @format uuid */
|
|
3283
4648
|
id: string;
|
|
3284
|
-
type:
|
|
4649
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3285
4650
|
url?: string | null;
|
|
3286
4651
|
name: string;
|
|
3287
4652
|
/** @format int64 */
|
|
@@ -3299,7 +4664,7 @@ export interface SiteConfigurationRequest {
|
|
|
3299
4664
|
entityID: string;
|
|
3300
4665
|
/** @format int32 */
|
|
3301
4666
|
entityType: number;
|
|
3302
|
-
type:
|
|
4667
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3303
4668
|
url: string;
|
|
3304
4669
|
name: string;
|
|
3305
4670
|
introduction?: string | null;
|
|
@@ -3476,7 +4841,7 @@ export interface SiteConfigurationSearchCriteria {
|
|
|
3476
4841
|
export interface SiteConfigurationSummary {
|
|
3477
4842
|
/** @format uuid */
|
|
3478
4843
|
id: string;
|
|
3479
|
-
type:
|
|
4844
|
+
type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
|
|
3480
4845
|
url?: string | null;
|
|
3481
4846
|
name: string;
|
|
3482
4847
|
/** @format int64 */
|
|
@@ -3674,6 +5039,22 @@ export interface Theme {
|
|
|
3674
5039
|
iconColor?: string | null;
|
|
3675
5040
|
}
|
|
3676
5041
|
|
|
5042
|
+
export interface TimeAtAddress {
|
|
5043
|
+
/** @format uuid */
|
|
5044
|
+
id?: string | null;
|
|
5045
|
+
/** @format int32 */
|
|
5046
|
+
years?: number | null;
|
|
5047
|
+
/** @format int32 */
|
|
5048
|
+
months?: number | null;
|
|
5049
|
+
}
|
|
5050
|
+
|
|
5051
|
+
export interface TimeAtAddressRequest {
|
|
5052
|
+
/** @format int32 */
|
|
5053
|
+
years?: number | null;
|
|
5054
|
+
/** @format int32 */
|
|
5055
|
+
months?: number | null;
|
|
5056
|
+
}
|
|
5057
|
+
|
|
3677
5058
|
export interface Token {
|
|
3678
5059
|
token_type: string;
|
|
3679
5060
|
/** @format int32 */
|
|
@@ -3915,7 +5296,19 @@ export interface UserDevice {
|
|
|
3915
5296
|
export interface UserDraft {
|
|
3916
5297
|
/** @format uuid */
|
|
3917
5298
|
draftID: string;
|
|
3918
|
-
role:
|
|
5299
|
+
role:
|
|
5300
|
+
| "Borrower"
|
|
5301
|
+
| "CoBorrower"
|
|
5302
|
+
| "NonBorrower"
|
|
5303
|
+
| "LoanOfficer"
|
|
5304
|
+
| "LoanProcessor"
|
|
5305
|
+
| "LoanOfficerAssistant"
|
|
5306
|
+
| "SupportingLoanOfficer"
|
|
5307
|
+
| "BuyerAgent"
|
|
5308
|
+
| "SellerAgent"
|
|
5309
|
+
| "TitleInsuranceAgent"
|
|
5310
|
+
| "EscrowAgent"
|
|
5311
|
+
| "SettlementAgent";
|
|
3919
5312
|
user: User;
|
|
3920
5313
|
}
|
|
3921
5314
|
|
|
@@ -3942,7 +5335,7 @@ export interface UserGroupAccessScope {
|
|
|
3942
5335
|
id: string;
|
|
3943
5336
|
/** @format uuid */
|
|
3944
5337
|
groupId: string;
|
|
3945
|
-
scopeType:
|
|
5338
|
+
scopeType: "User" | "Branch";
|
|
3946
5339
|
/** @format uuid */
|
|
3947
5340
|
userId?: string | null;
|
|
3948
5341
|
/** @format uuid */
|
|
@@ -3978,7 +5371,19 @@ export interface UserLoan {
|
|
|
3978
5371
|
deletedAt?: string | null;
|
|
3979
5372
|
loanID: string;
|
|
3980
5373
|
user: User;
|
|
3981
|
-
role:
|
|
5374
|
+
role:
|
|
5375
|
+
| "Borrower"
|
|
5376
|
+
| "CoBorrower"
|
|
5377
|
+
| "NonBorrower"
|
|
5378
|
+
| "LoanOfficer"
|
|
5379
|
+
| "LoanProcessor"
|
|
5380
|
+
| "LoanOfficerAssistant"
|
|
5381
|
+
| "SupportingLoanOfficer"
|
|
5382
|
+
| "BuyerAgent"
|
|
5383
|
+
| "SellerAgent"
|
|
5384
|
+
| "TitleInsuranceAgent"
|
|
5385
|
+
| "EscrowAgent"
|
|
5386
|
+
| "SettlementAgent";
|
|
3982
5387
|
/** @format int32 */
|
|
3983
5388
|
borrowerPair?: number | null;
|
|
3984
5389
|
/** @format int32 */
|
|
@@ -3991,7 +5396,7 @@ export interface UserLoanConsent {
|
|
|
3991
5396
|
id: string;
|
|
3992
5397
|
/** @format uuid */
|
|
3993
5398
|
userLoanID: string;
|
|
3994
|
-
type:
|
|
5399
|
+
type: "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
3995
5400
|
providedConsent: boolean;
|
|
3996
5401
|
ipAddress?: string | null;
|
|
3997
5402
|
/** @format date-time */
|
|
@@ -4138,7 +5543,17 @@ export interface UserSummary {
|
|
|
4138
5543
|
id: string;
|
|
4139
5544
|
name?: string | null;
|
|
4140
5545
|
email?: string | null;
|
|
4141
|
-
role:
|
|
5546
|
+
role:
|
|
5547
|
+
| "Borrower"
|
|
5548
|
+
| "LoanOfficer"
|
|
5549
|
+
| "Admin"
|
|
5550
|
+
| "SuperAdmin"
|
|
5551
|
+
| "Realtor"
|
|
5552
|
+
| "SettlementAgent"
|
|
5553
|
+
| "LoanProcessor"
|
|
5554
|
+
| "LoanOfficerAssistant"
|
|
5555
|
+
| "BranchManager"
|
|
5556
|
+
| "SystemAdmin";
|
|
4142
5557
|
}
|
|
4143
5558
|
|
|
4144
5559
|
export interface VerifyPasswordRequest {
|
|
@@ -4174,254 +5589,6 @@ export interface Workflow {
|
|
|
4174
5589
|
icon: string;
|
|
4175
5590
|
}
|
|
4176
5591
|
|
|
4177
|
-
export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
|
|
4178
|
-
|
|
4179
|
-
export type CreateAccountRequestEnvironmentEnum =
|
|
4180
|
-
| "Development"
|
|
4181
|
-
| "Staging"
|
|
4182
|
-
| "UAT"
|
|
4183
|
-
| "Production";
|
|
4184
|
-
|
|
4185
|
-
export type CreateGroupMemberRequestLoanRoleEnum =
|
|
4186
|
-
| "Borrower"
|
|
4187
|
-
| "CoBorrower"
|
|
4188
|
-
| "NonBorrower"
|
|
4189
|
-
| "LoanOfficer"
|
|
4190
|
-
| "LoanProcessor"
|
|
4191
|
-
| "LoanOfficerAssistant"
|
|
4192
|
-
| "SupportingLoanOfficer"
|
|
4193
|
-
| "BuyerAgent"
|
|
4194
|
-
| "SellerAgent"
|
|
4195
|
-
| "TitleInsuranceAgent"
|
|
4196
|
-
| "EscrowAgent"
|
|
4197
|
-
| "SettlementAgent";
|
|
4198
|
-
|
|
4199
|
-
/** @deprecated */
|
|
4200
|
-
export type CreateInviteRequestRelationshipEnum =
|
|
4201
|
-
| "NotApplicable"
|
|
4202
|
-
| "Spouse"
|
|
4203
|
-
| "NonSpouse";
|
|
4204
|
-
|
|
4205
|
-
export type CreateLoanImportRequestImportModeEnum =
|
|
4206
|
-
| "All"
|
|
4207
|
-
| "NewOnly"
|
|
4208
|
-
| "UpdateOnly";
|
|
4209
|
-
|
|
4210
|
-
export type CreateUserDraftLoanRoleEnum =
|
|
4211
|
-
| "Borrower"
|
|
4212
|
-
| "CoBorrower"
|
|
4213
|
-
| "NonBorrower"
|
|
4214
|
-
| "LoanOfficer"
|
|
4215
|
-
| "LoanProcessor"
|
|
4216
|
-
| "LoanOfficerAssistant"
|
|
4217
|
-
| "SupportingLoanOfficer"
|
|
4218
|
-
| "BuyerAgent"
|
|
4219
|
-
| "SellerAgent"
|
|
4220
|
-
| "TitleInsuranceAgent"
|
|
4221
|
-
| "EscrowAgent"
|
|
4222
|
-
| "SettlementAgent";
|
|
4223
|
-
|
|
4224
|
-
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
4225
|
-
|
|
4226
|
-
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
4227
|
-
|
|
4228
|
-
export type FusionReportFilterFilterTypeEnum =
|
|
4229
|
-
| "DateGreaterThanOrEqualTo"
|
|
4230
|
-
| "DateGreaterThan"
|
|
4231
|
-
| "DateLessThan"
|
|
4232
|
-
| "DateLessThanOrEqualTo"
|
|
4233
|
-
| "DateEquals"
|
|
4234
|
-
| "DateDoesntEqual"
|
|
4235
|
-
| "DateNonEmpty"
|
|
4236
|
-
| "DateEmpty"
|
|
4237
|
-
| "StringContains"
|
|
4238
|
-
| "StringEquals"
|
|
4239
|
-
| "StringNotEmpty"
|
|
4240
|
-
| "StringNotEquals"
|
|
4241
|
-
| "StringNotContains";
|
|
4242
|
-
|
|
4243
|
-
export type LoanContactRoleEnum =
|
|
4244
|
-
| "Borrower"
|
|
4245
|
-
| "CoBorrower"
|
|
4246
|
-
| "NonBorrower"
|
|
4247
|
-
| "LoanOfficer"
|
|
4248
|
-
| "LoanProcessor"
|
|
4249
|
-
| "LoanOfficerAssistant"
|
|
4250
|
-
| "SupportingLoanOfficer"
|
|
4251
|
-
| "BuyerAgent"
|
|
4252
|
-
| "SellerAgent"
|
|
4253
|
-
| "TitleInsuranceAgent"
|
|
4254
|
-
| "EscrowAgent"
|
|
4255
|
-
| "SettlementAgent";
|
|
4256
|
-
|
|
4257
|
-
export type LoanImportStatusEnum =
|
|
4258
|
-
| "WaitingProcess"
|
|
4259
|
-
| "InProgress"
|
|
4260
|
-
| "Completed"
|
|
4261
|
-
| "Failed"
|
|
4262
|
-
| "Cancelled";
|
|
4263
|
-
|
|
4264
|
-
export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
|
|
4265
|
-
|
|
4266
|
-
export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
4267
|
-
|
|
4268
|
-
export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
4269
|
-
|
|
4270
|
-
export type LoanLogTypeEnum =
|
|
4271
|
-
| "Loan"
|
|
4272
|
-
| "Queue"
|
|
4273
|
-
| "POSFlagChanged"
|
|
4274
|
-
| "Verification"
|
|
4275
|
-
| "DocumentUploaded"
|
|
4276
|
-
| "LoanCreated"
|
|
4277
|
-
| "WorkflowSubmitted"
|
|
4278
|
-
| "UserInvitationSent"
|
|
4279
|
-
| "CoBorrowerAdded"
|
|
4280
|
-
| "TaskCompleted"
|
|
4281
|
-
| "LoanStatusChanged"
|
|
4282
|
-
| "EConsent";
|
|
4283
|
-
|
|
4284
|
-
export type LoanUpdateRequestOperationOperationTypeEnum =
|
|
4285
|
-
| "Add"
|
|
4286
|
-
| "Remove"
|
|
4287
|
-
| "Replace"
|
|
4288
|
-
| "Move"
|
|
4289
|
-
| "Copy"
|
|
4290
|
-
| "Test"
|
|
4291
|
-
| "Invalid";
|
|
4292
|
-
|
|
4293
|
-
export type LoanUserLoanRoleEnum =
|
|
4294
|
-
| "Borrower"
|
|
4295
|
-
| "CoBorrower"
|
|
4296
|
-
| "NonBorrower"
|
|
4297
|
-
| "LoanOfficer"
|
|
4298
|
-
| "LoanProcessor"
|
|
4299
|
-
| "LoanOfficerAssistant"
|
|
4300
|
-
| "SupportingLoanOfficer"
|
|
4301
|
-
| "BuyerAgent"
|
|
4302
|
-
| "SellerAgent"
|
|
4303
|
-
| "TitleInsuranceAgent"
|
|
4304
|
-
| "EscrowAgent"
|
|
4305
|
-
| "SettlementAgent";
|
|
4306
|
-
|
|
4307
|
-
export type SamlMetadataRequestSsoIntegrationEnum =
|
|
4308
|
-
| "ConsumerConnect"
|
|
4309
|
-
| "TheBigPOS";
|
|
4310
|
-
|
|
4311
|
-
export type SiteConfigurationTypeEnum =
|
|
4312
|
-
| "None"
|
|
4313
|
-
| "Account"
|
|
4314
|
-
| "Corporate"
|
|
4315
|
-
| "Branch"
|
|
4316
|
-
| "LoanOfficer"
|
|
4317
|
-
| "Partner";
|
|
4318
|
-
|
|
4319
|
-
export type SiteConfigurationByUrlTypeEnum =
|
|
4320
|
-
| "None"
|
|
4321
|
-
| "Account"
|
|
4322
|
-
| "Corporate"
|
|
4323
|
-
| "Branch"
|
|
4324
|
-
| "LoanOfficer"
|
|
4325
|
-
| "Partner";
|
|
4326
|
-
|
|
4327
|
-
export type SiteConfigurationReducedTypeEnum =
|
|
4328
|
-
| "None"
|
|
4329
|
-
| "Account"
|
|
4330
|
-
| "Corporate"
|
|
4331
|
-
| "Branch"
|
|
4332
|
-
| "LoanOfficer"
|
|
4333
|
-
| "Partner";
|
|
4334
|
-
|
|
4335
|
-
export type SiteConfigurationRequestTypeEnum =
|
|
4336
|
-
| "None"
|
|
4337
|
-
| "Account"
|
|
4338
|
-
| "Corporate"
|
|
4339
|
-
| "Branch"
|
|
4340
|
-
| "LoanOfficer"
|
|
4341
|
-
| "Partner";
|
|
4342
|
-
|
|
4343
|
-
export type SiteConfigurationSummaryTypeEnum =
|
|
4344
|
-
| "None"
|
|
4345
|
-
| "Account"
|
|
4346
|
-
| "Corporate"
|
|
4347
|
-
| "Branch"
|
|
4348
|
-
| "LoanOfficer"
|
|
4349
|
-
| "Partner";
|
|
4350
|
-
|
|
4351
|
-
export type UserDraftRoleEnum =
|
|
4352
|
-
| "Borrower"
|
|
4353
|
-
| "CoBorrower"
|
|
4354
|
-
| "NonBorrower"
|
|
4355
|
-
| "LoanOfficer"
|
|
4356
|
-
| "LoanProcessor"
|
|
4357
|
-
| "LoanOfficerAssistant"
|
|
4358
|
-
| "SupportingLoanOfficer"
|
|
4359
|
-
| "BuyerAgent"
|
|
4360
|
-
| "SellerAgent"
|
|
4361
|
-
| "TitleInsuranceAgent"
|
|
4362
|
-
| "EscrowAgent"
|
|
4363
|
-
| "SettlementAgent";
|
|
4364
|
-
|
|
4365
|
-
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
4366
|
-
|
|
4367
|
-
export type UserLoanRoleEnum =
|
|
4368
|
-
| "Borrower"
|
|
4369
|
-
| "CoBorrower"
|
|
4370
|
-
| "NonBorrower"
|
|
4371
|
-
| "LoanOfficer"
|
|
4372
|
-
| "LoanProcessor"
|
|
4373
|
-
| "LoanOfficerAssistant"
|
|
4374
|
-
| "SupportingLoanOfficer"
|
|
4375
|
-
| "BuyerAgent"
|
|
4376
|
-
| "SellerAgent"
|
|
4377
|
-
| "TitleInsuranceAgent"
|
|
4378
|
-
| "EscrowAgent"
|
|
4379
|
-
| "SettlementAgent";
|
|
4380
|
-
|
|
4381
|
-
export type UserLoanConsentTypeEnum =
|
|
4382
|
-
| "Econsent"
|
|
4383
|
-
| "CreditAuthorization"
|
|
4384
|
-
| "Tcpa";
|
|
4385
|
-
|
|
4386
|
-
export type UserSummaryRoleEnum =
|
|
4387
|
-
| "Borrower"
|
|
4388
|
-
| "LoanOfficer"
|
|
4389
|
-
| "Admin"
|
|
4390
|
-
| "SuperAdmin"
|
|
4391
|
-
| "Realtor"
|
|
4392
|
-
| "SettlementAgent"
|
|
4393
|
-
| "LoanProcessor"
|
|
4394
|
-
| "LoanOfficerAssistant"
|
|
4395
|
-
| "BranchManager"
|
|
4396
|
-
| "SystemAdmin";
|
|
4397
|
-
|
|
4398
|
-
/** @default "Realtor" */
|
|
4399
|
-
export type GetPartnersParamsRoleEnum =
|
|
4400
|
-
| "Borrower"
|
|
4401
|
-
| "LoanOfficer"
|
|
4402
|
-
| "Admin"
|
|
4403
|
-
| "SuperAdmin"
|
|
4404
|
-
| "Realtor"
|
|
4405
|
-
| "SettlementAgent"
|
|
4406
|
-
| "LoanProcessor"
|
|
4407
|
-
| "LoanOfficerAssistant"
|
|
4408
|
-
| "BranchManager"
|
|
4409
|
-
| "SystemAdmin";
|
|
4410
|
-
|
|
4411
|
-
export type GetSamlMetadataParamsSSoIntegrationEnum =
|
|
4412
|
-
| "ConsumerConnect"
|
|
4413
|
-
| "TheBigPOS";
|
|
4414
|
-
|
|
4415
|
-
export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
|
|
4416
|
-
|
|
4417
|
-
export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
|
|
4418
|
-
| "ConsumerConnect"
|
|
4419
|
-
| "TheBigPOS";
|
|
4420
|
-
|
|
4421
|
-
export type CreateOrReplaceSamlMetadataParamsEnum =
|
|
4422
|
-
| "ConsumerConnect"
|
|
4423
|
-
| "TheBigPOS";
|
|
4424
|
-
|
|
4425
5592
|
import type {
|
|
4426
5593
|
AxiosInstance,
|
|
4427
5594
|
AxiosRequestConfig,
|
|
@@ -6853,10 +8020,18 @@ export class Api<
|
|
|
6853
8020
|
* @response `422` `UnprocessableEntity` Client Error
|
|
6854
8021
|
* @response `423` `UnprocessableEntity` Client Error
|
|
6855
8022
|
*/
|
|
6856
|
-
createLoanInternal: (
|
|
8023
|
+
createLoanInternal: (
|
|
8024
|
+
data: any,
|
|
8025
|
+
query?: {
|
|
8026
|
+
/** @default false */
|
|
8027
|
+
isPatch?: boolean;
|
|
8028
|
+
},
|
|
8029
|
+
params: RequestParams = {},
|
|
8030
|
+
) =>
|
|
6857
8031
|
this.request<string, UnprocessableEntity>({
|
|
6858
8032
|
path: `/api/los/loan/application/internal`,
|
|
6859
8033
|
method: "POST",
|
|
8034
|
+
query: query,
|
|
6860
8035
|
body: data,
|
|
6861
8036
|
secure: true,
|
|
6862
8037
|
type: ContentType.Json,
|
|
@@ -6899,6 +8074,7 @@ export class Api<
|
|
|
6899
8074
|
* @request PATCH:/api/los/loan/application/{loanID}/consent
|
|
6900
8075
|
* @secure
|
|
6901
8076
|
* @response `200` `string` Success
|
|
8077
|
+
* @response `202` `string` Accepted
|
|
6902
8078
|
* @response `422` `UnprocessableEntity` Client Error
|
|
6903
8079
|
*/
|
|
6904
8080
|
updateLoanConsent: (
|
|
@@ -8688,6 +9864,59 @@ export class Api<
|
|
|
8688
9864
|
...params,
|
|
8689
9865
|
}),
|
|
8690
9866
|
|
|
9867
|
+
/**
|
|
9868
|
+
* @description Creates a new loan or adds borrowers to an existing loan based on the presence of LoanID
|
|
9869
|
+
*
|
|
9870
|
+
* @tags Loans V3
|
|
9871
|
+
* @name SubmitLoanApplication
|
|
9872
|
+
* @summary Submit Loan Application
|
|
9873
|
+
* @request POST:/api/v3/loans/applications
|
|
9874
|
+
* @secure
|
|
9875
|
+
* @response `201` `LoanApplication` Created
|
|
9876
|
+
* @response `400` `any` Bad Request
|
|
9877
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
9878
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
9879
|
+
* @response `404` `ProblemDetails` Not Found
|
|
9880
|
+
*/
|
|
9881
|
+
submitLoanApplication: (
|
|
9882
|
+
data: LoanApplicationRequest,
|
|
9883
|
+
params: RequestParams = {},
|
|
9884
|
+
) =>
|
|
9885
|
+
this.request<LoanApplication, ProblemDetails>({
|
|
9886
|
+
path: `/api/v3/loans/applications`,
|
|
9887
|
+
method: "POST",
|
|
9888
|
+
body: data,
|
|
9889
|
+
secure: true,
|
|
9890
|
+
type: ContentType.Json,
|
|
9891
|
+
format: "json",
|
|
9892
|
+
...params,
|
|
9893
|
+
}),
|
|
9894
|
+
|
|
9895
|
+
/**
|
|
9896
|
+
* @description Partially update a loan using GUID-based patch operations. Supports GUID lookups in collections, eliminating index ordering issues.
|
|
9897
|
+
*
|
|
9898
|
+
* @tags Loans V3
|
|
9899
|
+
* @name PatchLoan
|
|
9900
|
+
* @summary Patch Loan (GUID-based)
|
|
9901
|
+
* @request PATCH:/api/v3/loans/{id}
|
|
9902
|
+
* @secure
|
|
9903
|
+
* @response `200` `LoanApplication` Success
|
|
9904
|
+
* @response `400` `any` Bad Request
|
|
9905
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
9906
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
9907
|
+
* @response `404` `ProblemDetails` Not Found
|
|
9908
|
+
* @response `409` `any` Conflict
|
|
9909
|
+
*/
|
|
9910
|
+
patchLoan: (id: string, data: any, params: RequestParams = {}) =>
|
|
9911
|
+
this.request<LoanApplication, ProblemDetails>({
|
|
9912
|
+
path: `/api/v3/loans/${id}`,
|
|
9913
|
+
method: "PATCH",
|
|
9914
|
+
body: data,
|
|
9915
|
+
secure: true,
|
|
9916
|
+
format: "json",
|
|
9917
|
+
...params,
|
|
9918
|
+
}),
|
|
9919
|
+
|
|
8691
9920
|
/**
|
|
8692
9921
|
* No description
|
|
8693
9922
|
*
|
|
@@ -8719,7 +9948,7 @@ export class Api<
|
|
|
8719
9948
|
query: query,
|
|
8720
9949
|
body: data,
|
|
8721
9950
|
secure: true,
|
|
8722
|
-
type: ContentType.
|
|
9951
|
+
type: ContentType.JsonPatch,
|
|
8723
9952
|
format: "json",
|
|
8724
9953
|
...params,
|
|
8725
9954
|
}),
|
|
@@ -9731,7 +10960,17 @@ export class Api<
|
|
|
9731
10960
|
query?: {
|
|
9732
10961
|
showAll?: boolean;
|
|
9733
10962
|
/** @default "Realtor" */
|
|
9734
|
-
role?:
|
|
10963
|
+
role?:
|
|
10964
|
+
| "Borrower"
|
|
10965
|
+
| "LoanOfficer"
|
|
10966
|
+
| "Admin"
|
|
10967
|
+
| "SuperAdmin"
|
|
10968
|
+
| "Realtor"
|
|
10969
|
+
| "SettlementAgent"
|
|
10970
|
+
| "LoanProcessor"
|
|
10971
|
+
| "LoanOfficerAssistant"
|
|
10972
|
+
| "BranchManager"
|
|
10973
|
+
| "SystemAdmin";
|
|
9735
10974
|
/** @format int32 */
|
|
9736
10975
|
pageSize?: number;
|
|
9737
10976
|
/** @format int32 */
|
|
@@ -10067,7 +11306,7 @@ export class Api<
|
|
|
10067
11306
|
* @response `404` `ProblemDetails` Not Found
|
|
10068
11307
|
*/
|
|
10069
11308
|
getSamlMetadata: (
|
|
10070
|
-
sSoIntegration:
|
|
11309
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS",
|
|
10071
11310
|
ssoIntegration: string,
|
|
10072
11311
|
params: RequestParams = {},
|
|
10073
11312
|
) =>
|
|
@@ -10089,7 +11328,7 @@ export class Api<
|
|
|
10089
11328
|
* @response `200` `File` Success
|
|
10090
11329
|
*/
|
|
10091
11330
|
createOrReplaceSamlMetadata: (
|
|
10092
|
-
sSoIntegration:
|
|
11331
|
+
sSoIntegration: "ConsumerConnect" | "TheBigPOS",
|
|
10093
11332
|
ssoIntegration: string,
|
|
10094
11333
|
params: RequestParams = {},
|
|
10095
11334
|
) =>
|