Usage Tutorial

Getting Started

The Customer v2 service aims to offer a straightforward and efficient signup process, providing new customers with a fast and easy registration experience for online banking.
‍
The process involves three APIs: one for creating/registering a user, another for fetching digital banking accounts information for the customer, and the last one for fetching digital banking profile information for the customer.

The customerId of the financial institution customer must be recognized before fetching the profile information of customer service because it is a required parameter for accessing the endpoint.

Customer v2

Use Get Customer v2 (GET /v1/customers/{customerId}/contact-methods?userIdType={userIdType}) to fetch digital banking profile information for a customer based on customer ID .

The allowable userIdType query parameter values are CUSTOMER_ID, LOGIN_ID.

userIdType query paramter value	GET Endpoint	Definition
CUSTOMER_ID	_/customers/{customerId}/contact-methods?userIdType=CUSTOMER_ID_	This is the FI Customer Id.
LOGIN_ID	_/customers/{loginId}/contact-methods?userIdType=LOGIN_ID_	This is the "loginId" of FI Customer - same as the username for logging in to the online application.

The response contains the following properties.

Property Name	Property Value
userId	unique identifier for the user
fiId	unique financial institution identifier
loginId	credential used by user to access account
userName	unique identifier chosen by the user
birthDate	user's date of birth
failedLoginCount	number of unsuccessful attempts to access the account
failedPasswordResetCount	total count of unsuccessful attempts to reset a password for an account
firstName	user first name
middleName	user middle name
lastName	user last name
fullName	user full name
registrationDateTime	date and time when a user completed the registration
acceptedDisclosure	users who accepted disclosures and agreement
billPayChecked	shows whether or not the user has bill pay checked
active	shows whether or not the user is active
OnHold	shows whether or not the user's status is on hold
locked	shows whether or not the user is locked
reset	shows whether or not the user's status has been reset
registered	shows whether or not the user has registered
approved	shows whether or not the user has been approved
rejected	shows whether or not the user has been rejected
invalidEmailId	shows if the user's provided email is invalid
acceptedDisclosure	shows whether or not the user has accepted the disclosure
needsToAcceptDisclosure	shows if the user still needs to accept the disclosure
needsToAcceptSecondaryDisclosure	shows if a user needs to accept a second disclosure
registrationDateTime	date when a user becomes a member after registration
emailAddress	email address of the user
userRole	role of user. (i.e. PRIMARY)
userType	type of user. (i.e. RETAIL)
customerId	FI Customer Id
memberNumber	member name assigned to the FI Customer ID.
customerType	type of customer assigned to the FI Customer ID
hostLoginId	the host Id assigned to the FI Customer ID
id	the ID that is used in contact methods
contactInfo	the contact information used in contact methods
telephoneCountryCode	the numerical prefix used to identify the country
protocol	the protocol that is used in the contact method. (i.e. VOICE).
activated	show the status whether or not the user's contact method is activated
enrolledDateTime	date and time when of a user when he enrolled himself
validated	how the status of whether or not the user's contact method is validated
primary	shows the status of whether the user's primary contact method is set
address1	field where a user can input information regarding their street address (often used in forms for contact information, registration, or shipping purposes)
address2
address3
city	user can input the name of the city with which they're associated
postalCode	user can input the postal code of city with which they're associated
primary	shows the status of whether or not the user has added a primary contact method
index	the sequential number assigned to postal address
state	user can input the name of the state/province with which they're associated
type	digital insight account type. (i.e. UNKNOWN)

Use the Post Customer v2 method (POST /v1/customers/register) to create/register a new user for online banking.

Use Get Customer v2 (GET /v1/customers/{customerId}:accounts) to fetch digital banking accounts information for a customer. The response contains the following properties.

