Manage Loan Trade Documents

Add or remove documents for a specified Loan Trade.

This API added with the 26.1 release of Encompass.

📘

Currently only available for Loan Trade, not Correspondent Trade.

Path Params
string
required

Unique identifier of a correspondent trade. The TradeID and ID are the same.

Query Params
string

Specifies the action for Trade Documents. Possible values: Add, Remove. The default is Add.

string

Optional. View type parameter. Enumerations: entity, id

Body Params
createdBy
object

Details of the Created By user provided in the EntityReferenceContract.

date-time

The Created Date.

string
required

The Trade Document Type. Enum: CommitmentLetter

string
required

The field ID.

string

The file name.

string

The unique identifier for the trade document.

string

The source file ID.

string

The source name.

string
required

The upload date.

Headers
string
required

Bearer token.

Responses

201

Added/Removed

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json