HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Disclosure Package Status Change

Event Type

disclosuresEvent

Entity Action

DISCLOSURES_STATUS_CHANGE

Firing Condition

After disclosures are issued, this event is emitted on a per-package basis when the disclosures package's overall status changes. As this event is tied to the package itself, no party information is included.

Below is a table that outlines the firing conditions of this event type.

StatusFiring Condition
ISSUINGPackage is queued up and is waiting to be issued.
FAILED TO ISSUEStatus is fired once per failed attempt to issue. Blend makes a total of 3 attempts before failing permanently.
PENDING_ECONSENTPackage was issued but not all signers have e-consented.
ELECTRONICALLY_DELIVEREDAll signers have e-consented and the package was successfully issued to all signers.
ELECTRONICALLY_VIEWEDAll signers have viewed the package.
DECLINDEDOne of the signers has declined the package.
ALL_SIGNATURES_COMPLETEThe package is completed. All documents have been signed and/or viewed.
CANCELLEDPatch Disclosure API call made to post this status to Blend. This status will not be emitted by Blend.
RETRIEVEDPatch Disclosure API call made to post this status to Blend. This status will not be emitted by Blend.

📘

Note

These events signify the status of the disclosure package as a whole without regard to the individual party actions. Package level events can be used to determine when a package has been completely signed, for example, without the need to store individual party action events to determine the state of the larger package.

Valid Decorators

  • losPrimaryKey
  • crmPrimaryKey
  • originationType
  • referenceLoanNumber

Object Format

{
  "eventType": "disclosuresEvent",
  "eventId": UUID,
  "message": {
    "entityAction": "DISCLOSURES_STATUS_CHANGE",
    "entityId": UUID,
    "entityType": string,
    "disclosuresId": UUID,
    "disclosuresStatus": string,
  },
  "originallyEmittedAt": DateTime (UTC Unix/Epoch Timestamp),
  "status": "EMITTED"
}