Party Events

Event Summary

Party events are triggered for data changes related to the party entity, which describes any entity that may be associated with a financial application. For example, if you were to apply for a home mortgage by yourself, you would be a "party" on the application. If you added a co-borrower, they would be another "party" on the application.

Additionally, parties may be used to describe trusts, banks, lenders, or other institutions that are involved in a financial transaction.

Created

Firing Condition

When a party is added to the Blend data model -- this can happen using the UI to individually add a party and "save" the new party or via the API. There are also certain API and UI compound operations -- such as creating a loan or ingesting a loan from a CRM -- that will cause a party to be created automatically, thus also firing this event.

Fields

The fields object will contain, at minimum:

"solutionSubType" - the type of application the party is associated with (e.g., HELOC, MORTGAGE, etc.)
"applicationId" - the UUID of the application the party is associated with.

Notes

Parties may be created or removed both programmatically and via the UI at several points in the application process. As such, it is important to note that events for parties are valid at the time of receipt and should be leveraged for operational automation. For a fully integrated solution, it is often most helpful to store the party identifier and the relationship data (such as the "applicationId") and then call the Blend API for future information about the party using the UUID.

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-b438def61d7a",
    "type": "party",
    "action": "created",
    "solution": "CONSUMER_MORTGAGE",
    "fields": {
      "solutionSubType": {
        "value": "HELOC"
      },
      "application": {
        "id": "282f3df7-7900-45d5-aafe-b438def61d7a"
        }
    }
  },
  "links": {
    "application": {
        "href": "https://api.beta.blend.com/home-lending/applications/282f3df7-7900-45d5-aafe-b438def61d7a"
    }
  }
}

Updated

E-Consent

Firing Condition

When e-consent data is provided by the party via API or directly through the Blend UI.

Fields

The fields object will contain, at minimum:

"solutionSubType" - the type of application the party is associated with (e.g., HELOC, MORTGAGE, etc.)
"applicationId" - the UUID of the application the party is associated with.
"eConsentStatus" - a boolean value of whether the party has provided or declined E-Consent.

Notes

E-Consent is provided at a per-party level, meaning that on an application with n parties, an events listener can expect to receive n events of this type assuming the application is completed in full. Note that the state of e-consent may change based on the party's discretion at various points in the loan (e.g. if a secondary party / co-borrower first provides consent and then later decides they would prefer to fill out the application via a non-digital route). Also note that parties may be added or removed from certain application types (e.g. a mortgage application) which may result in multiple events being transmitted for parties that are later removed from the loan.

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-b438def61d7a",
    "type": "party",
    "action": "updated",
    "solution": "CONSUMER_MORTGAGE",
    "fields": {
      "solutionSubType": {
        "value": "MORTGAGE"
      },
      "application": {
        "id": "282f3df7-7900-45d5-aafe-b438def61d7b"
        },
      "eConsentStatus": {
        "value": "true"
      }
    }
  },
  "links": {
    "application": {
        "href": "https://api.beta.blend.com/home-lending/applications/282f3df7-7900-45d5-aafe-b438def61d7b"
    }
  }
}

Login

PartyApplicationAccess

Firing Condition

For users with a single application, this happens when the user logs in.
For users with multiple applications, the happens when the user selects an application to access as part of logging in.

Fields

The fields object will contain, at minimum:

"solutionSubType" - the type of application the party is associated with (e.g., HELOC, MORTGAGE, etc.)
"loanId" - the UUID of loan that is being accessed
"partyId" - the UUID of the party that is being accessed

Notes

Users are different from parties: each new application a user creates has a different partyId, loanId combination.
Joint borrowers that share an email are a special case: this event will always fire with the partyId of the primary borrower because the coborrower shares the same user.

Example

{
    "attempt": 1,
    "data": {
        "id": "86e5feb8-4def-4cbb-a3ce-28ee0bb9711c",
        "action": "updated",
        "fields": {
            "solutionSubType": {
                "value": "MORTGAGE"
            }
        },
        "solution": "CONSUMER_MORTGAGE",
        "trigger": {
            "metadata": {
                "loanId": "386be7be-0e20-436c-ac2a-af7d6fdf9f53",
                "partyId": "86e5feb8-4def-4cbb-a3ce-28ee0bb9711c"
            },
            "triggeredAt": "2020-04-10T01:25:24.841Z",
            "type": "partyApplicationAccess"
        },
        "type": "party"
    },
    "firstEmittedAt": "2020-04-10T01:25:24.841Z",
    "id": "454b3df3-7241-4071-a3b9-94b259abca9c",
    "lastEmittedAt": "2020-04-10T01:25:25.394Z",
    "status": "EMITTED"
}