Document
Deprecated
This route has been deprecated and should be used for troubleshooting purposes only, and then only in a non-programmatic fashion. It may be removed at any time.
To ensure a consistent handling of errors across the entire CorePro API, any routes which previously returned non-JSON based output (such as raw PDF) have been deprecated.
The new format for these routes will be a JSON-based fileContent object.
In its place, please use the /bankdocument route.
A document represents a document issued by a bank that a customer must indicate they have read and accepted during the customer creation process or the savings 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: The e-Sign agreement MUST be displayed to and accepted by the user before any other documents are listed. After the user has accepted the e-Sign agreement, the others may then be displayed as a list for the user to review in any order.
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.
document Object
Represents data associated with a single document in CorePro.
details
| Property | Data Type (length) |
Description |
|---|---|---|
bankId |
integer | |
culture |
string (20) |
Valid values vary by program. However, here are two examples:
|
customerId |
integer | |
documentId |
integer | |
documentType |
string (50) |
Valid values include:
|
downloadUrl |
string (255) | Absolute url to the pdf version of the document |
effectiveDate |
datetime | Date this document became effective. |
expireDate |
datetime | Date this document will expire. |
html |
string (2 MB) | Actual HTML content. |
title |
string (100) | Title to display to the user as the link text to the downloadUrl. |
list
Retrieve a list of all documents for the given culture.
GET /document/list/{culture}
Request Parameters
culture |
Required | Accepted values vary by program. Examples are:
|
Response Data
A document Object |
Error Codes
| Code | Message (en-US) | Notes |
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
Example
Request
GET /document/list/en-US Authorization: Basic PutBase64TokenHere
Response
200
{
"data": [
{
"bankId": 1,
"culture": "en-US",
"documentId": 25,
"documentType": "TermsAndConditions",
"downloadUrl": "https://sandbox-api.corepro.io/document/download/en-US/25",
"effectiveDate": "2014-02-18T23:01:11.541+00:00",
"expireDate": "2014-12-31T23:59:59.999+00:00",
"html": "<h4>TERMS AND CONDITIONS</h4><br /><br />\r\n\r\n<p>These Terms and Conditions (this \"Agreement\") govern the \r\n\r\nprogram and services available through CorePro and Lincoln Savings \r\n\r\nBank (\"LSB\") as described in this Agreement. \r\n\r\nCorePro offers a unique way to save for a financial \r\n\r\nsavings goal through the accumulation of deposits in a \r\n\r\nsavings account at LSB. LSB is not \r\n\r\naffiliated with CorePro but is a CorePro bank service provider. In addition to this Agreement, your \r\n\r\nSavings Account maintained at LSB is subject to \r\n\r\nLSB's Consumer Deposit Account Agreement and Truth \r\n\r\nIn Savings Disclosure.</p>",
"title": "CorePro Sample Terms and Conditions"
},
{
"bankId": 1,
"culture": "en-US",
"documentId": 26,
"documentType": "PrivacyPolicy",
"downloadUrl": "https://sandbox-api.corepro.io/document/download/en-US/26",
"effectiveDate": "2014-02-18T23:01:11.541+00:00",
"expireDate": "2014-12-31T23:59:59.999+00:00",
"html": "<h4>PRIVACY POLICY</h4> <br /><br /> <p>In this disclosure, you'll find details about our privacy policies and procedures, and instructions for \r\n\r\nchanging how information about you may be shared. Please read this carefully, print and/or download a copy for your files.</p> \r\n<p>Your Savings Account with Lincoln Savings Bank is governed by the LSB Consumer Privacy Disclosure. Please see the LSB Consumer Privacy \r\n\r\nDisclosure for details on the LSB privacy policies.</p>\r\n",
"title": "CorePro Sample Privacy Policy"
},
{
"bankId": 1,
"culture": "en-US",
"documentId": 27,
"documentType": "TruthInSavings",
"downloadUrl": "https://sandbox-api.corepro.io/document/download/en-US/27",
"effectiveDate": "2014-02-18T23:01:11.541+00:00",
"expireDate": "2014-12-31T23:59:59.999+00:00",
"html": "<h4>Truth-In-Savings Account Disclosure</h4>\r\n<p>This Savings Account is only available to individuals with a CorePro Account. This disclosure contains information about your Savings Account related to CorePro. Your Savings Account with Lincoln Savings Bank (“LSB”) is governed by this Truth-In-Savings Account Disclosure and the Lincoln Savings Bank Consumer Deposit Account Agreement. In addition, the CorePro Terms and Conditions govern your CorePro Account. Any capitalized terms not defined herein shall have the meaning set forth in your CorePro Terms and Conditions.</p>\r\n",
"title": "CorePro Sample Truth In Savings"
},
{
"bankId": 1,
"culture": "en-US",
"documentId": 28,
"documentType": "eStatement",
"downloadUrl": "https://sandbox-api.corepro.io/document/download/en-US/28",
"effectiveDate": "2014-02-18T23:01:11.541+00:00",
"expireDate": "2014-12-31T23:59:59.999+00:00",
"html": "<h4>Agreement and Consent Regarding Electronic Communications</h4> \r\n<p>Please read this Agreement and Consent Regarding Electronic Communications (referred to as the “Agreement”) and retain a copy for your future reference. This Agreement contains important information regarding your transaction of business electronically with CorePro and Lincoln Savings Bank (“LSB”). In this Agreement, the following terms have the meanings shown below:</p> \r\n",
"title": "CorePro Sample eStatement"
}
],
"errors": [],
"status": 200
}
download
Retrieve the raw binary data for the given document.
GET /document/download/{culture}/{documentId}
Request Parameters
culture |
Required | Accepted values vary by program. Examples are:
|
documentId |
Required | The documentId for the desired document. |
NOTE: The absolute url for downloading a specific document is included as the downloadUrl property on a document object returned from /bankdocument/list.
Response Data
| A binary stream containing the raw body of the document |
Error Codes
| Code | Message (en-US) | Notes |
| 1-60000 | Any "Common Error Code" may occur. | See Common Error Codes |
| 65301 | Both customerId and documentId are required. | |
| 65302 | The requested document id = {0} is invalid. | |
| 65303 | The requested document id = {0} is configured improperly. Please contact support. | |
| 65304 | The requested document id = {0} could not be located. |
Example
Request
GET /document/download/en-US/34 Authorization: Basic PutBase64TokenHere
Response
200
--raw body of the document here--