Events

Enumerations

error.errorCode:

Standard HTTP error codes

event.status:

• EMITTED
• ACKNOWLEDGED
• PROCESSING
• SUCCEEDED
• FAILED
• NO_ACTION

event.eventType

• applicantEvent
• applicationEvent
• disclosuresEvent
• documentEvent
• eConsentStatus
• systemEvent
• workflowEvent

event.message.entityAction

• ADDED
• APPLICATION_ARCHIVED
• APPLICATION_EXPORTED
• APPLICATION_SUBMITTED
• ARCHIVED
• AVAILABLE
• BROKER_EXPORT
• COMPLETED
• DISCLOSURES_DECLINED
• DISCLOSURES_EXPIRED
• DISCLOSURES_SIGNED
• DISCLOSURES_STATUS_CHANGE
• DISCLOSURES_VIEWED
• EXPORTED
• HEALTHCHECK
• INTENT_TO_PROCEED
• READY_TO_FUND
• SUBMITTED
• TRID_TRIGGERED
• UPDATE
• VERIFICATION_REF_ID_UPDATED

message.entityType

• accountApplication
• document
• loan
• party

message.metadata.docType

The classification category of a specific document. Primarily used to filter out Document events that are irrelevant for a specific use case.
Download CSV of Doc Type Definitions

message.metadata.source

• BLEND
• BORROWER\
• LENDER
• PROVIDER

message.milestone

• GETTING_STARTED
• GETTING_TO_KNOW_YOU
• ASSETS
• INCOME
• REAL_ESTATE_OWNED
• DECLARATIONS
• DEMOGRAPHIC_INFORMATION
• ADDITIONAL_QUESTIONS

message.originationType

Indicates the loan type the event applies to IF the entityType is loan.

• AUTO
• HELOAN
• HELOC
• MORTGAGE

Event Decoration

At times, adding metadata to events can aid in downstream processing and make integration more efficient. To this end, we offer a set of decorator configurations that may be made available. Decorators are not available on all events; check the event descriptions below for information on which decorators are available for each event type.

Decorators are always injected as keys into the message object, and may be further nested. The path of the decorator data is described as starting with the message attribute as the root. As an example, the decorator losPrimaryKey would have a full path of message.losPrimaryKey and the decorator borrower.econsentMetadata would have a full path of message.borrower.econsentMetadata.

{
  "eventType": "eConsentStatus",
  "eventId": UUID,
  "message": {
    "entityAction": "UPDATE",
    "entityType": "loan",
    "entityId": UUID,
    "borrower": {
      "email": string,
      "borrowerId": UUID
    },
    "eConsentStatus": boolean,
    "crmPrimaryKey": string | null,
    "losPrimaryKey": string | null,
    "originationType": ENUM(string)
  },
  "originallyEmittedAt": DateTime (UTC Unix/Epoch Timestamp),
  "status": "EMITTED"
}

Decorators

• losPrimaryKey
• crmPrimaryKey
• originationType
• metadata.documentYear
• referenceLoanNumber
• metadata.memberEntityIdentifier
• borrower.econsentMetadata
• metadata.assetIdentifier

LOS Primary Key

The name of the loan identifier that links a Blend loan with a record in an LOS. This will only be set if the Blend instance has a LOS integration, or if one is set using the API.

CRM Primary Key

The name of the loan identifier that links a Blend loan with a record in a CRM. This applies to Blend instance's enabled with a CRM integration.

Origination Type

The type of loan (e.g. HELOC) referenced in the event.

Document Year

Year the document references.

Note:

• This field does NOT always exist
• Only exists on document events
• Only exists for CERTAIN types of documents

Loan Number

The reference number that is displayed in the lender pipeline view of the Blend web interface. Note that with certain role permissions, this number is mutable by users via the web interface.

Member Entity Identifier

An ID pointing to employment or account source of a given document.

Note:

• This field does NOT always exist
• Only exists on document events
• Only exists for CERTAIN types of documents

E-Consent Metadata

The status, ip, and date of E-Consent for a party. Note: this decorator only available for E-Consent event(s).

{
  eventType: ENUM(string)
  eventId: UUID,
  message: {
    borrower: {
      ...
      eConsent: {
        status: string,
        ip: string,
        date: DateTime,
      },
    },
    ...
  },
}