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:
- The
abilities.documentsproperty istruefrom the User-Specific Institution Abilities endpoint. - There exists at least 1 document type in the
documentTypesarray 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.
- If the
deliverySettingsobject isnullor does not exist, no enrollment is required. - If the
deliverySettings.enrollmentFlowhas the valueperAccount, thesettings.deliveryMethodfrom the Per-account Settings endpoint must have a value of eitherelectronicorbothPaperAndElectronic. - If the
deliverySettings.enrollmentFlowhas the valueallOrNone, thesettings.deliveryMethodfrom the All-accounts Settings endpoint must have a value of eitherelectronicorbothPaperAndElectronic.
Details
See the API Reference.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Developer Office Hours
where we answer technical Q&A from the audience.
Did this page help you?
Last updated Tue Dec 6 2022