Borrower Input

Represents details of the borrower or co-borrower for the loan application.

Root XML tag

<borrowers>

JSON example

1{
2  "borrowers": [
3    {
4      "addresses": [
5        {
6          "addressOwnership": "Own",
7          "extendedFields": [],
8          "externalId": "e8d51e2a-7d97-4da0-8356-ca86995d3d39",
9          "monthlyRentPayment": 2300,
10          "name": "Addr1",
11          "residenceAdditionalMonthCount": 23,
12          "residenceAddress": {
13            "city": "San Francisco",
14            "country": "United States",
15            "postalCode": "94105",
16            "state": "CA",
17            "street": "50 Fremont Street"
18          },
19          "residenceYearCount": 3,
20          "residencyType": "Former Residence"
21        }
22      ],
23      "asianRaceSubType": "Asian Indian",
24      "borrowerType": "Borrower",
25      "citizenshipStatus": "U.S. Citizen",
26      "declarations": [
27        {
28          "bankruptcyType": "Chapter 11",
29          "borrowedAmount": 20000,
30          "extendedFields": [],
31          "externalId": "be71c372-8290-44dc-bb73-6f6d1ce7e9a9",
32          "hasBorrowedMoney": true,
33          "hasCoSignerUndisclosedDebt": true,
34          "hasDeclaredBankruptcy": true,
35          "hasDeedSurrender": true,
36          "hasOutstandingJudgement": true,
37          "hasOwnershipInterest": true,
38          "hasPastShortSale": true,
39          "hasPropertyForeclosed": true,
40          "hasUndisclosedAddCreditApp": true,
41          "hasUndisclosedOtherPropLoan": true,
42          "isPartyToLawsuit": true,
43          "isPresentlyDelinquent": true,
44          "isPrimaryResidence": true,
45          "isRelatedToSeller": true,
46          "name": "Decl1",
47          "priorPropertyTitleType": "Yourself",
48          "priorPropertyUsageType": "Secondary Residence"
49        }
50      ],
51      "dependentCount": 2,
52      "dependentsAge": "25,34",
53      "employments": [
54        {
55          "currentJobAdditionalMonthCount": 24,
56          "currentJobYearCount": 4,
57          "employerAddress": {
58            "city": "Fresno",
59            "country": "United States",
60            "postalCode": "93721",
61            "state": "CA",
62            "street": "1500 Divisadero Street"
63          },
64          "extendedFields": [],
65          "externalId": "2a9460d0-3194-449a-8bf0-488a6cbaed0a",
66          "isRelToTransactionParty": true,
67          "isLessThanQuarterShare": true,
68          "isSelfEmployed": true,
69          "jobTitle": "developer",
70          "monthlyBaseIncomeAmount": 2300,
71          "monthlyBonusAmount": 100,
72          "monthlyCommissionAmount": 10,
73          "monthlyIncome": 5000,
74          "monthlyMilitaryEntitlementAmt": 20,
75          "monthlyOtherIncomeAmount": 10,
76          "monthlyOvertimeAmount": 200,
77          "name": "Empl1",
78          "startDate": "2019-10-10T03:11:27.000Z"
79        }
80      ],
81      "ethnicitySubType": "Mexican",
82      "ethnicityType": "Not Hispanic or Latino",
83      "extendedFields": [],
84      "externalId": "0fc5e4d6-de5d-4954-9d21-3c628ad8809a",
85      "genderType": "Female",
86      "hasMilitaryService": true,
87      "incomes": [
88        {
89          "extendedFields": [],
90          "externalId": "b19d9372-df99-4eec-9de0-ad785503992d",
91          "incomeSourceType": "Capital Gains",
92          "monthlyIncomeAmount": 100,
93          "name": "Income1"
94        }
95      ],
96      "isActiveMilitary": true,
97      "isJointCredit": true,
98      "isSurvivingMilitarySpouse": true,
99      "maritalStatus": "Married",
100      "militaryTourExpirationMonth": 2,
101      "militaryTourExpirationYear": 2027,
102      "name": "BR1",
103      "otherAsianRaceSubType": "Indian",
104      "otherEthnicitySubType": "Mexico",
105      "otherPacIslandSubType": "Test Pacific Islander",
106      "pacificIslanderSubType": "Native Hawaiian",
107      "preferredLanguage": "English",
108      "raceType": "Asian",
109      "tribeName": "Pacific Islander",
110      "wasActiveMilitary": true,
111      "wasNonActivatedService": true
112    },
113    {
114      "addresses": [
115        {
116          "addressOwnership": "Rent",
117          "extendedFields": [],
118          "externalId": "86c168dd-a29c-4c0b-b366-51a40cd66c4b",
119          "monthlyRentPayment": 5000,
120          "name": "Addr2",
121          "residenceAdditionalMonthCount": 24,
122          "residenceAddress": {
123            "city": "San Francisco",
124            "country": "United States",
125            "postalCode": "94115",
126            "state": "CA",
127            "street": "1500 Divisadero Street"
128          },
129          "residenceYearCount": 3,
130          "residencyType": "Present Address"
131        }
132      ],
133      "asianRaceSubType": "Asian Indian",
134      "borrowerType": "CoBorrower",
135      "citizenshipStatus": "U.S. Citizen",
136      "declarations": [
137        {
138          "bankruptcyType": "Chapter 12",
139          "borrowedAmount": 657575,
140          "extendedFields": [],
141          "externalId": "704e7cfd-932c-4a17-81ad-844fe1a007c6",
142          "hasBorrowedMoney": true,
143          "hasCoSignerUndisclosedDebt": true,
144          "hasDeclaredBankruptcy": true,
145          "hasDeedSurrender": true,
146          "hasOutstandingJudgement": true,
147          "hasOwnershipInterest": true,
148          "hasPastShortSale": true,
149          "hasPropertyForeclosed": true,
150          "hasUndisclosedAddCreditApp": true,
151          "hasUndisclosedOtherPropLoan": true,
152          "isPartyToLawsuit": true,
153          "isPresentlyDelinquent": true,
154          "isPrimaryResidence": true,
155          "isRelatedToSeller": true,
156          "name": "Decl1",
157          "priorPropertyTitleType": "Yourself",
158          "priorPropertyUsageType": "Primary Residence"
159        }
160      ],
161      "dependentCount": 2,
162      "dependentsAge": "34,35",
163      "employments": [
164        {
165          "currentJobAdditionalMonthCount": 24,
166          "currentJobYearCount": 3,
167          "employerAddress": {
168            "city": "Fresno",
169            "country": "United States",
170            "postalCode": "93721",
171            "state": "CA",
172            "street": "2300 Stockton Street"
173          },
174          "extendedFields": [],
175          "externalId": "34380cb7-95ca-4867-9a74-972af1be22db",
176          "isRelToTransactionParty": true,
177          "isLessThanQuarterShare": true,
178          "isSelfEmployed": true,
179          "jobTitle": "developer",
180          "monthlyBaseIncomeAmount": 2400,
181          "monthlyBonusAmount": 234,
182          "monthlyCommissionAmount": 10,
183          "monthlyIncome": 45668,
184          "monthlyMilitaryEntitlementAmt": 20,
185          "monthlyOtherIncomeAmount": 394,
186          "monthlyOvertimeAmount": 123,
187          "name": "Empl2",
188          "startDate": "2019-10-10T03:11:27.000Z"
189        }
190      ],
191      "ethnicitySubType": "Mexican",
192      "ethnicityType": "Hispanic or Latino",
193      "extendedFields": [],
194      "externalId": "732c3d7e-78ae-4b5e-944d-f411fb4011d4",
195      "genderType": "Female",
196      "hasMilitaryService": true,
197      "incomes": [
198        {
199          "extendedFields": [],
200          "externalId": "91027067-09d3-45f2-a0fc-217ce1f63458",
201          "incomeSourceType": "Child Support",
202          "monthlyIncomeAmount": 200,
203          "name": "Income1"
204        }
205      ],
206      "isActiveMilitary": true,
207      "isJointCredit": true,
208      "isSurvivingMilitarySpouse": true,
209      "maritalStatus": "Married",
210      "militaryTourExpirationMonth": 3,
211      "militaryTourExpirationYear": 2029,
212      "name": "COB1",
213      "otherAsianRaceSubType": "South india",
214      "otherEthnicitySubType": "Mexico",
215      "otherPacIslandSubType": "Test pacific Islander",
216      "pacificIslanderSubType": "Guamanian or Chamorro",
217      "preferredLanguage": "English",
218      "raceType": "American Indian or Alaska Native",
219      "tribeName": "Pacific Islander",
220      "wasActiveMilitary": true,
221      "wasNonActivatedService": true
222    }
223  ]
224}

