Update Assigned Loans in a Correspondent Trade

put

https://api.elliemae.com/secondary/v1/trades/correspondent/{tradeId}/loans/update

Update loan based on trade data on loans already assigned to a specified Correspondent Trade (Trade Synchronization).

This API added with the 26.1 release of Encompass.

📘
The Entity Reference request body is optional if 'ForceUpdateAllLoans' is set to True.

Path Params

tradeId

string

required

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

Query Params

DataSyncOption

string

Determines whether the loan will be updated with lock data after a lock is confirmed.
Possible values are:
noSync – Does not update the loan with lock data upon lock confirmation.
syncLockToLoan – The default value. Updates the loan with the lock data upon lock confirmation.

ForceUpdateAllLoans

boolean

Indicates whether to force all loans to update. The options are:
true - When set to true, all loans assigned to the trade are processed and there is no payload in the request.
false - The default value. When set to false, the loans to be processed are specified in the request payload.

Body Params

Headers

Authorization

string

required

Bearer token.

Responses

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

200OK