eFolder Documents

About eFolder Documents

An eFolder document is an entry in the eFolder that allows Encompass users to track the status of a loan document as the loan moves through the Pipeline. An eFolder document is like a file folder, it is used to contain and track all the files associated with a particular loan document. When a user accesses a document on the eFolder, the user can also access a file that has been attached to the document. A document can have multiple files attached to it.

Working with Documents

Each document is assigned a unique identifier known as a document ID. When you specify a document in a call, you typically need to provide the document's ID (documentId). The document ID is passed to retrieve returned in the response header when the document is created. document IDs are also returned in the V3 Get List of Documents API response.

Using APIs for Loan eFolder Documents and Attachments

Encompass Developer Connect eFolder Documents and Attachments APIs enable the management of documents and attachments within the eFolder of a loan. It is recommended to leverage the V3 version of the APIs as they are backward compatible and the most current. It is important to note that there may not be an equivalent V3 API for some V1 APIs, and that some V1 APIs may not work with some attachment types.

Viewing Attachments in Encompass

Developer Connect V3 APIs work seamlessly with Encompass. Whether accessing attachments from the media server or cloud storage, the flow is the same with V3 APIs. With cloud storage, Encompass users will notice improved performance. Encompass users may notice subtle changes in appearance of attachments when rendered in the document viewer of the Encompass eFolder for new loans.

Using Both V1 and V3 APIs

The V1 and V3 versions of these APIs can be used simultaneously. Developer Connect eFolder Documents and Attachments V3 APIs are backward compatible. It is important to note that some V1 APIs used to manage attachments may no longer work depending on the attachment type. In such cases, the available V3 equivalent version of the API will be required. API calls will be automatically directed to the correct server depending on where the attachment is stored. Documents can be managed using V1 or V3 APIs, and the workflow will not break.