HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Application Events

Event Summary

At the core of Blend's current event system are those events directly related to the state of the application itself -- for any solution type -- as well as related audit events.

Generally, our application events describe changes that are driven by users (e.g. a party submits an application for a mortgage loan or an API user exports the completed application package for a party).

Updated

Submitted

Firing Condition

This event fires when an application for a solution is submitted.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - the type of application the party is associated with (e.g., HELOC, MORTGAGE, etc.).
Solution Sub TypeNotes
MORTGAGE
HELOC
HELOAN
ACCOUNT_APPLICATION

Notes

At this time, only consumer mortgage and consumer banking applications trigger events. Note that a links object may be included if the particular solution exposes an API route (e.g. mortgage).

The valid solution types are:

SolutionNotes
CONSUMER_MORTGAGE
CONSUMER_BANKING

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "SUBMITTED",
      "triggeredAt": "2018-06-14T15:08:18.356Z"
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Export

Firing Condition

This event fires when an application has been exported manually through the UI.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

For more information about the specific generation of this event for your Blend instance and integration, consult with your Implementation Engineer or Account Manager.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "EXPORT",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Exported

Firing Condition

This event fires for some solutions when a specific export status is set via the API.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

For more information about the specific generation of this event for your Blend instance and integration, consult with your Implementation Engineer or Account Manager.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "EXPORTED",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Archived

Firing Condition

This event fires when an application has been transitioned to the archived state.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

An application may be archived via UI or API. It is important to note that an application may, under some circumstances, be manually unarchived by a Blend support team member, meaning it may be re-archived at a later date and that these events may not be unique by application UUID. For more information about the archive and unarchive schedule and process, consult your Implementation Engineer or Account Manager.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      },
      "archivedAt": {
        "value": "2018-06-14T15:08:18.326Z
      }
    }
  }
}

Unarchived

Firing Condition

This event fires when an application has been transitioned from archived to unarchived state.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

An application may be unarchived via UI or API. For more information about the archive and unarchive schedule and process, consult your Implementation Engineer or Account Manager.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      },
      "unarchivedAt": {
        "value": "2018-06-14T15:08:18.326Z
      }
    }
  }
}

TRID Triggered

Firing Condition

This event fires when the six pieces of required TRID information are committed to the Blend data model against a particular application. The six pieces of information that are required to trigger this event are:

  1. A party's name.
  2. A party's income.
  3. A party's social security number / tax identification number.
  4. The property address.
  5. The estimated value of the property at the address given in (4).
  6. The mortgage loan amount requested.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

TRID may be triggered in a variety of fashions depending on the configuration of your Blend instance; consult with your Implementation Engineer or Account Manager for more information.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "TRID_TRIGGERED",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
      "metadata": {
        "triggeredByType": "BORROWER",
        "triggeredById": "ae70f94b-164c-4fa0-a66c-6cb41b9b4137"
      }
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Intent to Proceed

Firing Condition

This event fires when a party provides intent to proceed data on an application.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

Intent to proceed is denoted by a boolean value in the "trigger" object, nested beneath "metadata" as "status". Note that the application may show a positive (true) or negative (false) intent to proceed -- the value at "trigger.metadata.status" must be read by the event consumer to determine the actual state (i.e. the receipt of the event does not assure a positive intent to proceed).

The value at "trigger.metadata.triggeredById" will always be populated with the id of the borrower who triggered the event.

The value at "trigger.metadata.triggeredByMethod" will only be present if "trigger.metadata.status" is true and the Disclosures 2.0 flow is turned on.

The "triggeredByMethod" types are:

Triggered MethodNotes
ELECTRONICALLY_IN_BLENDBorrower supplied Intent to Proceed directly in Blend.
OUTSIDE_OF_BLENDLender entered Intent to Proceed into Blend on behalf of a borrower, who supplied it outside of Blend.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "INTENT_TO_PROCEED",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
      "metadata": {
        "status": "true",
        "triggeredById": "be79ef4e-bc6e-472b-87da-325aa8ef2ba0",
        "triggeredByMethod": "ELECTRONICALLY_IN_BLEND"
      }
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Process Completed

Firing Condition

This event fires when a process on an application is transitioned to the completed state.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

A specific subset of process completion milestones are currently available. For information about the position of milestones and processes in the lifecycle of an application as it applies to your Blend instance, consult with your Implementation Engineer or Account Manager.

The currently available processes are:

Process NameNotes
Getting Started
Getting To Know You
Assets
Income
Real Estate Owned
Declarations
Demographic Information
Additional Questions
Coborrower Getting Started

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "PROCESS_COMPLETED",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
      "metadata": {
        "name": "Getting Started"
      }
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

ECOA

Firing Condition

This event fires when a requested ECOA has been triggered.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

N/A

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "ECOA",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

AUS Run Completed

Firing Condition

This event fires when a requested AUS run has been completed.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

N/A

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "AUS_RUN",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Credit Pull Completed

Firing Condition

This event fires when a credit pull has occurred as a result of a manual lender request to pull credit.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - MORTGAGE

Notes

Note that credit must be enabled in your Blend instance for the solution(s) you'd like to receive events for. At present, only lender-initiated credit pulls will be reported; specifically, auto-pulled credit related to borrower / party actions on an application will not generate an event.

The metadata object in the trigger information may contain a key entitled "referenceNumbers" that points to an array of string values containing reference information returned from the credit pull request.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "CREDIT_PULL",
      "triggeredAt": "2018-06-14T15:08:18.356Z",
      "metadata": {
        "referenceNumbers": [
          "192990920202",
          "A38329A22"
        ]
      }
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}

Account Ready to Fund

Firing Condition

This event fires when a consumer banking account opening application is set to the status of "ready to fund."

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - this will be always be "ACCOUNT_OPENING" for this triggered event.

Notes

The ability of this event to be used depends upon leveraging Blend's Consumer Banking solution for account opening and the specific details of your implementation of that solution; consult with your Implementation Engineer or Account Manager for more information.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "282f3df7-7900-45d5-aafe-b438def61d7c",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_BANKING",
    "trigger": {
      "type": "READY_TO_FUND",
      "triggeredAt": "2018-06-14T15:08:18.356Z"
    },
    "fields": {
      "solutionSubType": {
        "value": "ACCOUNT_OPENING"
      }
    }
  }
}

Prequal Lead

Firing Condition

This event fires after a party enters their contact info as part of a self-serve affordability/prequal application.

Fields

The fields object will contain, at minimum:

  1. "solutionSubType" - the type of prequal the party is associated with (e.g., "MORTGAGE", "HELOC", etc.).

Notes

For more information about the specific generation of this event for your Blend instance and integration, consult with your Implementation Engineer or Account Manager.

Example

{
  "id": "16ed06db-d0ce-478a-8e2d-63a21d02f55b",
  "firstEmittedAt": "2018-06-14T15:08:18.466Z",
  "lastEmittedAt": "2018-06-14T15:08:18.466Z",
  "attempt": 1,
  "status": "EMITTED",
  "data": {
    "id": "382f3df7-7900-45d5-aafe-b438def61d7d",
    "type": "application",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "trigger": {
      "type": "PREQUAL_LEAD",
      "triggeredAt": "2022-03-14T15:08:18.356Z",
    },
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      }
    }
  }
}