The Q2 CorePro Developer Hub

Welcome to the Q2 CorePro developer hub. You'll find comprehensive guides and documentation to help you start working with the CorePro API as quickly as possible.

Get Started    

Bank Document

A bankDocument is a document issued by a bank that a customer must indicate they have read and accepted during the customer creation process or the account creation process.

During the customer/account creation process it is required that certain documents are displayed to the customers. Additionally, we require acknowledgement of the viewing and the acceptance of these documents before the account can be opened.

The actual documents required varies depending on the bank assigned to your program but some examples include:

  • e-Sign Agreement
  • Terms & Conditions
  • Privacy Policies
  • Truth-in-Savings Account Disclosure
  • Deposit Account Agreement

🚧

Note

You MUST display the e-Sign disclosure in text format (for example in a scrollable text box) where the user can visibly read the disclosure in text form. Provide an "Accept" button to accept the e-Sign disclosure. Once the user has accepted the e-Sign disclosure, you may then display in list form, the remaining bank account disclosures in PDF format. Provide an "Accept" button to accept the bank account disclosures.

The HTML version of the document is returned inline. If available, a PDF version of each document is stored at the returned url for retrieval.


bankDocument Object

Property

Data Type (length)

Description

bankId

integer

CorePro-assigned unique ID for the corresponding bank this document applies to

culture

enum

Values vary by program . Examples:

  • en-US: English
  • es-US: Spanish

customerId

deprecated

Use programId instead

documentId

integer

CorePro-assigned unique ID for this document

documentType

enum

Values include:

  • TermsAndConditions
  • PrivacyPolicy
  • TruthInSavings
  • eStatement
  • ConsumerDepositAgreement
  • FeeSchedule
  • ReferAFriend
  • EftInfo
  • ProductInfo
  • CardInfo
  • FeeDisclosure

downloadUrl

string

Absolute url to the pdf version of the document

effectiveDate

datetime

Date the document became effective

expireDate

datetime

Date the document will expire

html

string (2 MB)

Document HTML content

programId

integer

CorePro-assigned unique ID for your program

title

string (100)

Title to display to the customer as the link text to the downloadUrl

Updated 4 months ago

Bank Document


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.