V1 Confirm a Rate Lock Request

put

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

Use this API to confirm a rate lock request. This call releases any existing rate lock on the specified loan and locks the new rate on the loan.

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

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.
Note: True can only be provided in conjunction with action Query Parameters, where action = “confirm”, “sellComparisonUpdate”, or “revise”.

dataSyncOption

string

Determines whether the loan will be updated with lock data after a lock is confirmed. Possible values:
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.

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

string

Unique identifier of the rate lock request.

requestType

string

Lock request type. Possible values: lock, re-lock, extension, trade extension, *cancellation

requestStatus

string

Status of the rate lock before there is an action performed on the request. Possible values: not locked, active lock, cancelled lock, expired lock

lockStatus

string

Status of the lock request. Possible values: requested, locked, old lock, old request, expired, cancelled, extension requested, denied, registered, old registration

lockNumberOfDays

int32

Indicates the total number of lock days for the request.

lockExpirationDate

string

Date on which the rate lock expires.

requestedBy

object

The entityReferenceContract describing the entity or user who submitted the lock request.

requestedDate

date-time

The date and time when the lock request is created.

fulfilledDate

date-time

The date and time when lock request was fulfilled.

fulfilledBy

object

The entityReferenceContract describing the entity or user who fulfilled the lock request.

investor

object

Object containing investor information.

investorDeliveryDate

date-time

Investor's delivery date.

requestIndicators

array of strings

Flags that indicate the status of the request. Possible values:

hideLog - Indicates the lock request log needs to be hidden.
fakeRequest - Indicates the lock is created with/out a request.
lockExtension - Indicates the lock is extended.
lockCancellation - Indicates the lock is cancelled.
*reLock - Indicates that the rate lock is re-locked.

requestIndicators

parentLockRequest

object

Object containing attributes that describe the parent lock request.

investorCommitment

string

Investor's commitment.

loanInformation

object

Object containing attributes that describe loan information.

lockRequest

object

Object containing attributes that define the lock request.

buySide

object

Object containing buy side information.

sellSide

object

Object containing sell side information.

comparison

object

Object containing comparision information.

customFields

array of objects

Array of objects containing custom fields information.

customFields

isVoidable

boolean

Indicates if voidable.

isCancellable

boolean

Indicates if cancellable.

isExtendable

boolean

Indicate if extendable.

enableZeroParPricingRetail

boolean

Indicates if zero par pricing for retail lending is enabled.

enableZeroParPricingWholesale

boolean

Indicates if zero par pricing for wholesale lending is enabled.

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK