Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.

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