V1 Cancel Lock Request

Cancels an existing lock. Only locks that are recently requested or confirmed can be canceled.

Usage Notes

  • If ICE PPE is the product and pricing engine used for the loan and Auto Cancel Lock option is enabled in your Encompass Settings, the lock is automatically canceled.
  • If the Auto Cancel Lock option is disabled in Encompass, the lock cancel request must be submitted and canceled manually.
Path Params
string
required

The unique identifier assigned to the loan.

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
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
date-time

Date to cancel the lock. For example, "2017-06-01T19:54:07.791Z"

string

Comments for the rate lock request cancellation.

Headers
string
required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json