Download Postman Collection
API Reference

V1 Manage Underwriting Conditions

patch
https://api.elliemae.com/encompass/v1/loans//conditions/underwriting

Adds to a condition set and updates or deletes underwriting conditions for a loan.

Path Params
string
required

The unique identifier assigned to a loan.

Query Params
string

Action to perform. Possible values are:
add- Adds to a condition set.
remove - Deletes the condition.
update - Updates the condition.

string

Optional. View type parameter. Enumerations: entity,id When no view parameter is provided, the API will return 204 - No Content with no response body.

Body Params
string

The milestones to describe when the condition must be satisfied. Possible values are: Approval, Docs, Funding, Closing, and Purchase.

string

The condition category. Possible values are: Assets, Credit, Income, Legal, Misc, and Property.

string

The role of the Encompass user that owns the condition. A few examples are Loan Officer, Post Closer, and Underwriter.

boolean

Whether to allow the owner to clear the condition.

boolean

Whether the document is allowed to be printed externally.

boolean

Whether the document is allowed to be printed internally.

string

Date and time that the condition expires. For example, 2017-03-24T04:14:30Z

string

Whether the condition's status is fulfilled.

string

Date and time that the condition is fulfilled. For example, 2017-03-24T04:14:30Z

fulfilledBy
object

Information about the Encompass user who fulfilled the condition.

string

Whether the condition's status is Reviewed.

string

Date and time that the condition is fulfilled. For example, 2017-03-24T04:14:30Z

reviewedBy
object

Information about the Encompass user who reviewed the condition.

boolean

Whether the condition's status is Rejected.

string

Date and time that the condition is fulfilled. For example, 2017-03-24T04:14:30Z

rejectedBy
object

Information about the Encompass user who rejected the condition.

boolean

Whether the condition's status is Cleared.

string

Date and time the condition was cleared. For example, 2017-03-24T04:14:30Z

clearedBy
object

Information about the Encompass user who cleared the condition.

boolean

Whether the condition's status is Waived.

string

Date and time the condition was waived. For example, 2017-03-24T04:14:30Z

waivedBy
object

Information about the Encompass user who waived the condition.

string

Indicates the document type associated with the TPO condition.

string

Unique identifier (GUID) of the document linked to the TPO condition.

string

Unique identifier of a condition.

string

The ID of the template used to create the condition.

string

Type of a condition. Possible values are Underwriting, Post Closing, Preliminary, and Purchase.

boolean

Whether the condition's status is Removed.

string

Title of the document.

string

Description of the document.

string

Details of the document description.

boolean

A value of true indicates the condition will be linked to all applications or only for a specified application. If linked to a specified application, the application ID must be provided.

application
object

Loan application to which to apply the condition. Required if applying condition to a specific application. If you want to apply the condition to all applications of the loan, set the forAllApplications attribute to true.

string

Source of the condition. Possible values are: Escrow, Investor, Recorder’s Office, Borrowers, FHA, VA, MI Company, Other, Manual, Condition Set, and Automated Conditions.
NOTE: These values are a combination of all supported values in the request and response files.

string

Date and time the condition is waiting to be received by. For example, 2017-03-24T04:14:30Z

string

Indicates the status of the condition. Possible values are Added, Expected, Requested, Received, Rerequested, Fulfilled, Reviewed, Sent, Cleared, Waived, Expired, and Rejected.

string

Date and time the condition's status was last changed. For example, 2017-03-24T04:14:30Z

integer

Number of days for the condition to be received.

string

User who requested the condition.

string

Date and time the condition was created. For example, 2017-03-24T04:14:30Z

createdBy
object

Information about the Encompass user who created the condition.

boolean

Whether the condition's status is Requested.

string

Date and time the condition was requested. For example, 2017-03-24T04:14:30Z.

requestedBy
object

Information about the Encompass user who requested the condition.

boolean

Whether the condition's status is Re-requested.

string

Date and time the condition was rerequested. For example, 2017-03-24T04:14:30Z.

rerequestedBy
object

Information about the Encompass user who re-requested the condition.

boolean

Whether the condition's status is Received.

string

Date and time the condition was received. For example, 2017-03-24T04:14:30Z

receivedBy
object

Information about the Encompass user who received the condition.

boolean

Whether the condition belongs to a condition set.

string

Any comments for the condition.

string

Any supporting documents.

Headers
string
required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Updated 18 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 18 days ago

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