Export Pricing and Lock

This page covers how to lock a price quote with a scenario, retrieve the next possible lock statuses, and add lock events. These steps follow after you have priced a loan and created a quote.

Step 5: Lock with Scenario

This call places a lock or lock request on the price quote, depending on the lender company's locking policy. It passes the user's price quote in priceQuoteId, which includes the selected line result and base search from which the line result was obtained.

Endpoint: POST /rest/v1/lock/lockWithScenario

Headers:

Header	Value
secret	{{token}}
companyid	{{companyId}}

Body:

Field	Description
priceQuoteId	The ID of the price quote created in Step 4
overrideLockDate	Optional -- override the lock date with a specific timestamp
search	The search data from the pricing request

Example Request:

curl --location -g --request POST '{{protocol}}{{domain}}/rest/v1/lock/lockWithScenario/' \
--header 'secret: {{token}}' \
--header 'companyid: {{companyId}}' \
--data-raw '
{
    "priceQuoteId" : "6143d16a3907183821572ae0",
    "overrideLockDate": "2022-05-01T22:00:02.000Z",
    "search":{
    //search data
    }
}'

Step 6: Get Next Possible Status

Retrieve the available actions the user can take with their lock at any given time, based on the lender company's lock policy.

A lock is not necessary to make this call, but a price quote is. For instance, after locking a loan, some common next actions might be:

Requesting an extension
Deleting the lock
Requesting a pricing exception
Making other edits to the lock

The next possible steps are determined by the lender company's locking policy. The policy determines what a user can edit in a lock, the extension policy, and what a user can do once the lock expires.

Endpoint: GET rest/v1/lock/getNextLockStatus/{{lockId}}/{{lockEventId}}

Headers:

Header	Value
secret	{{token}}
companyid	{{companyId}}

Path Parameters:

Parameter	Description
lockId	The unique ID of the lock
lockEventId	The unique ID of the last locking event

Example Request:

curl --location -g --request GET '{{protocol}}{{domain}}/rest/v1/lock/getNextLockStatus/{{lockId}}/{{lockEventId}}' \
--header 'secret: {{token}}' \
--header 'companyid: {{companyId}}' \
--data-raw ''

Response:

Returns an array of lock status objects. Each status describes an available action, including its button name, color, supply type, and logic. Key fields include:

code / buttonName -- identifies the action (e.g., "Approve", "Cancel Lock", "Lock Extension")
loanSupplyType -- whether the action applies to "BuySide", "SellSide", or both
lockStatusLogic -- the logic category: "None", "Modified", "ModificationRequested", "Other"
requireReprice -- whether the action requires a reprice before proceeding
lockException -- price exception configuration (type, value type, request type)
lockExtender -- extension configuration (days, points, daily fee)
nextStatusIds -- IDs of statuses available after this one

Full example response (12 status objects)

