V1 Update Document

patch

https://api.elliemae.com/encompass/v1/loans/{loanId}/documents/{documentId}

Updates properties of a specified document.

Properties that can be updated include:


Requested from	The person or company from whom the document is requested.
Name	Name of the document.
Description	Document description.
Borrower Pair	Name of borrower pair.
Milestone	Milestone with which to associate the document. Values include: Processing, Submittal, Cond. Approval, Resubmittal, Approval, Doc Preparation, Docs Signing, Funding, Post Closing, Shipping, Completion.
Checkboxes	For Requested, Re-requested, Received, Reviewed, Ready for UW, Ready to Ship.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

documentId

string

required

The unique identifier assigned to the document.

Query Params

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

applicationId

string

required

Identifies which borrower pair (or “All”) the document will be assigned to.

milestoneId

string

Unique identifier of the milestone assigned to the document.

webCenterAllowed

boolean

Indicates whether the document is available for Encompass WebCenter. Example: TRUE

tpoAllowed

boolean

Indicates whether the document is available for Encompass TPO WebCenter. Example: TRUE

thirdPartyAllowed

boolean

Indicates whether the document is available for Third Parties. Example: TRUE

isRequested

boolean

Indicates whether the document is requested. Example: TRUE

requestedBy

string

UserId of the user that marked the document as requested. Example: string

isRerequested

boolean

Indicates whether the document is re-requested. Example: TRUE

dateRerequested

date

Re-requested Date from the Status area in Document Details window. Example: 2017-01-07T01:57:23.107Z

rerequestedBy

string

UserId of the user who marked the document as re-requested.

daysDue

int32

Number of days when a requested document is due. Example: 0

isReceived

boolean

Indicates whether the document is received. Example: TRUE

receivedBy

string

UserId of the user who marked the document as received.

daysTillExpire

int32

Number of days a received document is valid. Example: 0

isReviewed

boolean

Indicates whether the document is reviewed. Example: TRUE

reviewedBy

string

UserId of the user who marked the document as reviewed.

isReadyForUw

boolean

Indicates the document is ready for underwritingReady for UW Date from Status area in Document Details window. Example: TRUE

readyForUwBy

string

UserId of the user who marked the document as ready for underwriting.

isReadyToShip

boolean

Indicates whether the document is ready for shipping. Example: TRUE

readyToShipBy

string

UserId of the user who marked the document as ready to ship.

dateExpires

date

The date a received document will expire. Example: 2017-01-07T01:57:23.053Z

title

string

The title of the file.

description

string

Description of the document in the Encompass eFolder UI.

requestedFrom

string

Person or company the document is being requested by.

emnSignature

string

EPASS Signature that is used by thick client EMN integrations.

dateRequested

date

Date the document was requested. Example: 2017-01-07T01:57:23.085Z

dateReceived

date

Date the document was received. Example: 2017-01-07T01:57:23.085Z

dateReviewed

date

Date the document was reviewed by processor. Example: 2017-01-07T01:57:23.085Z

dateReadyForUw

date

Date the document is ready for underwriting to review. Example: 2017-01-07T01:57:23.085Z

dateReadyToShip

date

Date the document is ready for shipping to investor. Example: 2017-01-07T01:57:23.085Z

Headers

Authorization

string

required

Bearer token

Response

Language

Loading…

204204