eFolder Documents and Attachments

This page contains helpful tips and tricks our developers have found when managing eFolder documents and attachments using APIs.

"How To" Best Practices

To...	Do this...
Upload an attachment to the eFolder	Use the V3 Create Attachment URL API as it is the only API that supports our cloud-hosted customers. `{{API_SERVER}}/encompass/v3/loans/loanId/attachmentUploadUrl`
Search and obtain the IDs for attachments to download	Use the V3 Get Download Attachment URL API to search and obtain the attachment IDs to ensure both cloud storage and legacy storage attachments are retrieved. `{{API_SERVER}}/encompass/v3/loans/{{LoanGuid}}/attachmentDownloadUrl`
Download image files from a multi-paged attachment	Each page in a multi-paged attachment can be converted into an image file in the eFolder. To download all image files in the attachment, use the Export Attachments API. `{{API_SERVER}}/efolder/v1/exportjobs`
Download the package in its original format and retain eSign metadata or scrape OCR data	When you need to download an attachment in its original version to retain eSign metadata or to scrape OCR data, you must use the V3 Get Download Attachment URL API. `{{API_SERVER}}/encompass/v3/loans/{{LoanGuid}}/attachmentDownloadUrl`
Download attachments from cloud storage	When you need to download attachments from cloud storage, you can use either the Export Attachments API or the V3 Get Download Attachment URL API. `{{API_SERVER}}/efolder/v1/exportjobs` or `{{API_SERVER}}/encompass/v3/loans/{{LoanGuid}}/achmentDownloadUrl`
Retrieve metadata around the attachments you are downloading, such as the document they are assigned to, the attachment title, attachment date, etc.	Use the V3 Get Download Attachment URL API. `{{API_SERVER}}/encompass/v3/loans/{{LoanGuid}}/attachmentDownloadUrl`
Download attachments from an Instance that is Sky Drive enabled	Use either the Export Attachments API or the V3 Get Download Attachment URL API. `{{API_SERVER}}/efolder/v1/exportjobs` or `{{API_SERVER}}/encompass/v3/loans/{{LoanGuid}}/achmentDownloadUrl`

General Best Practices

Configuring Document Conversions

For lenders who have Encompass Document Conversion turned on, when attachments are uploaded via Encompass Developer Connect, there is an additional configuration that must be set by ICE Mortgage Technology Production Support on behalf of lenders for the document conversion to trigger. This configuration setting IS NOT exposed to lender administrators to manage themselves. Lenders must make the following or similar request to ICE Mortgage Technology Production Support:

“I have a vendor that is leveraging the Developer Connect APIs and is uploading attachments to the eFolder. I would like for the Server Side Conversion to be turned on for the following Encompass instances so that the attachments are automatically converted when my users navigate to the eFolder for the respective loans.”

BE..., TEBE..., etc.

If this configuration is not set, then the attachment will be imported unconverted. When a lender user navigates to the attachment in the eFolder via SmartClient, the document conversion process will be triggered at that time. So getting this configuration set server side saves the lender time and provides a better user experience.