Properties

Name	Type	Description	Required or Optional	Available Version
`addresses`	Borrower Address Input[]	Borrower’s addresses.	Optional	48.0
`asianRaceSubType`	String	Borrower's Asian race.	Optional	48.0
`borrowerType`	String	Applicant's borrower type.	Optional	48.0
`citizenshipStatus`	String	Borrower's citizenship status.	Optional	48.0
`contactId`	String	Contact associated with this borrower.	Optional	48.0
`declarations`	Borrower Declaration Input[]	Borrower’s declarations.	Optional	48.0
`dependentCount`	Integer	Borrower's number of dependents.	Optional	48.0
`dependentsAge`	String	Ages of borrower's dependents in a comma-separated list.	Optional	48.0
`employments`	Borrower Employment Input[]	Borrower’s employments.	Optional	48.0
`ethnicitySubType`	String	Borrower's ethnicity.	Optional	48.0
`ethnicityType`	String	Borrower's ethnicity origin.	Optional	48.0
`extendedFields`	Extended Fields Input[]	Custom fields.	Optional	48.0
`externalId`	String	ID that uniquely identifies imported data in an external data source (if applicable).	Optional	48.0
`genderType`	String	Borrower's gender.	Optional	48.0
`hasMilitaryService`	Boolean	Indicates whether the borrower is serving in the United States Armed Forces or the borrower or the borrower's deceased spouse served in the past.	Optional	48.0
`id`	String	ID of the borrower.	Optional	48.0
`incomes`	Borrower Income Input[]	Borrower’s incomes.	Optional	48.0
`isActiveMilitary`	Boolean	Indicates whether borrower is currently on active duty with the United States Armed Forces.	Optional	48.0
`isJointCredit`	Boolean	Indicates whether borrower is applying for joint credit.	Optional	48.0
`isSurvivingMilitarySpouse`	Boolean	Indicates whether borrower is a surviving spouse of a veteran.	Optional	48.0
`maritalStatus`	String	Borrower's marital status.	Optional	48.0
`militaryTourExpirationMonth`	Integer	Month that borrower's tour of service expires.	Optional	48.0
`militaryTourExpirationYear`	Integer	Year that borrower's tour of service expires.	Optional	48.0
`name`	String	Name of the borrower.	Optional	48.0
`otherAsianRaceSubType`	String	Borrower's Asian race if other is specified.	Optional	48.0
`otherEthnicitySubType`	String	Borrower’s ethnicity if other is specified.	Optional	48.0
`otherPacIslandSubType`	String	Borrower's native Hawaiian or Pacific Islander race if other is specified.	Optional	48.0
`pacificIslanderSubType`	String	Borrower's native Hawaiian or Pacific Islander race.	Optional	48.0
`preferredLanguage`	String	Borrower's preferred communication language.	Optional	48.0
`raceType`	String	Borrower's race.	Optional	48.0
`tribeName`	String	Name of borrower's enrolled or principal tribe.	Optional	48.0
`wasActiveMilitary`	Boolean	Indicates whether borrower is currently retired, discharged, or separated from active military duty.	Optional	48.0
`wasNonActivatedService`	Boolean	Indicates whether borrower's only military service was as a non-activated Reserve soldier or as a non-activated member of the National Guard.	Optional	48.0

Financial Services Cloud Developer Guide

Borrower Input