Download Postman Collection
API Reference

V1 Get Attachment Metadata

get
https://api.elliemae.com/efolder/v1/loans//files/

Retrieves the metadata found on attachments of an Encompass loan.

This API added with the 24.2 release of Encompass.

Usage Note

The fileId is also referred to as attachmentId.

❗️

Known Issue

The includeMetaData query parameter is case sensitive. This will be resolved in a future release.

Path Params
string
required

The loanId is required to fetch loan related documents.

string
required

The fileId is required to fetch file details.

Query Params
string

This query parameter flag allows for gathering additional metadata about the specified file. The additional file metadata will include the page count and the content type.
- true: Includes page count and content type in the API response.
- false: Only includes the fileId and the unique storage system ID. The page count and content type will not be included in the API response.
Note: If the query parameter is not passed, it will be treated as if the query parameter was set to false.

Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Updated 13 days ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago

Did this page help you?
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use