V1 Update a Rate Lock Request

patch

https://api.elliemae.com/encompass/v1/loans/{loanId}/ratelockRequests/{requestId}

Update rate lock request of a specified request ID for a loan. A rate lock request can be updated if it has not been confirmed or denied or cancelled. Updating a rate lock request will not create a new request.

Usage Notes

When providing price adjustments in the request payload for the buyside, sell side, or comparision side columns ('buySide.adjustments', 'sellSide.adjustments', or 'comparision.adjustments' objects), you should include them in the sequential order in which they occurred. Retrieve the Rate Lock Request to get the sequential order of the adjustments.
When updating a rate lock extension request, the buyside.lockExtendPriceAdjustment (field 3365) and buyside adjustments are automatically copied from the lock extension request. There is no need to include them in the request payload. However, if you do, be aware of the following:
- The buyside adjustments should ideally be provided in the sequential order in which the extension requests originally occurred. Retrieve the Rate Lock Request to get the sequential order of the adjustments.
- If the user includes buyside.LockExtendPriceAdjustment (field 3365) in the payload, it will be set to the last extension adjustment in the 'buySide.adjustments' object.
- If the user does not include buyside.LockExtendPriceAdjustment (field 3365) in the payload, the extension adjustments in the 'buySide.adjustments' object will be set in the order in which they were provided in the request payload.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

requestId

string

required

Unique identifier assigned to the request. The requestId is returned in the response as part of the location header after submitting a rate lock request.

Query Params

clearEntities

string

Comma separated list of entities in the rate lock request to be cleared out. Possible values are: buySide,sellSide

copyLoanData

boolean

If “true” the API will copy current loan data to the corresponding rate lock snapshot fields before confirming the rate lock. Default is “false”.

excludeInterestRateOnCopy

boolean

If “true” the API will exclude Interest Rate (field ID 3) and will not copy the current value to corresponding Lock Request Base Rate (field ID 2092). Default is “false”.

Body Params

lockRequest

string

required

The lock request details. Use the data provided in the sample request.

View body parameters
Supported objects include: buySide, sellSide, comparison.

Headers

Authorization

string

required

Bearer token

Responses

Usage Notes

200200

400400