Download Postman Collection
API Reference

V3 Manage Documents

patch
https://api.elliemae.com/encompass/v3/loans//documents

Use this API to add a document, update an existing document, or remove a document from a loan file.

Properties that can be updated include:

Requested fromThe person or company from whom the document is requested.
NameName of the document.
DescriptionDocument description.
Borrower PairName of borrower pair.
MilestoneMilestone with which to associate the document. Values include: Processing, Submittal, Cond. Approval, Resubmittal, Approval, Doc Preparation, Docs Signing, Funding, Post Closing, Shipping, Completion.
CheckboxesFor Requested, Re-requested, Received, Reviewed, Ready for UW, Ready to Ship.
Path Params
string
required

The unique identifier assigned to the loan.

Query Params
string
required

Possible actions are: add, update or remove. The default is update.

string

The unique identifier of the loan lock. This can be specified if the user has an existing lock on the loan.

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
json

When adding or updating a document, provide the DocumentContract attributes. Use the data provided in the DocumentContract Attributes table.

Headers
string
required

Bearer token

Response

Updated about 2 months ago

Language
Response 
 Choose an example:
application/json
Updated about 2 months ago 











































© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use