Mortgage Input

Represents the input for mortgage POST or PATCH method.

JSON example

1{
2  "accountId": "001RM000004XraFYAS",
3  "amortizationTerm": 30,
4  "amortizationType": "Adjustable Rate",
5  "assets": [
6    {
7      "accountNumber": "849393",
8      "accountType": "Checking",
9      "assetClass": "Financial",
10      "assetType": "Earnest Money",
11      "borrowersExternalIds": [
12        "0fc5e4d6-de5d-4954-9d21-3c628ad8809a",
13        "732c3d7e-78ae-4b5e-944d-f411fb4011d4"
14      ],
15      "cashOrMarketValue": 434934903,
16      "dispositionType": "Pending Sale",
17      "extendedFields": [],
18      "externalId": "df126729-19c0-4dc9-80c6-322bc6fb994c",
19      "financialInstitutionName": "BOFA",
20      "grossMonthlyRentalIncome": 355395355,
21      "name": "Asset1",
22      "netMonthlyRentalIncome": 2535345,
23      "presentMarketValue": 7937399,
24      "realEstateAddress": {
25        "city": "San Francisco",
26        "country": "CA",
27        "street": "234 1st Street"
28      },
29      "realEstateMonthlyExpense": 3413131
30    },
31    {
32      "accountNumber": "2424242424",
33      "accountType": "Checking",
34      "assetClass": "Real Estate",
35      "assetType": "Earnest Money",
36      "borrowersExternalIds": [
37        "0fc5e4d6-de5d-4954-9d21-3c628ad8809a",
38        "732c3d7e-78ae-4b5e-944d-f411fb4011d4"
39      ],
40      "cashOrMarketValue": 24424525,
41      "dispositionType": "Sold",
42      "extendedFields": [],
43      "externalId": "a57f5b81-477b-41a3-a647-5852562913e5",
44      "financialInstitutionName": "wells",
45      "grossMonthlyRentalIncome": 24242224,
46      "name": "Asset2",
47      "netMonthlyRentalIncome": 242424234,
48      "presentMarketValue": 2423131313,
49      "realEstateAddress": {
50        "city": "San Francisco",
51        "country": "CA",
52        "street": "123 2nd Street"
53      },
54      "realEstateMonthlyExpense": 2242423424
55    }
56  ],
57  "balloonTermMonths": 3,
58  "borrowers": [
59    {
60      "addresses": [
61        {
62          "addressOwnership": "Own",
63          "extendedFields": [],
64          "externalId": "e8d51e2a-7d97-4da0-8356-ca86995d3d39",
65          "monthlyRentPayment": 2300,
66          "name": "Addr1",
67          "residenceAdditionalMonthCount": 23,
68          "residenceAddress": {
69            "city": "San Francisco",
70            "country": "United States",
71            "postalCode": "94105",
72            "state": "CA",
73            "street": "50 Fremont Street"
74          },
75          "residenceYearCount": 3,
76          "residencyType": "Former Residence"
77        }
78      ],
79      "asianRaceSubType": "Asian Indian",
80      "borrowerType": "Borrower",
81      "citizenshipStatus": "U.S. Citizen",
82      "declarations": [
83        {
84          "bankruptcyType": "Chapter 11",
85          "borrowedAmount": 20000,
86          "extendedFields": [],
87          "externalId": "be71c372-8290-44dc-bb73-6f6d1ce7e9a9",
88          "hasBorrowedMoney": true,
89          "hasCoSignerUndisclosedDebt": true,
90          "hasDeclaredBankruptcy": true,
91          "hasDeedSurrender": true,
92          "hasOutstandingJudgement": true,
93          "hasOwnershipInterest": true,
94          "hasPastShortSale": true,
95          "hasPropertyForeclosed": true,
96          "hasUndisclosedAddCreditApp": true,
97          "hasUndisclosedOtherPropLoan": true,
98          "isPartyToLawsuit": true,
99          "isPresentlyDelinquent": true,
100          "isPrimaryResidence": true,
101          "isRelatedToSeller": true,
102          "name": "Decl1",
103          "priorPropertyTitleType": "Yourself",
104          "priorPropertyUsageType": "Secondary Residence"
105        }
106      ],
107      "dependentCount": 2,
108      "dependentsAge": "25,34",
109      "employments": [
110        {
111          "currentJobAdditionalMonthCount": 24,
112          "currentJobYearCount": 4,
113          "employerAddress": {
114            "city": "Fresno",
115            "country": "United States",
116            "postalCode": "93721",
117            "state": "CA",
118            "street": "1500 Divisadero Street"
119          },
120          "extendedFields": [],
121          "externalId": "2a9460d0-3194-449a-8bf0-488a6cbaed0a",
122          "isRelToTransactionParty": true,
123          "isLessThanQuarterShare": true,
124          "isSelfEmployed": true,
125          "jobTitle": "developer",
126          "monthlyBaseIncomeAmount": 2300,
127          "monthlyBonusAmount": 100,
128          "monthlyCommissionAmount": 10,
129          "monthlyIncome": 5000,
130          "monthlyMilitaryEntitlementAmt": 20,
131          "monthlyOtherIncomeAmount": 10,
132          "monthlyOvertimeAmount": 200,
133          "name": "Empl1",
134          "startDate": "2019-10-10T03:11:27.000Z"
135        }
136      ],
137      "ethnicitySubType": "Mexican",
138      "ethnicityType": "Not Hispanic or Latino",
139      "extendedFields": [],
140      "externalId": "0fc5e4d6-de5d-4954-9d21-3c628ad8809a",
141      "genderType": "Female",
142      "hasMilitaryService": true,
143      "incomes": [
144        {
145          "extendedFields": [],
146          "externalId": "b19d9372-df99-4eec-9de0-ad785503992d",
147          "incomeSourceType": "Capital Gains",
148          "monthlyIncomeAmount": 100,
149          "name": "Income1"
150        }
151      ],
152      "isActiveMilitary": true,
153      "isJointCredit": true,
154      "isSurvivingMilitarySpouse": true,
155      "maritalStatus": "Married",
156      "militaryTourExpirationMonth": 2,
157      "militaryTourExpirationYear": 2027,
158      "name": "BR1",
159      "otherAsianRaceSubType": "Indian",
160      "otherEthnicitySubType": "Mexico",
161      "otherPacIslandSubType": "Test Pacific Islander",
162      "pacificIslanderSubType": "Native Hawaiian",
163      "preferredLanguage": "English",
164      "raceType": "Asian",
165      "tribeName": "Pacific Islander",
166      "wasActiveMilitary": true,
167      "wasNonActivatedService": true
168    },
169    {
170      "addresses": [
171        {
172          "addressOwnership": "Rent",
173          "extendedFields": [],
174          "externalId": "86c168dd-a29c-4c0b-b366-51a40cd66c4b",
175          "monthlyRentPayment": 5000,
176          "name": "Addr2",
177          "residenceAdditionalMonthCount": 24,
178          "residenceAddress": {
179            "city": "San Francisco",
180            "country": "United States",
181            "postalCode": "94115",
182            "state": "CA",
183            "street": "1500 Divisadero Street"
184          },
185          "residenceYearCount": 3,
186          "residencyType": "Present Address"
187        }
188      ],
189      "asianRaceSubType": "Asian Indian",
190      "borrowerType": "CoBorrower",
191      "citizenshipStatus": "U.S. Citizen",
192      "declarations": [
193        {
194          "bankruptcyType": "Chapter 12",
195          "borrowedAmount": 657575,
196          "extendedFields": [],
197          "externalId": "704e7cfd-932c-4a17-81ad-844fe1a007c6",
198          "hasBorrowedMoney": true,
199          "hasCoSignerUndisclosedDebt": true,
200          "hasDeclaredBankruptcy": true,
201          "hasDeedSurrender": true,
202          "hasOutstandingJudgement": true,
203          "hasOwnershipInterest": true,
204          "hasPastShortSale": true,
205          "hasPropertyForeclosed": true,
206          "hasUndisclosedAddCreditApp": true,
207          "hasUndisclosedOtherPropLoan": true,
208          "isPartyToLawsuit": true,
209          "isPresentlyDelinquent": true,
210          "isPrimaryResidence": true,
211          "isRelatedToSeller": true,
212          "name": "Decl1",
213          "priorPropertyTitleType": "Yourself",
214          "priorPropertyUsageType": "Primary Residence"
215        }
216      ],
217      "dependentCount": 2,
218      "dependentsAge": "34,35",
219      "employments": [
220        {
221          "currentJobAdditionalMonthCount": 24,
222          "currentJobYearCount": 3,
223          "employerAddress": {
224            "city": "Fresno",
225            "country": "United States",
226            "postalCode": "93721",
227            "state": "CA",
228            "street": "2300 Stockton Street"
229          },
230          "extendedFields": [],
231          "externalId": "34380cb7-95ca-4867-9a74-972af1be22db",
232          "isRelToTransactionParty": true,
233          "isLessThanQuarterShare": true,
234          "isSelfEmployed": true,
235          "jobTitle": "developer",
236          "monthlyBaseIncomeAmount": 2400,
237          "monthlyBonusAmount": 234,
238          "monthlyCommissionAmount": 10,
239          "monthlyIncome": 45668,
240          "monthlyMilitaryEntitlementAmt": 20,
241          "monthlyOtherIncomeAmount": 394,
242          "monthlyOvertimeAmount": 123,
243          "name": "Empl2",
244          "startDate": "2019-10-10T03:11:27.000Z"
245        }
246      ],
247      "ethnicitySubType": "Mexican",
248      "ethnicityType": "Hispanic or Latino",
249      "extendedFields": [],
250      "externalId": "732c3d7e-78ae-4b5e-944d-f411fb4011d4",
251      "genderType": "Female",
252      "hasMilitaryService": true,
253      "incomes": [
254        {
255          "extendedFields": [],
256          "externalId": "91027067-09d3-45f2-a0fc-217ce1f63458",
257          "incomeSourceType": "Child Support",
258          "monthlyIncomeAmount": 200,
259          "name": "Income1"
260        }
261      ],
262      "isActiveMilitary": true,
263      "isJointCredit": true,
264      "isSurvivingMilitarySpouse": true,
265      "maritalStatus": "Married",
266      "militaryTourExpirationMonth": 3,
267      "militaryTourExpirationYear": 2029,
268      "name": "COB1",
269      "otherAsianRaceSubType": "South india",
270      "otherEthnicitySubType": "Mexico",
271      "otherPacIslandSubType": "Test pacific Islander",
272      "pacificIslanderSubType": "Guamanian or Chamorro",
273      "preferredLanguage": "English",
274      "raceType": "American Indian or Alaska Native",
275      "tribeName": "Pacific Islander",
276      "wasActiveMilitary": true,
277      "wasNonActivatedService": true
278    }
279  ],
280  "estateHoldType": "Fee Simple",
281  "extendedFields": [],
282  "externalId": "0c4a3933-47d3-43d5-a2e6-09ae10e11a5e",
283  "financials": [
284    {
285      "borrowerClosingCostAmt": 95956,
286      "counselingAgencyProviderName": "Test provider",
287      "counselingCompleteBorrName": "BR1",
288      "counselingCompletionDate": "2019-10-31T19:00:00.000Z",
289      "creditFromSeller": 33342,
290      "discountPointCostAmount": 59586,
291      "estFirstMortgagePayment": 459677,
292      "estHomeownerInsurancePayment": 35521,
293      "estMortgageInsurancePayment": 2424555,
294      "estOtherDuesPayment": 24354,
295      "estOtherPayment": 323231,
296      "estPropertyTaxesPayment": 422556,
297      "estSubordinateLienPayment": 35453,
298      "estSuppPropInsurancePayment": 44959,
299      "extendedFields": [],
300      "externalId": "af7e7c76-33ac-4005-b377-4b4663a49ec9",
301      "financeMortgageInsuranceAmt": 353,
302      "hasCompletedCounseling": true,
303      "hasHomeownerEducation": true,
304      "homeEdCompletedBorrowerName": "BR1",
305      "homeownerEdCompleteDate": "2019-10-24T19:00:00.000Z",
306      "homeownerEdFormat": "Attended Workshop in Person",
307      "housingCounselingFormat": "Face-to-Face",
308      "hudApproveAgencyId": "12344",
309      "hudApprovedProviderId": "3532",
310      "landAcquiredSeparatelyAmount": 2040,
311      "loanAmtExclFinMortgageInsurance": 33345,
312      "name": "Fin1",
313      "otherCredit": 2242,
314      "otherNewMortgageLoanAmt": 253535,
315      "outstandingLoanAmount": 24505056,
316      "purchasePriceAmount": 150000,
317      "remodelAndRepairsAmount": 3040
318    }
319  ],
320  "hasOtherLoanFeature": true,
321  "hasPrepaymentPenalty": true,
322  "improvementCost": 100,
323  "initialBuydownRate": 401,
324  "interestOnlyMonthCount": 4,
325  "interestRate": 4,
326  "isBalloon": true,
327  "isBorrowerInCommunityPropState": true,
328  "isConstructionToPermanent": true,
329  "isContractForDeed": true,
330  "isEnergyRelatedImprovement": true,
331  "isInterestOnly": true,
332  "isNegativeAmortization": true,
333  "isPropInCommunityPropState": true,
334  "isRenovation": true,
335  "isSingleClosing": true,
336  "isSubjectToPriorityLien": true,
337  "isTempIntRateBuydown": true,
338  "leaseHoldExpirationDate": "2019-10-31T19:00:00.000Z",
339  "liabilities": [
340    {
341      "accountNumber": "134234242",
342      "accountType": "Revolving",
343      "borrowersExternalIds": [
344        "0fc5e4d6-de5d-4954-9d21-3c628ad8809a",
345        "732c3d7e-78ae-4b5e-944d-f411fb4011d4"
346      ],
347      "creditLimitAmount": 34353,
348      "creditorName": "BOFA",
349      "extendedFields": [],
350      "externalId": "df126729-19c0-4dc9-80c6-322bc6fb994c",
351      "isJointLiability": true,
352      "liabilityClass": "Financial",
353      "loanType": "Conventional",
354      "monthlyPaymentAmount": 35353,
355      "name": "Liab1",
356      "otherLiabilityType": "Child Support",
357      "shouldBePaidInFull": true,
358      "unpaidBalanceAmount": 242
359    },
360    {
361      "accountNumber": "464634123",
362      "accountType": "Revolving",
363      "borrowersExternalIds": [
364        "0fc5e4d6-de5d-4954-9d21-3c628ad8809a",
365        "732c3d7e-78ae-4b5e-944d-f411fb4011d4"
366      ],
367      "creditLimitAmount": 423465356,
368      "creditorName": "CHase",
369      "extendedFields": [],
370      "externalId": "194bcc9c-7b86-4a49-9d17-fad0e4d205a3",
371      "isJointLiability": true,
372      "liabilityClass": "Financial",
373      "loanType": "Conventional",
374      "monthlyPaymentAmount": 2423535,
375      "name": "Liab2",
376      "otherLiabilityType": "Alimony",
377      "shouldBePaidInFull": true,
378      "unpaidBalanceAmount": 553
379    }
380  ],
381  "loanPurpose": "Purchase",
382  "lotAcquiredDate": "2019-10-31T19:00:00.000Z",
383  "lotOriginalCost": 200.3,
384  "monthsBeforeFirstAdj": 2,
385  "monthsBetweenAdjustments": 3,
386  "mortgageLienType": "First Lien",
387  "mortgageProgramType": "Conventional",
388  "name": "Loan1",
389  "nativeLandTenure": "Fee Simple (On a Reservation)",
390  "otherAmortizationType": "Test Amortization type",
391  "otherLoanFeature": "Test Loan Feature",
392  "otherLoanPurpose": "Test Loan Purpose",
393  "otherMortgageProgramType": "Test program",
394  "otherRefinanceProgType": "Test Refinance",
395  "prepayPenaltyTermMonth": 5,
396  "projectType": "Cooperative",
397  "properties": [
398    {
399      "esMonthlyRentalIncome": 400506,
400      "esNetMonthlyRentalIncome": 304056,
401      "extendedFields": [],
402      "externalId": "a57f5b81-477b-41a3-a647-5852562913e5",
403      "isManufacturedHome": true,
404      "isMixedUseProperty": true,
405      "loanPurposeType": "Purchase",
406      "name": "Prop1",
407      "propertyUseType": "Primary Residence",
408      "propertyValue": 50500555,
409      "requestedLoanAmount": 5005000,
410      "unitsFinancedCount": 5
411    }
412  ],
413  "refinanceProgramType": "Full Documentation",
414  "refinanceType": "No Cash Out",
415  "status": "New",
416  "titleHolders": [
417    {
418      "extendedFields": [],
419      "externalId": "e8d51e2a-7d97-4da0-8356-ca86995d3d39",
420      "isCurrentTitleHolder": true,
421      "name": "T1",
422      "titleHolderName": "Times"
423    }
424  ],
425  "titleType": "Joint Tenancy with Right of Survivorship",
426  "trustTitleType": "Title Will be Held by an Inter Vivos (Living) Trust"
427}

