Use a single API call to get and update mortgage application information like borrowers, declarations, incomes, addresses, financial transactions, liabilities, assets, properties, and title holders. You can use both the loanApplicationId and the externalID of an external system to get a mortgage application.
1/connect/financialservices/mortgages/LOAN_ID48.0
Use OAuth to connect to Salesforce and get an access token. Pass the access token in your requests.
GET, PATCH
| Parameter Name | Type | Description | Required | Available version |
|---|---|---|---|---|
| loanId | String | id or externalId associated with a loan application. | Yes | 48.0 |
1{
2 "amortizationTerm": 30
3}| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
message | String | Error message, if any. | Small, 48.0 | 48.0 |
result | Mortgage Information Output[] | Data of the mortgage result. | Small, 48.0 | 48.0 |
1{
2 "result" : {
3 "accountId" : "001RM000004Xra2YAC",
4 "assets" : [ ],
5 "borrowers" : [ ],
6 "createdById" : "005RM000001vbghYAA",
7 "createdDate" : "2019-11-06T19:29:10.000Z",
8 "extendedFields" : [ ],
9 "externalId" : "tt2",
10 "financials" : [ ],
11 "hasOtherLoanFeature" : false,
12 "hasPrepaymentPenalty" : false,
13 "id" : "0cdRM00000000n5YAA",
14 "isBalloon" : false,
15 "isBorrowerInCommunityPropState" : false,
16 "isConstructionToPermanent" : false,
17 "isContractForDeed" : false,
18 "isDeleted" : false,
19 "isEnergyRelatedImprovement" : false,
20 "isInterestOnly" : false,
21 "isNegativeAmortization" : false,
22 "isPropInCommunityPropState" : false,
23 "isRenovation" : false,
24 "isSingleClosing" : false,
25 "isSubjectToPriorityLien" : false,
26 "isTempIntRateBuydown" : false,
27 "lastModifiedById" : "005RM000001vbghYAA",
28 "lastModifiedDate" : "2019-11-06T19:31:07.000Z",
29 "lastReferencedDate" : "2019-11-06T19:35:31.000Z",
30 "lastViewedDate" : "2019-11-06T19:35:31.000Z",
31 "liabilities" : [ ],
32 "name" : "tt2",
33 "ownerId" : "005RM000001vbghYAA",
34 "properties" : [ ],
35 "systemModstamp" : "2019-11-06T19:31:07.000Z",
36 "titleHolders" : [ {
37 "createdById" : "005RM000001vbghYAA",
38 "createdDate" : "2019-11-06T19:29:10.000Z",
39 "extendedFields" : [ ],
40 "externalId" : "tt1",
41 "id" : "0cTRM000000009e2AA",
42 "isCurrentTitleHolder" : false,
43 "isDeleted" : false,
44 "lastModifiedById" : "005RM000001vbghYAA",
45 "lastModifiedDate" : "2019-11-06T19:31:07.000Z",
46 "lastReferencedDate" : "2019-11-06T19:31:07.000Z",
47 "lastViewedDate" : "2019-11-06T19:31:07.000Z",
48 "loanApplicationId" : "0cdRM00000000n5YAA",
49 "name" : "tt2",
50 "systemModstamp" : "2019-11-06T19:31:07.000Z"
51 } ]
52 }
53}
j