GuidesAPI ReferenceDiscussions
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

## Event Summary

Documents are an integral part of the automated finance process; whether it be for providing valid proof of identity, uploading copies of required financial statements and funds, or signing loan application documents and disclosures, documents are at the heart of many of our integrators' processes.

As such, Blend has developed events that specifically revolve around the creation and audit events of such files that allow a subscribed event consumer to understand when a document is available for download and when it has, in fact, been downloaded.

## Created

## Firing Condition

This event is emitted when a document becomes available via the Blend File System.

## Fields

The fields object will contain, at minimum:

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

  2. "applicationId" - the UUID of the application the party is associated with.

  3. "type" - the Blend-defined system type for the document (e.g. "TAX_RETURN").

  4. "foreignKey" - an object that contains a foreign key in the "value" attribute as defined by a third party via UI or API that may refer to the document's internal ID in lender's document repository, for example, as well as an optional "metadata" attribute that describes other information defined by the integrator. In the given example below, an internal "type" attribute is defined.

## Notes

Note that Blend abstracts away complex document behavior (e.g. understanding the difference between originally uploaded empty forms and completed forms) by combining the history of a file or document under a single unique identifier which is transmitted with this event.

Also note that the "foreignKey" field is optionally defined and will not be present if, for example, the document has not yet been synced to an LOS or external integrator's system. Subkeys for the "foreignKey" such as "metadata" may not be defined even if the key is present depending on the integration leveraged by Blend instance that emitted the event.

## Example


## Updated
## Exported
### Firing Condition
This event is emitted when an available file or document is exported by an API or lender user.
### Fields
The fields object will contain, at minimum:
  1. "solutionSubType" - the type of application the party is associated with (e.g., HELOC, MORTGAGE, etc.)
  2. "applicationId" - the UUID of the application the party is associated with.
  3. "type" - the Blend-defined system type for the document (e.g. "TAX_RETURN").
  4. "foreignKey" - an object that contains a foreign key in the "value" attribute as defined by a third party via UI or API that may refer to the document's internal ID in lender's document repository, for example, as well as an optional "metadata" attribute that describes other information defined by the integrator. In the given example below, an internal "type" attribute is defined.
### Notes
This object is triggered by an action that does not necessarily coincide with a key data model change on the affected object but rather an audit event for that object. As such, there is a "trigger" key included in the event's "data" object. In this case, the trigger that caused the event is that the file was exported.
### Example