V1 Update Document

patch

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

Updates properties of a specified document.

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

applicationName

string

Borrower Pair Name of the document.

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 who marked the document as requested. Example: string

isRerequested

boolean

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

dateRerequested

string

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

integer

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

integer

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

reviewedBy

string

UserId of the user who marked the document as reviewed.

isReviewed

boolean

Indicates whether the document is reviewed. Example: TRUE

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

string

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

createdBy

string

UserId of the user who created the document or comment.

createdByName

string

User Name of the user who created the comment.

dateCreated

string

Date the document or comment was added. 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.

applicationId

string

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

emnSignature

string

EPASS Signature that is used by thick client EMN integrations.

Status

string

Initially, the document status is Needed, and then transitions through the various flows based on actions taken in the eFolder. Possible values are:

Added
Cleared
Expected
Fulfilled
PastDue
Ready for UW
Ready to Ship
Received
Rejected
Requested
Rerequested
Reviewed
Waived

StatusDate

date

Date the current status was achieved. Example: 2017-01-07T01:57:23.085Z

dateRequested

date

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

dateExpected

date

Date the document is expected to be received by. 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 or role user. 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

entityId

string

Unique identifier of the entity. Example: 12345

entityType

string

The entity type for documents, is “document”. The entity type for attachments, is “attachment”. The entity type for roles, is "role".

comments

string

List of comments.

forRoleId

integer

Unique identifier of the role that this comment was assigned to. Example: 0

commentId

string

GUID. Unique identifier of the comment.

entityName

string

Name of the entity.

entityUri

string

Location of the entity. Example: /v1/documents/123/attachment/12345

Headers

Authorization

string

required

Bearer token

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…