V1 Manage Preliminary Conditions

patch

https://api.elliemae.com/encompass/v1/loans/{loanId}/conditions/preliminary

Use this API to add to a condition set and to update or delete preliminary conditions for a loan.

Path Params

loanId

string

required

The unique identifier assigned to a loan.

Query Params

action

string

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

view

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

uwAccess

boolean

A value of true indicates that underwriting has access to this condition.

priorTo

string

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

category

string

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

isFulfilled

boolean

Whether the condition's status is fulfilled.

fulfilledDate

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

Unique identifier of an underwriting condition.

templateId

string

The ID of the template used to create the condition.

conditionType

string

Required. Type of a condition. Possible values are underwriting, postclosing, preliminary, and purchase.

isRemoved

boolean

Whether the condition's status is Removed.

title

string

Required. Title of the document.

description

string

Description of the document.

descriptionDetails

string

Details of the document description.

forAllApplications

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

Required. 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.

source

string

Required. Source of the condition. Possible values are: Escrow, Investor, Recorder’s Office, Borrowers, FHA, VA, MI Company, Other, Manual, Condition Set, and Automated Conditions.

expectedDate

string

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

status

string

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

statusDate

string

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

daysToReceive

integer

Number of days for the condition to be received.

requestedFrom

string

User who requested the condition.

createdDate

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.

isRequested

boolean

Whether the condition's status is Requested.

requestedDate

string

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

requestedBy

object

Information about the Encompass user who requested the condition.

isRerequested

boolean

Whether the condition's status is Re-requested.

rerequestedDate

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.

isReceived

boolean

Whether the condition's status is Received.

receivedDate

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.

isAddedToConditionSet

boolean

Whether the condition belongs to a condition set.

comments

array of objects

Any comments for the condition.

comments

documents

array of objects

Any supporting documents.

documents

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK

201Created