The Garden demo institution will be offline for planned maintenance on Wednesday October 16, 2024.

Documents and Statements

Consumer API > API Reference > v0 > Documents and Statements

Concepts

The Documents object represents financial documents that a user has such as statements, notices, tax documents, and other documents.

This object includes information on the enrollment, disclosure acceptance, listing and downloading documents for a user.

Eligibility

Several API calls determine whether documents APIs are supported for a user:

  1. The abilities.documents property is true from the User-Specific Institution Abilities endpoint.
  2. There exists at least 1 document type in the documentTypes array from the Institution Settings for Documents endpoint.

Additionally, users may be required to be enrolled in electronic statements before they can retrieve them digitally.

Determine Whether a User is Enrolled

The deliverySettings object on the Institution Settings for Documents endpoint indicates how to check enrollment for a user and account.

  1. If the deliverySettings object is null or does not exist, no enrollment is required.
  2. If the deliverySettings.enrollmentFlow has the value perAccount, the settings.deliveryMethod from the Per-account Settings endpoint must have a value of either electronic or bothPaperAndElectronic.
  3. If the deliverySettings.enrollmentFlow has the value allOrNone, the settings.deliveryMethod from the All-accounts Settings endpoint must have a value of either electronic or bothPaperAndElectronic.

Details

See the API Reference.


Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Tue Dec 6 2022