V1 Upload Attachment to eFolder

put

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

Retrieves the URL for uploading an attachment. This URL is time sensitive. It must be invoked as a PUT with the attachment converted to a byteStream within the request body. The attachment ID is returned in location attribute of the PUT call's response header.

Note: If you have document conversion turned on, the attachment ID is returned in the native format initially, then goes through a conversion. Once converted, the native attachment ID will no longer be valid and it will be replaced with a GUID. The new GUID will be available in the "Get List of Attachments" call.

❗️
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.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

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

Content-Type

string

required

Required. Example: application/pdf

Authorization

string

required

Bearer token

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK