Download Postman Collection
API Reference

Loan

Loan Resource Events

Loan resource events supported by the Webhook API include the following:

📘

Webhook Support for Loan Resource Events

The Support column in the table below indicates if the webhook event is triggered when a loan is updated via API (including Web version of Encompass), Desktop version of Encompass (aka Smart Client) or both.

However, if the Support column indicates "API" only, depending on your setup of Encompass, Smart Client updates may also trigger loan resource webhook events if one of the following conditions are true:

  • If your Encompass instance is enabled for Task Based Workflow and includes loan related rules.
  • If your Encompass instance is enabled for DDA (formerly AIQ).
EventDescriptionSupport
createWhen a new loan is started through Encompass.API
updateWhen an update is made to a loan file.Smart Client, API
submitWhen a loan is submitted through Consumer Connect.

Note: This event is triggered only when the Submit button is clicked on the Consumer Connect site.		Encompass Consumer Connect
moveWhen a loan is moved from one folder to another in Encompass. Move event can also indicate a “soft delete” if the loan is moved to trash folder.Smart Client, API
documentThe following subevents for the Loan Document resource are supported:

-createDocuments - When a loan document is created.
updateDocuments - When a loan document is updated.
-assignAttachmentsToDocument - When an attachment is assigned to a loan document.		API
attachmentSupports the subevent:

-attachmentCreated - When an attachment is created.		API
conditionWhen loan Enhanced Conditions are created.

Subevents:
- create
- update
- assign
- assignDocument
- remove
- comment
- status change		API
reportingdbupdateInternal Use OnlyN/A
milestoneThe following subevents for the Loan Milestone resource are supported:

updateMilestones - When a milestone is updated.
finishMilestones - When a milestone is completed.		API
milestoneupdateInternal Use OnlyN/A
changeWhen specified attributes in a loan file are updated.Smart Client, API
fieldchangeWhen a change occurs on a specified field.

When subscribing to the fieldchange webhook event, the subscriber can specify any field in the loan file to listen to using the filters.atributes. The subject field does not need to be added to the Audit Trail Database. When the webhook fires, the notification payload will include the subject field plus any other field in the loan file that has been updated as a result of the subject field change.		API
enhancedfieldchangeWhen a change occurs on a loan.

- Payload includes the previous value of the field, prior to the Field Change Event. Payload includes the new value of the field, after the Field Change Event.

- Field does not have to be added to Audit Trail Database. If subscribed to this event, webhooks will occur on all loan field change events.

Before subscribing to enhancedfieldchange event, see the Features and Usage Notes in the EFC Webhook User and Setup Guide for important information.		API
deleteWhen a loan is permanently deleted from Encompass.Smart Client, API
lockWhen a loan is exclusively locked.

Before subscribing to Lock events, see Subscribing to Loan Lock and Unlock Eventsfor important information.		Smart Client, API
unlockWhen a loan is exclusively unlocked.

Before subscribing to Lock events, see Subscribing to Loan Lock and Unlock Events for important information.		Smart Client, API
alertchangeNotifies lenders when Encompass Loan Alert is open (active), or cleared. Only Compliance Alert Types are available for Webhooks. The Alert must be enabled in Encompass Settings.

Before subscribing to alertChanges event, see Encompass Loan Alert Webhooks: How to Enable the Feature for important information.		Smart Client, API

Limited Availability

Notification Message

When a subscription is registered, the client application issues a POST notification to the callback URL (endpoint) you defined in the webhook. The notification is sent as JSON in the POST request body.

Every webhook event includes a default set of common attributes (e.g. eventId, eventTime, eventType, and meta object). In addition, webhook events that support extra payload will include additional data attributes. The samples below provide an example for standard webhook events, and for webhook events that include extra payload. 

{
  "eventId": "243e4b32-5032-4376-bd6a-a8207c068387",
  "eventTime": "2016-12-01T21:38:39.2696988Z",
  "eventType": "Create",
  "meta": {
    "userId": "jsmith",
    "resourceType": "Loan",
    "resourceId": "10d191c3-c97b-48a8-82d9-88c337ae9fd8",
    "instanceId" : "be********",
    "resourceRef": "/encompass/v1/loans/10d191c3-c97b-48a8-82d9-88c337ae9fd8"
  }
}

{
  "eventId": "db445b93-9ba8-42c4-956b-ee3095940b7b",
  "eventTime": "2024-11-19T22:04:00.303Z",
  "eventType": "alertchange",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "5232a41f-0dc7-43d8-93da-ebeaac99e1d6",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v1/loans/5232a41f-0dc7-43d8-93da-ebeaac99e1d6/alerts",
    "payload": {
      "event": {
        "alertChanges": [
          {
            "alertTypeId": "Regulation:Ability-To-RepayLoanTypeNotDetermined",
            "name": "Ability-To-Repay Loan Type Not Determined",
            "type": "Regulation",
            "status": "Open",
            "alertDate": "2024-11-19T08:00:00Z",
            "displayDate": "2024-11-19T08:00:00Z",
            "message": "Ability-to-Repay standards have not been documented. Verify that loan is exempt, a qualified mortgage or being made subject to general ability-to-repay standards.",
            "associations": []
          }
        ]
      }
    }
  }
}