[
  {
    "id": "5bec8a27671267199356e282",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-11-14T20:48:39Z",
    "modifiedBy": null,
    "modifiedDate": "2018-11-14T20:48:39Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": false,
    "autoStatusLockStatusId": null,
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Approved",
    "buttonName": "Approve",
    "description": "From loan status",
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "blue",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "None",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bec8a27671267199356e283",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-11-14T20:48:39Z",
      "modifiedBy": null,
      "modifiedDate": "2018-11-14T20:48:39Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5c0af82c46e0fb000125337b",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-12-07T22:46:04Z",
    "modifiedBy": null,
    "modifiedDate": "2018-12-07T22:46:04Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Price Exception Cancelled/Denied",
    "buttonName": "Price Exception Cancelled/Denied",
    "description": null,
    "loanSupplyType": [
      "BuySide",
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "olive",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Price",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5c0af82c46e0fb000125337c",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-12-07T22:46:04Z",
      "modifiedBy": null,
      "modifiedDate": "2018-12-07T22:46:04Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": true
  },
  {
    "id": "5bf2103430ac474cbdff63df",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-11-19T01:21:56Z",
    "modifiedBy": null,
    "modifiedDate": "2018-11-19T01:21:56Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Lock Date Override",
    "buttonName": "Lock Date Override",
    "description": "Lock Date Override",
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "green",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Modified",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": true,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Price",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bf2103430ac474cbdff63e0",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-11-19T01:21:56Z",
      "modifiedBy": null,
      "modifiedDate": "2018-11-19T01:21:56Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5bb2aa1a46e0fb00019d49d6",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-10-01T23:13:30Z",
    "modifiedBy": null,
    "modifiedDate": "2018-10-01T23:13:30Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Price Effective Date Override",
    "buttonName": "Price Effective Date Override",
    "description": "Price Effective Date Override",
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "darkblue",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": true,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bb2aa1a46e0fb00019d49d7",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-10-01T23:13:30Z",
      "modifiedBy": null,
      "modifiedDate": "2018-10-01T23:13:30Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5be3286346e0fb0001fdcc42",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-11-07T18:01:07Z",
    "modifiedBy": null,
    "modifiedDate": "2018-11-07T18:01:07Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": [],
    "productCodesExclude": [],
    "allowPriceChange": false,
    "code": "Loan Update",
    "buttonName": "Update",
    "description": null,
    "loanSupplyType": [
      "BuySide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "blue",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": true,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5be3286346e0fb0001fdcc43",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-11-07T18:01:07Z",
      "modifiedBy": null,
      "modifiedDate": "2018-11-07T18:01:07Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": true
  },
  {
    "id": "5bb3cc19fc98bb20d970f0e0",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-10-02T19:50:49Z",
    "modifiedBy": null,
    "modifiedDate": "2018-10-02T19:50:49Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a91a46e0fb00019d301e",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Cancel Lock",
    "buttonName": "cancel",
    "description": null,
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a91a46e0fb00019d301e"
    ],
    "color": "darkred",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bb3cc19fc98bb20d970f0e1",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-10-02T19:50:49Z",
      "modifiedBy": null,
      "modifiedDate": "2018-10-02T19:50:49Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5c6dbfd94cedfd0001eb5579",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2019-02-20T21:00:09Z",
    "modifiedBy": null,
    "modifiedDate": "2019-02-20T21:00:09Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Lock Extension (CM)",
    "buttonName": "Lock Extension (CM)",
    "description": null,
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "black",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Price",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5c6dbfd94cedfd0001eb557a",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2019-02-20T21:00:09Z",
      "modifiedBy": null,
      "modifiedDate": "2019-02-20T21:00:09Z",
      "enable": true,
      "type": "Response",
      "useRateProgram": true,
      "allowOverride": true,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5be24290fc98bb47c10853f6",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-11-07T01:40:32Z",
    "modifiedBy": null,
    "modifiedDate": "2018-11-07T01:40:32Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": [],
    "productCodesExclude": [],
    "allowPriceChange": false,
    "code": "Price Exception Approval",
    "buttonName": "Price Exception Approval",
    "description": null,
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "black",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Modified",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Grant",
      "enable": true,
      "priceToFee": false,
      "type": "Rate",
      "types": [
        "FEE"
      ],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5be24290fc98bb47c10853f7",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-11-07T01:40:32Z",
      "modifiedBy": null,
      "modifiedDate": "2018-11-07T01:40:32Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5bb2aabe46e0fb00019d5d54",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-10-01T23:16:14Z",
    "modifiedBy": null,
    "modifiedDate": "2018-10-01T23:16:14Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Min Day Lock Change",
    "buttonName": "Change Min Day Lock",
    "description": null,
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "red",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": true,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bb2aabe46e0fb00019d5d55",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-10-01T23:16:14Z",
      "modifiedBy": null,
      "modifiedDate": "2018-10-01T23:16:14Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5be24203fc98bb47c1084d60",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-11-07T01:38:11Z",
    "modifiedBy": null,
    "modifiedDate": "2018-11-07T01:38:11Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": false,
    "autoStatusLockStatusId": null,
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": [],
    "productCodesExclude": [],
    "allowPriceChange": false,
    "code": "Price Exception Request",
    "buttonName": "Request Price Exception",
    "description": null,
    "loanSupplyType": [
      "BuySide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5be24290fc98bb47c10853f6",
      "5c0af82c46e0fb000125337b",
      "5bb6b0eafc98bb38f2c0f60a",
      "5be3286346e0fb0001fdcc42",
      "5bb2a91a46e0fb00019d301e"
    ],
    "color": "teal",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "ModificationRequested",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": true,
      "priceToFee": false,
      "type": "Rate",
      "types": [
        "FEE"
      ],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5be24203fc98bb47c1084d61",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-11-07T01:38:11Z",
      "modifiedBy": null,
      "modifiedDate": "2018-11-07T01:38:11Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": true
  },
  {
    "id": "5bb2a9cb46e0fb00019d47b9",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-10-01T23:12:11Z",
    "modifiedBy": null,
    "modifiedDate": "2018-10-01T23:12:11Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": null,
    "productCodesExclude": null,
    "allowPriceChange": false,
    "code": "Update(CM)",
    "buttonName": "Update(CM)",
    "description": "Update(CM)",
    "loanSupplyType": [
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "teal",
    "alert": false,
    "alertActors": [
      "SellSide",
      "BuySide"
    ],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": true,
    "repriceOutOfGroup": true,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bb2a9cb46e0fb00019d47ba",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-10-01T23:12:11Z",
      "modifiedBy": null,
      "modifiedDate": "2018-10-01T23:12:11Z",
      "enable": false,
      "type": "Request",
      "useRateProgram": true,
      "allowOverride": false,
      "lockExtensions": [],
      "allowDailyFee": false,
      "dailyFeeAmount": null,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": false
  },
  {
    "id": "5bb6b0eafc98bb38f2c0f60a",
    "mergeSet": null,
    "createdBy": null,
    "creationDate": "2018-10-05T00:31:38Z",
    "modifiedBy": null,
    "modifiedDate": "2018-10-05T00:31:38Z",
    "order": 0,
    "root": false,
    "primeState": false,
    "autoStatus": true,
    "autoStatusLockStatusId": "5bb2a97046e0fb00019d3eb7",
    "allowRevert": false,
    "allowRevertTo": [],
    "productCodes": [],
    "productCodesExclude": [
      "975",
      "976",
      "977"
    ],
    "allowPriceChange": false,
    "code": "Lock Extension",
    "buttonName": "Lock Extension",
    "description": null,
    "loanSupplyType": [
      "BuySide",
      "SellSide"
    ],
    "visibleGroupIds": [],
    "alertGroupIds": [],
    "mappingLos": [],
    "nextStatusIds": [
      "5bb2a97046e0fb00019d3eb7"
    ],
    "color": "black",
    "alert": false,
    "alertActors": [],
    "lockStatusLogic": "Other",
    "allowDaylockOverride": false,
    "allowGracePeriodOverride": false,
    "requireReprice": false,
    "repriceOutOfGroup": false,
    "worseCase": false,
    "allowLockDateUpdate": false,
    "disabled": false,
    "lockException": {
      "requestType": "Request",
      "enable": false,
      "priceToFee": false,
      "type": "Rate",
      "types": [],
      "valueType": "Points",
      "lockExceptionMappedByGroup": {}
    },
    "lockExtender": {
      "id": "5bb6b0eafc98bb38f2c0f60b",
      "mergeSet": null,
      "createdBy": null,
      "creationDate": "2018-10-05T00:31:38Z",
      "modifiedBy": null,
      "modifiedDate": "2018-10-05T00:31:38Z",
      "enable": true,
      "type": "Response",
      "useRateProgram": false,
      "allowOverride": false,
      "lockExtensions": [
        {
          "id": "5bbcf3c8fc98bb15fac5ca70",
          "mergeSet": null,
          "createdBy": null,
          "creationDate": "2018-10-09T18:30:32Z",
          "modifiedBy": null,
          "modifiedDate": "2018-10-09T18:30:32Z",
          "days": 7,
          "points": 0.084
        },
        {
          "id": "5bbcf3c8fc98bb15fac5ca71",
          "mergeSet": null,
          "createdBy": null,
          "creationDate": "2018-10-09T18:30:32Z",
          "modifiedBy": null,
          "modifiedDate": "2018-10-09T18:30:32Z",
          "days": 14,
          "points": 0.168
        }
      ],
      "allowDailyFee": true,
      "dailyFeeAmount": 0.69,
      "comment": null
    },
    "worseCaseSettings": {
      "currentRateSheet": null,
      "historicalRateSheet": null,
      "worseCase": null
    },
    "buySide": true
  }
]

Step 7: Add Lock Event

Execute any of the next possible statuses from the locking policy. This call updates the existing lock with the selected action.

Endpoint: POST /rest/v1/lp-ppe-api/price-quote/addLockEvent

Headers:

Header	Value
secret	{{token}}
companyid	{{companyId}}

Body:

{
    lockId: ObjectId;
    lockStatusId: ObjectId;
    priceQuoteId: ObjectId;
    lockEventExceptionInfo: LockEventExceptionInfo;
    lockEventExtensionInfo: LockEventExtensionInfo;
    scenario: ScenarioLock;
    lockDateUpdate: Date;
    lockEventComment: String;
}

Example Request:

curl --location -g --request POST '{{protocol}}{{domain}}/rest/v1/lock/addLockEvent' \
--header 'secret: {{token}}' \
--header 'companyid: {{companyId}}' \
--data-raw '{
    "lockId": "{{lockId}}",
    "lockStatusId": "{{lockStatusId}}",
    "priceQuoteId": "{{priceQuoteId}}",
    "lockEventExceptionInfo": null,
    "lockEventExtensionInfo": null
}'

Response: Returns the lock data and any modification data.

Step 5: Lock with Scenario​

Step 6: Get Next Possible Status​

Step 7: Add Lock Event​

Step 5: Lock with Scenario

Step 6: Get Next Possible Status

Step 7: Add Lock Event