Customer Information and Registration

API - V 2.5

Download Swagger Spec

Introduction

Digital Banking customer APIs for the creation and registration of a customer account

The Customer v2 API features a streamlined signup process which is designed to offer a fast and easy registration experience for new customers to sign up for online banking

Key features and target audience

The Customer v2 API enables customers to:

  • Provide their desired details to register for online banking.
  • Review and acknowledge the disclosed terms and legal agreements during the signup process.
  • Ensure their digital banking profile information is up-to-date to enable seamless registration process.

It enables developers to:

  • Quickly register the new customer
  • Ensure robust error handling and validation mechanisms are in place to handle various scenarios during registration.
  • Conduct thorough testing and debugging to guarantee the reliability and stability of the signup process.

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. 

Info Alert
Note
Before you begin, you will require a unique client_id and client_secret for your app. Notify your Implementation Manager or PossibleNOW Support at support@possiblenow.com requesting an OAuth client_id and client_secret. Include your MyPreferences Client ID and the environment (Staging (Sandbox) / 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 provides tokens 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
Info Alert
Note
NOTE: As of March 2020, the Authentication Service contains two proxies: one to retrieve the Bearer Token for DevEx V1 APIs and another for DevEx V2 APIs. Please see the last section of this documentation for a list of V1 and V2 APIs currently exposed in the Developer Portal.
close

Sign in now!

Please sign up or sign in to add to watchlist

Sign in
close

Added to watchlist!

Your interest has been noted. An NCR Voyix Rep
will contact you with further details soon.