Properties

Name	Type	Description	Required or Optional	Available Version
`accountId`	String	Account associated with the application.	Required if `opportunityId` isn’t provided	48.0
`amortizationTerm`	Integer	Duration of the amortization in months.	Optional	48.0
`amortizationType`	String	Amortization type for loan.	Optional	48.0
`assets`	Asset Input[]	Represents details about the borrower's and co-borrower's current personal and real property.	Optional	48.0
`balloonTermMonths`	Integer	Number of months during which the cumulative loan must be repaid.	Optional	48.0
`borrowers`	Borrower Input[]	List of borrowers for a loan application.	Optional	48.0
`estateHoldType`	String	Lender's lien is on both land and structure (fee simple) or just structure (leasehold).	Optional	48.0
`extendedFields`	Extended Fields Input[]	Represents custom fields related to a loan application.	Optional	48.0
`externalId`	String	Identifier assigned to imported data by external data source (if applicable).	Optional	48.0
`financials`	Financial Input[]	Represents transaction details for a loan application.	Optional	48.0
`hasOtherLoanFeature`	Boolean	Indicates whether loan has other amortization feature.	Optional	48.0
`hasPrepaymentPenalty`	Boolean	Indicates whether penalty is incurred if borrower pays off loan balance before the loan term expires.	Optional	48.0
`improvementCost`	Double	Construction costs for a construction loan or home improvement costs for a renovation loan.	Optional	48.0
`initialBuydownRate`	Double	Initial lesser interest rate for the loan.	Optional	48.0
`interestOnlyMonthCount`	Integer	Number of months that loan payments are interest only.	Optional	48.0
`interestRate`	Double	Interest rate for loan.	Optional	48.0
`isBalloon`	Boolean	Indicates whether borrower is applying for a balloon payment mortgage.	Optional	48.0
`isBorrowerInCommunityPropState`	Boolean	Indicates whether borrower lives in community property state.	Optional	48.0
`isConstructionToPermanent`	Boolean	Indicates whether at least one borrower lives in a community property state.	Optional	48.0
`isContractForDeed`	Boolean	Indicates whether loan proceeds are to pay off balance due on a contract for deed or land contract.	Optional	48.0
`isEnergyRelatedImprovement`	Boolean	Indicates whether loan is to finance energy-related improvements.	Optional	48.0
`isInterestOnly`	Boolean	Indicates whether borrower is applying for an interest-only mortgage.	Optional	48.0
`isNegativeAmortization`	Boolean	Indicates whether loan allows for negative amortization where shortfalls in interest payments are added to the outstanding loan balance.	Optional	48.0
`isPropInCommunityPropState`	Boolean	Indicates whether property is located in a community property state.	Optional	48.0
`isRenovation`	Boolean	Indicates whether loan proceeds to finance cost of renovations to the property, and renovation value is included in the property's appraised value.	Optional	48.0
`isSingleClosing`	Boolean	Indicates whether construction and permanent loans have a single combined closing. Once construction is complete, loan converts to a traditional mortgage.	Optional	48.0
`isSubjectToPriorityLien`	Boolean	Indicates whether property is currently subject to an energy-related lien that could take priority over the first mortgage lien.	Optional	48.0
`isTempIntRateBuydown`	Boolean	Indicates whether borrower is applying for loan with an initially reduced interest payment in exchange for an up-front cash deposit.	Optional	48.0
`leaseHoldExpirationDate`	String	Date when leasehold expires if land is leased.	Optional	48.0
`liabilities`	Liability Input[]	Represents details about the borrower and co-borrower current liabilities.	Optional	48.0
`loanPurpose`	String	Purpose of the loan.	Optional	48.0
`lotAcquiredDate`	String	Month and year property or land was purchased.	Optional	48.0
`lotOriginalCost`	Double	Original property cost (refinance) or original land cost (construction).	Optional	48.0
`monthsBeforeFirstAdj`	Integer	Initial period prior to first adjustment in months.	Optional	48.0
`monthsBetweenAdjustments`	Integer	Number of months before the first rate adjustment for an adjustable rate loan.	Optional	48.0
`mortgageLienType`	String	Type of mortgage lien associated with this loan application.	Optional	48.0
`mortgageProgramType`	String	Type of mortgage program applied for.	Optional	48.0
`name`	String	Name of the residential loan application.	Required	48.0
`nativeLandTenure`	String	Property is located on an area reserved by or for an Indian land, village, or tribe to live on and use.	Optional	48.0
`opportunityId`	String	Opportunity associated with the application.	Required if `accountId` isn’t provided	48.0
`otherAmortizationType`	String	Description of other amortization type for government loans.	Optional	48.0
`otherLoanFeature`	String	Description of other loan amortization feature.	Optional	48.0
`otherLoanPurpose`	String	What the borrower will use the loan for if other was specified.	Optional	48.0
`otherMortgageProgramType`	String	Description of the other mortgage type.	Optional	48.0
`otherRefinanceProgType`	String	Refinance program name if other was specified.	Optional	48.0
`prepayPenaltyTermMonth`	Integer	Number of months during which borrower incurs a penalty for early payoff of the loan balance.	Optional	48.0
`projectType`	String	Specifies the type of project that the property belongs to.	Optional	48.0
`properties`	Property Input[]	Represents details of the property the loan application finances.	Optional	48.0
`refinanceProgramType`	String	The applicable refinance program type based on the investor, guarantor, or lender guidelines.	Optional	48.0
`refinanceType`	String	Refinance loan type.	Optional	48.0
`status`	String	Indicates the current status of the loan application.	Optional	48.0
`titleHolders`	Title Holder Input[]	Represents details of borrowers who are applying to hold title to the property the loan application finances.	Optional	48.0
`titleType`	String	Way the borrower or borrowers take title for the loan.	Optional	48.0
`trustTitleType`	String	Title to be held in a living trust or a land trust.	Optional	48.0

Financial Services Cloud Developer Guide

Mortgage Input