Deny Lock

Pricing engine integrations can deny a rate lock request that does not meet the required criteria by using the DENY action supported by the custom transaction result operations. The DENY action requires a comments attribute, where the integration provides the reason for the denial.

📘

Deny Lock Action Details

The DENY action accepts an optional lockId.

• When the integration does not pass a lockId, EPC treats the request as a request to deny a lock in the requested state only. EPC looks for an active lock in the requested state and denies it. This prevents the integration from inadvertently denying a confirmed lock.
• When the integration explicitly passes a lockId, EPC does not check whether the lock is in the requested or confirmed state, and passes the request through to the Encompass APIs. Exercise additional caution when using this option.

The JSON schema below details the supported attributes for the DENY operation:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "description": "JSON representation of a deny lock request transaction result.",
  "validationMessage": {
    "uuidPattern": "UUID. It must be a valid UUID format"
  },
  "properties": {
    "lockId": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "validationMessage": {
        "$ref": "#/validationMessage/uuidPattern"
      }
    },
    "comments": {
      "type": "string"
    }
  },
  "required": [
    "comments"
  ],
  "additionalProperties": false
}

Below is a sample payload for the deny lock request operation:

{
  "status": "completed",
  "result": {
    "format": "application/vnd.productpricing-denylock-1.0.0.json",
    "action": "DENY",
    "details": {
      "lockId": "84dc19a5-24be-485a-831e-2420b92608e2",
      "comments": "Lock request denied: loan does not meet program eligibility criteria"
    }
  }
}

If you need help implementing the custom result operations detailed above in your integration, you can post your questions and look for answers on our Discussion board. Our discussion board is actively tracked by a community of experts who are available to help you when you get stuck. You can also send your questions and issues to the EPC core development team at [email protected].