eFolder Documents and Attachments
Best Practices
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/exportjobsor {{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/exportjobsor {{API_SERVER}}/encompass/v3/loans/{{LoanGuid}}/achmentDownloadUrl |
Updated about 1 month ago
© ICE Mortgage Technology, Inc. All rights reserved.