V1 Get Attachment from eFolder

post

https://api.elliemae.com/encompass/v1/loans/{loanId}/attachments/{attachmentId}/url

Retrieves the URL for native attachment for a file in the eFolder. The attachment URL is the full URL where the attachment is located in the eFolder. Getting the attachment URL is the first step in retrieving an attachment from the eFolder. This API supports attachment IDs that are in the native format. E.g. Attachment-97f0f34d-7194-4e45-941f-e680dcea91c1.txt.

❗️
Scheduled for Sunset
This API endpoint is scheduled for sunset in release 26.3. See Sunsetting V1 eFolder Attachment APIs for details regarding the alternative endpoint to use.

Usage Note

If the attachment was imported as part of a larger file, the URL will be for the entire imported document. To get the attachment individually, use the Export Attachments API.

Path Params

loanId

string

required

Unique identifier assigned to the loan.

attachmentId

string

required

Unique identifier assigned to the attachment. Ex: Attachment-97f0f34d-7194-4e45-941f-e680dcea91c1.txt. Attachment ids in GUID format are not supported.

Query Params

view

string

Optional. View type parameter. Enumerations: entity, id
When no view parameter is provided, the API will return 204 - No Content with no response body.

Body Params

title

string

The name of the media attachment.

fileWithExtension

string

The attachment's file name and extension.
The following file extensions are supported: .doc, .docx, .html, .jpeg, .jpg, .pdf, .tif, and .txt.

createReason

int32

The create reason. Possible values:

1 = Browse
2 = Forms
3 = Scan
4 = Upload
5 = Fax
6 = Esign
7 = Services
10 = Printer
11 = Import

documentRefId

string

Reference to the document object.

mediaUrl

string

The location or path where the media attachment is located.

callBacklUrl

string

The location or path where the callback is located.

Headers

Authorization

string

required

Bearer token

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK