|
Parameter
|
Data
Type
|
Description
|
GET
|
POST
|
PATCH
|
|
documentId
|
Guid
|
The unique identifier assigned to the document.
|
|
|
|
|
titleWithIndex
|
string
|
Name of the document with an integer based on the existence
of duplicates in the eFolder (that the user has
access to).
Example: “Credit Report”, “Credit Report (2)”, etc.
|
|
|
|
|
applicationName
|
string
|
Borrower Pair Name of this document.
|
|
|
|
|
milestoneId
|
string
|
Unique identifier of the milestone assigned to the document.
|
|
|
|
|
webCenterAllowed
|
bool
|
Indicates whether the document is available for Encompass WebCenter.
Example: TRUE
|
|
|
|
|
tpoAllowed
|
bool
|
Indicates whether the document is available for Encompass
TPO WebCenter.
Example: TRUE
|
|
|
|
|
thirdPartyAllowed
|
bool
|
Indicates whether the document is available for Third
Parties.
Example: TRUE
|
|
|
|
|
isRequested
|
bool
|
Indicates whether the document is requested.
Example: TRUE
|
|
|
|
|
requestedBy
|
string
|
UserId of
the user that marked the document as requested.
Example: string
|
|
|
|
|
isRerequested
|
bool
|
Indicates whether the document is re-requested.
Example: TRUE
|
|
|
|
|
dateRerequested
|
DateTime
|
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
|
int
|
Number of days when a requested document is due.
Example: 0
|
|
|
|
|
isReceived
|
bool
|
Indicates whether the document is received.
Example: TRUE
|
|
|
|
|
receivedBy
|
string
|
UserId of
the user who marked the document as received.
|
|
|
|
|
daysTillExpire
|
int
|
Number of days a received document is valid.
Example: 0
|
|
|
|
|
isReviewed
|
bool
|
Indicates whether the document is reviewed.
Example: TRUE
|
|
|
|
|
reviewedBy
|
string
|
UserId of
the user who marked the document as reviewed.
|
|
|
|
|
isReadyForUw
|
bool
|
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
|
bool
|
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
|
DateTime
|
The date a received document will expire.
Example: 2017-01-07T01:57:23.053Z
|
|
|
|
|
createdBy
|
string
|
UserId of
the user who created the document.
|
|
|
|
|
dateCreated
|
DateTime
|
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
|
0 – Added
1 – Fulfilled
2 – Requested
3 – Rerequested
4 – Expected
5 – PastDue
6 – Received
7 – Reviewed
9 – Rejected
10 – Cleared
11 – Waived
|
|
|
|
|
StatusDate
|
DateTime
|
Date the current status was achieved.
Example: 2017-01-07T01:57:23.085Z
|
|
|
|
|
dateRequested
|
DateTime
|
Date the document was requested.
Example:
2017-01-07T01:57:23.085Z
|
|
|
|
|
dateExpected
|
DateTime
|
Date the document is expected to be received by.
Example: 2017-01-07T01:57:23.085Z
|
|
|
|
|
dateReceived
|
DateTime
|
Date the document was received.
Example: 2017-01-07T01:57:23.085Z
|
|
|
|
|
dateReviewed
|
DateTime
|
Date the document was reviewed by processor.
Example: 2017-01-07T01:57:23.085Z
|
|
|
|
|
dateReadyForUw
|
DateTime
|
Date the document is ready for underwriting to review.
Example: 2017-01-07T01:57:23.085Z
|
|
|
|
|
dateReadyToShip
|
DateTime
|
Date the document is ready for shipping to investor.
Example: 2017-01-07T01:57:23.085Z
|
|
|
|