{
  "eventId": "9a2296dc-5888-4e51-847f-0076c1bad9e2",
  "eventTime": "2024-11-20T04:42:28.227Z",
  "eventType": "attachment",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "80bd70ee-fda0-4dbd-a7e8-f84b9be026ab",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/loans/80bd70ee-fda0-4dbd-a7e8-f84b9be026ab/attachments",
    "payload": {
      "event": {
        "attachmentCreated": [
          {
            "id": "EBSP23444.pdf",
            "title": "First Attachment"
          }
        ]
      }
    }
  }
}

{
  "eventId": "8f780b2b-09a8-4f44-ab60-981d31f6b5e2",
  "eventTime": "2024-11-18T19:41:19.475Z",
  "eventType": "condition",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "a07c3604-555d-4553-9de7-5b3e87b6bce0",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/loans/a07c3604-555d-4553-9de7-5b3e87b6bce0/condition",
    "payload": {
      "event": {
        "updateStatusTrackingInConditions": [
          {
            "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
            "title": "E00BSAUTO_Income - Personal Tax Returns1",
            "type": "ggudfff4dsf",
            "status": [
              "Requested"
            ]
          }
        ],
        "documentStatusUpdates": [
          {
            "documents": [
              {
                "id": "e0a626af-ca87-4678-8f98-7360de856b08",
                "title": "ETR Test Document 1"
              }
            ],
            "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
            "title": "E00BSAUTO_Income - Personal Tax Returns1",
            "type": "ggudfff4dsf"
          }
        ],
        "addCommentsToConditions": [
          {
            "comments": [
              {
                "commentId": "e68df8c4-47be-4382-8833-44c373bc3506",
                "isExternal": false
              },
              {
                "commentId": "f9dd902a-8b3f-4c67-abe6-09f218ec54af",
                "isExternal": false
              }
            ],
            "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
            "title": "E00BSAUTO_Income - Personal Tax Returns1",
            "type": "ggudfff4dsf"
          }
        ],
        "createConditions": [
          {
            "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
            "title": "E00BSAUTO_Income - Personal Tax Returns1",
            "type": "ggudfff4dsf"
          }
        ],
        "assignDocumentsToConditions": [
          {
            "documents": [
              {
                "id": "e0a626af-ca87-4678-8f98-7360de856b08",
                "title": "ETR Test Document 1"
              }
            ],
            "id": "bcc324eb-8b08-4515-82a1-2fcebe35dc15",
            "title": "E00BSAUTO_Income - Personal Tax Returns1",
            "type": "ggudfff4dsf"
          }
        ]
      }
    }
  }
}