Property Name	Property Value
accountHidden	shows the status of whether or not the user's account is hidden
accountNumber	account number of the user.
open	shows if the account status is open
closed	shows if the account status is closed
negativeBalance	shows whether or not the account has a negative balance
delinquent	shows whether or not the account is in a state of overdue or missed payments
inCollection	shows whether or not the account has been transferred to a collection agency
overLimit	shows whether or not the account has surpassed a set limit
writtenOff	shows whether or not debt has been removed from the account
creditBalance	shows whether or not the account has positive balance
paymentCoupon	shows whether or not a payment coupon is associated with the account
retirementPlan	shows whether or not a retirement plan is associated with the account
retPlanOwnedByDeceased	shows whether or not a retirement plan is associated with a deceased user account
approved	shows whether or not the account is approved
notApproved	whos if the account is not approved
deleted	shows if the account has been deleted
verified	shows whether or not the account status is verified
DIAccountType	digital insight account type. (i.e. UNKNOWN)
fiRawAccountType	raw account type of the financial institution
fiAccountType	account type of the financial institution.
description	financial institution account type description.
achCount	number of ACH transactions in the current cycle.
amount	total amount
billPayAccountNumber	bill pay account number
billPayId	the ID through which the bill is paid
category	category of the account type
description	financial institution account type description
diAccountType	digital insight account type
fiAccountTypeDesc	financial institution account type description
fiRawAccountType	raw account type of the financial institution
fiAccountType	account type of the financial institution.
customerId	FI Customer ID.
fiId	unique financial institution identifier.
historyAllowed	shows the status of the FI account type whether or not the history is allowed
hostAccountType	account type from host
id	unique ID associated to the user
interestPriorYearToDate	previous year-to-current interest rate
interestRate	current interest rate
lastInterestPaymentDate	date of the last payment of the interest amount
lastStatementStartDate	date from which user wants the statement
lastStatementEndDate	date till which user wants the statement
micrNumber	MICR number for user account, returned only if known
nickName	nick name of the user
nonQualifiedRate	rate for non-qualified rewards accounts
overDraftBillPayValue	amount of money intended for payment in the case of an overdrawn account
overDraftExternalMortgageAccountValue	amount of money intended for payment in the case of an overdrawn account after mortgage deduction
rdcAccountValue	account value of RDC
overdraftAccountNumber	account number in case in an overdrawn account
ownershipType	type of ownership of an overdrawn account
posCount	number of POS transactions in the current cycle
primaryHolderId	unique ID associated with primary holder
primaryHolderName	name associated with primary holder
maxTransferCount	maximum transfer count of the host
maxCheckCount	maximum check count of the host
maxRegDCount	maximum registered count
hostTransferCount	transfer count of the host
hostCheckCount	It the check count of the host
rewardsCount	number of transactions counting toward rewards qualification for current cycle
tier1BalanceDesc	balance description for tier 1 qualified rewards accounts (e.g. '0 - 10,000').
tier1QualifiedRate	rate for tier 1 qualified rewards accounts
tier2BalanceDesc	balance description for tier 2 qualified rewards accounts (e.g. '> 10,000')
tier2QualifiedRate	rate for tier 2 qualified rewards accounts
tpvReference	external broker reference value; can be from the host or from accounts API CAPS configuration
transferRestriction	restriction type. (i.e. EXCLUDE_ALL)
accountId	account with which the transaction is associated
checkImageIdentifier	identifier linked to the image of a deposited check
checkImageLocator	Iused to locate an image of a deposited check
checkNumber	check number
checkNumberStr	check number string
creditTransaction	recorded movement of funds into an account
depositSlipIdentifier	unique identifier associated with a deposit slip used for submitting funds to an account
description	transaction description
effectiveDate	date on which transaction happened
ledgerBalance	current balance of a financial account after considering debits and credits
memo	transaction memo
micr	MICR is there in user account; returned only if known
isPending	shows whether or not the status of the user transaction is pending
persistentTnum	shows whether or not the user's persistent number is there
transactionDate	transaction date
transactionId	unique identifier for a transaction
transactionNumber	transaction number
transactionType	type of transaction. (i.e. CHECK, ADVANCE).

Getting Started

Customer v2

Sign in now!