Introduction
This E-Statement Report API will provide clients with the ability to generate a statement reports for their accounts and will include the details of the information available in the report.
The E-statement report API provides below functionalities:
Give information whether customers opted for e-statement or paper-statement based on the given date range.
Quickly validate the active user account information.
The functionalities are based on the below filters
For the given FI.
For a specific customer of the FI
Based on the specific account type.
What is Supported
Verifying that a customer exists at a specified financial institution.
To view the e-statement and paper-statement opt-in status for a given user account.
Allow users with the disclosure status of "ACCEPTED" to only choose the statement mode.
Supported institution disclosure name is "OLS".
If supposed total count is 10 and some users have accepted the disclosure agreement while others have not, a response with the code 206 indicates a partial content status.
Key features and target audience
The E-Statement API interfaces with Users API, Disclosures API and Accounts API.
- Used for trusted server-side applications
- Sending a request passes a key-and-secret pair assigned to your application
- Since the token is issued in the context of a Financial Institution (FI) rather than a user, no end-user login is required
- Response provides the Bearer Token to be used to call other DevEx APIs
Onboarding
Enim senectus in eget bibendum donec. Mauris urna lorem et aenean. Justo auctor vel phasellus tellus tincidunt et. Ullamcorper pretium ipsum.
Ante euismod vitae morbi nisi. Commodo mauris tincidunt arcu odio hendrerit ut pulvinar lectus laoreet. Odio odio nunc iaculis sed id tempor et. Aliquam tortor quis ipsum id blandit nunc sit etiam. Sed eget libero dui quam cras.
API Access
Two unique PrimaryBid Connect API client accounts will be created and granted upon sign-off on all legal and compliance Partnership agreements.
The API client accounts include a set of credential strings (ID and secret) used to authenticate requests to the PrimaryBid Connect API on our Staging and Production environments.
Authentication
Authentication proves that you are who you say you are. Authentication tokens identify a user (the person using the app or site).
You‘ll need the following items to set up basic authentication:
- Developer Experience account
- Sandbox environment with an organization
- Shared Key
- Secret Key
Generating your Secret Key
You’ll need a bearer token or an API security key to authenticate API calls. A secret key serves as a secure token to authenticate and authorize requests. Unauthorized use of a secret key could potentially cause a security breach. Thes ecret key holds the error token used to access real data through the API.
Visit our guide on authentication to learn more.
Before you begin, you‘ll require a unique client_id and client_secret for your app. Notify your implementation manager or PossibleNOW Support atsupport@possiblenow.com to request an OAuth client_id and client_secret. Include your My Preferences Client ID and the environment (staging (sandbox) or production) for which you want to generate the credentials in your request.
These credentials must be treated securely.
Auth Flow
- Sit lacus duis quisque nulla ultrices dignissim tristique amet sed.
- Et pretium ante vitae et sit at.
- Fusce arcu non semper tortor nunc. Urna justo cras feugiat interdum ut quam augue.
Getting Started
While the technical documentation in the API Specs section describes the endpoints (or ways to call the API with different parameters to execute different actions), the following provides a simplified list of use cases for Authentication:
The service available through the Candescent Digital Banking Developer Portal (providestokens for two different grant types:
Client Credentials
- Used for trusted server-side applications
- Sending a request passes a key-and-secret pair assigned to your application
- Since the token is issued in the context of a Financial Institution (FI) rather than a user, no end-user login is required
- Response provides the Bearer Token to be used to call other DevEx APIs
Password
- Best for first-party native applications (such as the FI’s own mobile application)
- Request is sent with key-and-secret pair plus the customer’s username and password
- Response provides Bearer Token to be used to call other DevEx APIs
