HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Document Available

Event Type

documentEvent

Entity Action

AVAILABLE

Firing Condition

When an document on a loan or an application is ready to be exported.

Valid Decorators

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

Object Format:

{
  "eventType": "documentEvent",
  "eventId": UUID,
  "message": {
    "entityAction": "AVAILABLE",
    "blendDocumentId": UUID,
    "entityType": ENUM, // ['loan', 'accountApplication']
    "metadata": {
      "docType": string,
      "source": ENUM,
      "documentName": string,
      "entityId": UUID,
      "borrowers": [
        {
          "email": "[email protected]",
          "borrowerId": UUID
        }
      ]
    }
  },
  "originallyEmittedAt": DateTime (UTC Unix/Epoch Timestamp),
  "status": "EMITTED"
}