Download Postman Collection
API Reference

V3 Update Loan

patch
https://api.elliemae.com/encompass/v3/loans/

Updates an existing loan. This API also supports the application of loan program templates.

🚧

No validation errors are returned for non-editable option fields (e.g., field 19 "Loan Purpose Type"). If an invalid value is provided, this API will clear the existing value in the field and will not return an error. This behavior will be enhanced in a future release.

Sample Response

Click here to view the example response (PDF)

Usage Note

The "preview" parameter enables you to retrieve a preview of the loan response, using the request payload provided, without saving and committing data to the loan. To view the results of the operation, you must send both the "view" and "preview" parameters. For the view parameter, use the value applicable to your use case. You can follow up with a subsequent PATCH loan call with the same request payload, and this parameter set to “false’ or not provided, to save and commit the changes to the loan.

Path Params
string
required

Loan to which changes will be applied

Query Params
string

Lock ID used to lock loan

string

Action to be performed on the loan while updating the loan.
Possible values are:
- tpoRegister - Register a TPO loan. Submit Date (TPO.X4) should be blank.
- tpoSubmit - To submit a loan to TPO. Registration Date (TPO.X3) cannot be blank.
- tpoResubmit - To resubmit a loan to TPO. Registration Date (TPO.X3) cannot be blank.
- tpoOrderAppraisal - To update the appraisal ordered date for a loan (TPO.X117).
- tpoGenerateDisclosures - To update the LE or Disclosures generated date for a loan (TPO.X116).
- updateCorrespondentBalance - To update the correspondent balance on the loan.
Same as the Update Balances button in the Encompass Purchase Advice screen.
- updateCorrespondentFees - To update the correspondent fees on the loan.
Same as the Update Fees button in the Encompass Purchase Advice screen.

string

List of entities to be returned in the response.

string

Type of the template being added. Supported template types are:
- AffiliatedBusinessArrangement
- ClosingCost
- Funding
- Investor
- LoanProgram
- SettlementServiceProvider
- TemplateSet
- TemplateType

string

Path of the template needed to be applied. Must use templateType param when providing the template path.

boolean

Indicate whether or not to ignore blank template values for the loan program template.

boolean

Indicator whether or not to ignore empty fields on the Closing Cost Template when being applied from Loan program template.

boolean

Indicator for ignoring empty closing cost data when applying a Closing Cost template.

boolean

Indicates if fields with empty values should be returned in the response payload since they are excluded by default.

boolean

Indicates if log records that have been removed from the loan should be returned in the response payload since they are excluded by default.

string

Optional. View type parameter. Enumerations: entity, full, id, logs. For more details, see Loan Management - About Loan Views.
When no view parameter is provided, the API will return 204 - No Content with no response body.

boolean

Indicate “true” to retrieve a preview of the loan response without saving and committing the data. Default is “false”.

- All loan calculations will run.
- No email notifications will generate.
- No new version of the loan file will be created.
- No webhooks will be triggered.
- No new snapshots will be created.
- No deferred loan processes will occur.
- No updates will occur to fields dependent on loan save (e.g. loan alerts)

Note: You can follow up with a subsequent PATCH loan call with the same request payload, and this parameter set to “false’ or not provided, to save and commit the changes to the loan.

Body Params
string

Loan contract with updated changes.

Headers
string
required

Bearer token

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 8 months ago

Language
LoadingLoading…
Response
Choose an example:
text/plain
application/json

Updated 8 months ago

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use