Lock Action API

Prior to implementing an iFrame integration, the LOS must develop the following methods to allow Lender Price to retrieve a complete list of all lock events that have been saved on the LOS, if any.

Get All Lock Request Events

Lender Price will call method to retrieve all lock events, if any, that have been saved on the LOS for a loan specified by its loan ID.

Method: GET

Relative Path: /lock-events/{loanId}?context=string

Path Parameters:

Parameter	Description
loanId	Unique LOS loan ID of the loan for which information is being requested. This value is passed in by the requesting loan officer in the ext_user_id field during Authentication. For additional information, refer to LOS Authentication.

Sample Response Payload:

{
    requestedDate: string; // yyyy-MM-dd'T'HH:mm:ssZ
    requestType:
        'NotAssigned'
        | 'Requested'
        | 'Locked'
        | 'Cancelled'
        | 'Renegotiation'
        | 'Denied'
        | 'Snapshot';
    lockStatus: 'NotAssigned'
        | 'Requested'
        | 'Locked'
        | 'Cancelled'
        | 'Renegotiation'
        | 'Denied'
        | 'Snapshot';
    lockExpirationDate: string; // yyyy-MM-dd'T'HH:mm:ssZ
}[];

Get the Most Recent Lock Request Event

Lender Price will call this method to retrieve the most recent lock event that has been saved on the LOS for a loan specified by its loan ID.

Method: GET

Relative Path: /last-lock-event/{loanId}?context=string

Path Parameters:

Parameter	Description
loanId	Unique LOS loan ID of the loan for which information is being requested. This value is passed in by the requesting loan officer in the ext_user_id field during Authentication. For additional information, refer to LOS Authentication.

Sample Response Payload:

{
    requestedDate: string; // yyyy-MM-dd'T'HH:mm:ssZ
    requestType:
        'NotAssigned'
        | 'Requested'
        | 'Locked'
        | 'Cancelled'
        | 'Renegotiation'
        | 'Denied'
        | 'Snapshot';
    lockStatus: 'NotAssigned'
        | 'Requested'
        | 'Locked'
        | 'Cancelled'
        | 'Renegotiation'
        | 'Denied'
        | 'Snapshot';
    lockExpirationDate: string; // yyyy-MM-dd'T'HH:mm:ssZ
};

Submit Loan Data

Lender Price will call this method to submit a lock action that has been initiated in the Lender Price UI to the LOS client.

Method: POST

Relative Path: /loan/push

Path Parameters: There are no path parameters associated with this method.

Sample Request Payload:

{
    id: string;
    type:
        'Pricing' | 'SellSide' | 'BuySide' | 'LockRequest' |
        'LockConfirm' | 'LockCancel' | 'LockDeny' |
        'PatchRequestSellSide'   // Not currently in use
        | 'PatchRequestBuySide'; // Not currently in use
    userId: string;
    context:string;
    search: Search;           // *
    lineResult: LineResult;   // *
    lock: Lock;               // *
    lastLockEvent: LockEvent; // *
}

Parse lineResult Data

Loan-related data to be included in the lineResult container are stored in the following Lender Price fields:

Data	Field	Example
Entire "lineResult"	resultMap[x].resultRate.data
Monthly payment	lineResult.monthlyPayment
Mortgage insurance	lineResult.miPriceDetail
Total points	lineResult.adjustedPoints
Final Rate	lineResult.adjustedRates
List of all adjustments	lineResult.groupAdjustmentProperties / lineResult.groupRateAdjustmentProperties
List of closing costs	lineResult.borrowerPaidDetails
Disqualify or not?	lineResult.disqualified
Lender/Owner of rate/Investor	lineResult.ratePeriod.company.name
Program name	lineResult.rateProgram.name	"programName": "DU 10/6 ARM"

Other Common Lender Price Fields

lineResult Fields	Search Fields	Lock Fields
lineResult.adjustedRates	search.criteria.appraisedValue	lock.lockedDate
lineResult.armIndexRate	search.criteria.calculatedFeeByMortgageType	lock.computedExpirationDate
lineResult.armCaps	search.criteria.cashoutAmount	lastLockEvent.lockEventExtensionInfo.dayExtension
lineResult.armFloorRateType	search.criteria.compensationType	lastLockEvent.comment
lineResult.dayLock	search.criteria.docType	lock.lockStatusPolicy.lockStatusPolicClosingSchedule.lockedTimeZone
lineResult.govtFeeDetail.usdaFeePercent	search.criteria.escrowWaiver
lineResult.mortgageType	search.criteria.fico
lineResult.qualifyingRatePercent	search.criteria.firstTimeHomeBuyer
lineResult.rateGrid.armCaps	search.criteria.fundingFeeFinanced
lineResult.rateGrid.armFloorRateType	search.criteria.guranteeFeeFinanced
lineResult.rateGrid.displayName	search.criteria.purchasePrice
lineResult.rateGrid.id	search.criteria.propertyUse
lineResult.rateGrid.interestOnlyMonth	search.criteria.ufmipFinanced
lineResult.rateGrid.loanType	search.criteria.veteranType
lineResult.rateGrid.productCode	search.property.address.city
lineResult.rateGrid.varaiableLoanTypes	search.property.address.countyName
	search.property.address.state
	search.property.address.street
	search.property.address.zip
	search.property.numberOfUnit
	search.property.propertyType