{
    "eventId": "72f280e3-533b-4198-9593-ebd34e459934",
    "eventTime": "2024-11-20T04:44:08.896Z",
    "eventType": "document",
    "meta": {
        "userId": "admin",
        "resourceType": "Loan",
        "resourceId": "80bd70ee-fda0-4dbd-a7e8-f84b9be026ab",
        "instanceId": "be11105680j",
        "resourceRef": "/encompass/v3/loans/80bd70ee-fda0-4dbd-a7e8-f84b9be026ab/document",
        "payload": {
            "event": {
                "assignAttachmentsToDocument": [
                    {
                        "id": "56999564-e263-42d6-b70a-c20641da85ec",
                        "title": "ETR Test Document",
                        "attachmentIds": [
                            "EBSP23444.pdf"
                        ]
                    }
                ],
                "documentStatusUpdates": [
                    {
                        "id": "56999564-e263-42d6-b70a-c20641da85ec",
                        "selectedStatuses": [
                            {
                                "status": "received",
                                "lastModifiedAt": "2024-11-20T04:44:07Z",
                                "lastUpdateBy": "admin",
                                "currentStatus": true
                            }
                        ],
                        "attachmentIds": [
                            "EBSP23444.pdf"
                        ]
                    }
                ],
                "updateDocuments": [
                    {
                        "id": "56999564-e263-42d6-b70a-c20641da85ec",
                        "title": "ETR Test Document"
                    }
                ]
            }
        }
    }
}

  "eventId": "793b8252-b698-4bb4-b49c-d9639e677b1c",
  "eventTime": "2023-08-22T16:26:53.344Z",
  "eventType": "enhancedfieldchange",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "0ee8ca6a-6460-4bd5-a64d-7bfb0727779e",
    "instanceId": "be11176281",
    "resourceRef": "/encompass/v3/loans/0ee8ca6a-6460-4bd5-a64d-7bfb0727779e/enhancedFieldChange",
    "payload": {
      "event": {
        "fieldChangeEvents": [
          {
            "modifiedField": "LOANFILESEQUENCENUMBER",
            "parentFieldId": "LOANFILESEQUENCENUMBER",
            "encompass": {
              "previousValue": "3",
              "newValue": "4"
            },
            "v3LoanModel": {
              "previousValue": "3",
              "newValue": "4"
            }
          },
          {
            "modifiedField": "36#2",
            "parentFieldId": "36",
            "encompass": {
              "previousValue": "",
              "newValue": "Borrower_First_Name Edith MiddleCE_2015_paidtoBlank"
            },
            "v3LoanModel": {
              "newValue": "Borrower_First_Name Edith MiddleCE_2015_paidtoBlank"
            }
          },
          {
            "modifiedField": "37#2",
            "parentFieldId": "37",
            "encompass": {
              "previousValue": "",
              "newValue": "Sample"
            },
            "v3LoanModel": {
              "newValue": "Sample"
            }
          },
          {
            "modifiedField": "1868#2",
            "parentFieldId": "1868",
            "encompass": {
              "previousValue": "",
              "newValue": "Borrower_First_Name Edith MiddleCE_2015_paidtoBlank Sample"
            },
            "v3LoanModel": {
              "newValue": "Borrower_First_Name Edith MiddleCE_2015_paidtoBlank Sample"
            }
          },
          {
            "modifiedField": "65#2",
            "parentFieldId": "65",
            "encompass": {
              "previousValue": "",
              "newValue": "123-45-6789"
            },
            "v3LoanModel": {
              "newValue": "123-45-6789"
            }
          },
          {
            "modifiedField": "39#2",
            "parentFieldId": "39",
            "encompass": {
              "previousValue": "",
              "newValue": "16"
            },
            "v3LoanModel": {
              "newValue": "16"
            }
          },
          {
            "modifiedField": "52#2",
            "parentFieldId": "52",
            "encompass": {
              "previousValue": "",
              "newValue": "Married"
            },
            "v3LoanModel": {
              "newValue": "Married"
            }
          }
        ]
      }
    }
  }
}

{
  "eventId":"3c8e2d53-0ab9-40c0-88a6-74d521dde5de",
  "eventTime":"2020-02-11T19:42:23.262Z",
  "eventType":"milestone",
  "meta":
  {
    "userId":"admin",
      "resourceType":"Loan",
      "resourceId":"af43e4cd-cf58-4a7f-ba8a-5bea2496ec2d",
      "instanceId":"bexxxxxxxx",
      "resourceRef":"/encompass/v3/loans/af43e4cd-cf58-4a7f-ba8a-5bea2496ec2d",
      "payload":
      {
        "correlationId":"8e4bfd03-5af6-400b-9c77-0a0fe48396b4",
        "event":
        {
          "updateMilestones":
          [
            {
              "id":"dc66f3ae-4ee3-4150-b3eb-69683bb48ad9",
              "title":"Started"
            }
          ]
        }
      }
  }
}


{
  "eventId": "0d96e67a-c8c0-4a2b-8771-c5dc5ac04540",
  "eventTime": "2024-11-20T05:03:14.711Z",
  "eventType": "milestone",
  "meta": {
    "userId": "admin",
    "resourceType": "Loan",
    "resourceId": "e19cb193-5b36-415b-964e-4b4e80e7a769",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/loans/e19cb193-5b36-415b-964e-4b4e80e7a769/milestone",
    "payload": {
      "event": {
        "updateMilestones": [
          {
            "id": "5769d610-4f1e-4cd2-94f2-facceff7286c",
            "title": "Qualification"
          }
        ]
      }
    }
  }
}

Subscribing to Loan Lock and Unlock Events

Encompass Developer Connect supports webhook subscriptions for exclusive lock and unlock events against the Loan resource. Subscribing to exclusive lock and unlock events, enables integrated lenders and partners to receive notifications when loans are exclusively locked and unlocked in the platform and respond accordingly.

❗️

Important

As with all webhook events, webhook notifications are not guaranteed to be in real-time. There will be a delay for a webhook notification to be sent after a triggering loan lock/unlock event occurs. Due to this, there is the potential for an intervening lock event between the emission of the notification and your application's attempt to gain a new lock on the file. Implementation of the loan lock/unlock events subscription will not eliminate the need to handle retries, but it can assist in limiting the amount of polling that your applications have to do in order to access loan files after a user releases a lock.

Back to Webhooks Overview

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use