Introduction
The Get FI Customer API is a set of basic services used to retrieve the information related to a customer of a specific financial institution (FI).Having complete, timely, and accurate access to data about a customer is a crucial aspect of any financial institution's online systems and products.
The Get FI Customer API enables customer to:access accurate information about themselves in the system in order to manage their finances.
It enables the financial institution to:
Maintain and deepen the relationship with their customer by ensuring customers have all the tools and products needed to successfully manage their finances
It enables the developer to:
Retrieve the customer's contact, status, and credential data from the Digital Banking system
What is Supported
The Banking Services Technical Documentation in the **API Specs** section fully describes the endpoints, header values, parameters, and responses.
Below is an overview of the API capabilities:
Retrieve Digital Banking data about a particular Customer, a Digital Banking User, including:
Contact info, such as name, phone number and email address
User login Id, Credit Union Member Number of Bank Customer Number
User status on the system (Active, On Hold, Locked, etc.)
User Products (Digital Banking, Mobile, Bill Pay, etc.)
- 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. The secret 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 NCR Voyix 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
