V3 Importer to Update Loan

post

https://api.elliemae.com/encompass/v3/loans/{loanId}/importer

Updates an existing loan with the data in the MISMO 3.4 file.

Sample Response

Click here to view the example response (PDF)

Path Params

loanId

string

required

The unique identifier assigned to the loan.

Query Params

view

string

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

preview

boolean

Defaults to false

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.

importData

string

Defaults to all

Indicates which fields are to be imported from the MISMO file.. If the value is 'populated', only the non-blank/ populated values in the file are imported. Default value is 'all'.

listsAction

string

Defaults to append

Indicates if the existing collections are to be cleared out (replace) or the new entries are to be appended to the existing collections(append). Default value is 'append'.

complianceFieldsImportOption

string

Specifies the option to import the following Correspondent Compliance fields (i.e., Mavent / MISMO 3.4):
- IncludeComplianceFields - The default value and indicates import all fields.
- ComplianceFieldsOnly - Use for importing only compliance fields.
- SkipComplianceFields - Use for skipping compliance fields while importing.

Headers

Authorization

string

required

Bearer token

Content-Type

string

Content type of the request payload. Supported value: application/vnd.elliemae.mismo34+xml

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

204No Content