Infinity API Index

NOTE: This Infinity/DBX 4.2.6 API documentation refers to the object and integration services that are delivered as part of Infinity and are valid for the current release

Account Aggregation

Following is the list of APIs shipped as a part of the this module:

API	Description
getAccountsPostLogin	The API retrieves the list of all accounts for the logged-in user in the Online Banking application (OLB).

Automated Clearing House

The following API is shipped as a part of the this module:ww

API	Description
fetchTransactionSubRecords	The API fetches the sub records of a Transaction performed under an ACH Transaction.
UploadACHFile	The API uploads the ACH file for processing.
FetchBBTaxSubType	The API fetches Tax Sub Types for a given Tax Type for a Federal Tax template/transactions.

Accounts Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
getAccountPendingTransactions	The API gets the pending transactions for a specified account.
getAccountPostedTransactions	The API gets the list of posted transactions for a specified account.
getAccountTransactionByType	The API gets the list of transactions based on the account type.
getFrequentOtherBankAccounts	The API retrieves the list of most frequently used external bank accounts for a given user.
getProductList	The API gets the list of products available within a state while applying for a new product.
getRecentAccounts	The API gets the list of recent accounts accessed for the user.
newAccountOpening	The API creates accounts for the logged in user for the specified products.
showDownloadStatements	The API retrieves the statement link of the selected account for a selected month in the selected format (used only in Online Banking).
updateAccountPreference	The API updates the account preference for the specified account.
updateFavouriteStatus	The API updates the favourite status of an account in Online Banking (OLB) application.

Account Requests

Following is the list of APIs shipped as a part of the this module:

API	Description
createCardRequest	The API is consumed by OLB to create a new request related to Card or Account
createTravelNotification	The API creates a new travel notification for the user with all travel related details to be used by the bank.
deleteTravelNotification	The API deletes an existing travel notification for the user.
getTravelNotification	The API gets the list of all travel notifications (both active and expired) for the user.
getTravelNotificationStatus	The API retrieves the status of a travel notification.
updateTravelNotification	The API is used to perform actions on the existing travel notification such as editing the phone number, dates of travel, selected destinations, and selected cards for the travel.

Alert Management

Following is the list of APIs shipped as a part of the this module:

API	Description
getAllAlerts	The API fetches all alerts grouped by alert types along with customer preference of each alert.
getCustomerAlertCategoryChannelPreference	The API is used to fetch Alert Category Channel Preferences of a Customer.
getCustomerAlertCategoryPreference	The API is used to Fetch Alert Category Preferences of a Customer.
getCustomerAlertTypePreference	The API is used to fetch Alert Type Preferences of Customer.
updateAlerts	The API updates an alert.
setAlertPreferences	The API is used to set Alert Preferences of the Customer.

Approvals and Requests - Business Banking

The following API is shipped as a part of the this module:

API	Description
withdrawACHFile	The API can withdraw the ACH file that is uploaded and is pending for approval.
withdrawACHTransaction	The API can be used to withdraw the ACH Transaction that is pending for Approval.

Cards Management Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
getActiveCards	The API retrieves the list of all active cards available for a user.
getCardListForEnrolment	The API gets the list of cards for a user during the enrollment process.
getCardsByUsername	The API gets the list of cards based on the user name.

Check Management Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
createTransfer - RDC	The API creates various transactions such as transfer, bill pay, P2P, cardless cash, overdraft for cardless cash, and remote check deposit.

Customer Management

Following is the list of APIs shipped as a part of the this module:

API	Description
createCustomerSecurityQuestions	The API creates the list of security questions and answers entered by the user.
getRandomCustomerSecurityQuestions	The API retrieves random questions from the list of security questions.
updateCustomerDetails	The API updates the contact details of a customer.
trackDeviceRegistration	The API tracks a device for a user.
verifyCustomerSecurityQuestions	The API verifies the security questions and answers entered by the user~.

Customer Request

Following is the list of APIs shipped as a part of the this module:

API	Description
CreateNewCustomerRequestWithoutAttachment	The API creates a new Request or creates a new Message to an existing Request based on the requestId.
getAllMessagesForARequest	The API gets all the messages in a Request.
getRequestCategory	The API retrieves all the Request categories.
getRequests	The API gets all the requests (threads) of a user.
getUnreadMessageCount	The API gets total number of unread messages.
updateRequest	The API updates the request depending on the input given.

Customer Service

The following API is shipped as a part of the this module:

API	Description
getContactUs	The API fetches informational content to contact the bank's customer care.

Internal Users

The following API is shipped as a part of the this module:

API	Description
getAllCountries	The API is used to fetch all the countries at the back end.
getAllRegions	The API retrieves the list of all regions maintained in DBX.
getRegionDetails	The API retrieves the details of the specified region.

Login Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
checkUserEnrolled	The API checks whether the user is enrolled or not.
dbxRequestOTP	The API generates an OTP and the associated security key.
dbxVerifyOTP	The API validates the supplied OTP against the security key.
getPasswordLockoutSettings	The API retrieves the password lockout settings maintained in the DBX identity management system.
getPasswordPolicies	The API retrieves the list of password policies.
getPasswordRulesAndPolicy	The API retrieves the policies for maintaining a password in DBX.
getSecurityQuestions	The API retrieves the list of security questions.
getUserNameAndPasswordRulesAndPolicies	The API retrieves the policies for maintaining a username and password in DBX.
getUserNameRulesAndPolicy	The API retrieves the policies for user name in DBX.
resetDbxUserPassword	The API resets the password of a user.
requestEnrollOTP	The API initiates the MFA process or alernately fetches additional parameters required to initiate the MFA process.
requestLoginMFAOTP	The API initiates the MFA OTP process for the Login flow.
updateDBXUserPassword	The API updates the password of a user.
updateDBXUserStatus	The API toggles the status of a user between 'Active' and 'Suspended'.
verifyCVV	The API verifies the CVV of the specified card.
verifyLoginMFAOTP	The API validates and verifies the OTP passed in from the application for the given Login scenario.
verifyPin	The API verifies the PIN provided by the user.
verifyLoginMFASecurityQuestions	The API validates and verifies the user's answers to the specified security questions for the given Login scenario.
verifyOTPPreLogin	The API validates and verifies the OTP passed in from the application for the given pre-login scenario like reset password or user enrollment.

Marketing Local Services

The following API is shipped as a part of the this module:

API	Description
sendDmResponse	The API sends data for metrics.

Onboarding Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
createDbxCustomer	The API enrolls a retail banking customer in DBX.
getUserPersonalInfo	The API retrieves the personal info of a new user while enrolling.
getUserState	The API retrieves the state (steps) of a new user while enrolling.
userCreditCheck	The API validates the credit check of a user with Social Security Number (SSN).
updateRecipient	The API updates the existing recipient details of a user.
verifyDbxUser	The API verifies the existence of a user based on a PII (Personally Identifiable Information) and returns the relevant attributes
verifyDbxUserName	The API checks if there is a user exist in DBX or External Bank with this identifying information.
verifyExistingUserByEmail	The API verifies whether a user exists with the given email.
verifyExistingUserByPhone	The API verifies whether a user exists with the given phone number.

Organization Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
checkIfOrgMemberExists	The API verifies if a Membership Id exists in core banking system and whether it can be associated with a given user and organization.
CreateMicroOrganizationEmployee	The API enrolls a micro business banking user in DBX.
getDbxOrganizationUsers	The API retrieves the details of all the corporate users registered for a DBX organization.
getOrganizationAccounts	The API retrieves the list of accounts assigned to an organization.
GetOrgEmployeeDetails	The API retrieves the details of the specified business banking user in DBX.
IsEmailLinkActive	The API checks if an e-Mail link sent to a user during activation is still valid or not.
OFACAndCIPChecks	The API initiates the OFAC and CIP verification check for a business banking user.
RegisterMBOwner	The API creates a micro business owner in DBX.
ResendActivationLink	The API re-sends the e-Mail activation link for a business banking user in DBX.
SetOrgEmployeePassword	The API helps the you to set password when your account is created by the Business Owner.
updateOrganizationEmployee	The API updates the details of a business banking user in DBX.

Payments and Withdrawals

Following is the list of APIs shipped as a part of the this module:

API	Description
createBulkBillPay	The API initiates a bulk bill payment.
createCardlessTransaction	The API creates a new cardless transaction.
getRecentPayee	The API retrieves the list of recent bill payees accessed by a user.
getPayeeBills	The API retrieves the list of all bill payments made by the payee.
getPendingCardlessTransactions	The API gets a list of pending cardless transactions.
getPostedCardlessTransactions	The API gets a list of posted cardless transactions.
getUserCompletedBillHistory	The API gets all the past billed transactions of the logged in user.
getUsersScheduledBills	The API gets all the scheduled Bill transactions of the logged in user.

Personalization Local Services

The following API is shipped as a part of the this module:

API	Description
deleteNotification	The API deletes the notification.
updateBulkPFMTransaction	The API updates the PFM transaction details for multiple users.

Product Management

Following is the list of APIs shipped as a part of the this module:

API	Description
fetchBankDetails	The API retrieves a bank's details based on the routing number
getAccountDetails	The API points to the service provided by an external bank to retrieve account details for the given account-ID.

Profile Management Services Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
checkSecureAccessCode	The API verifies the email and phone enabled status for secure access.
checkSecurityQuestionStatus	The API verifies if security questions exist for a user.
createAddress	The API creates an address for the user.
createPhone	The API creates a new phone number for the user.
deleteAddress	The API deletes an address for the user.
deletePhone	The API deletes the user phone number.
getAllAddress	The API gets all user addresses.
getAllPhones	The API gets all user phone numbers.
updateAddress	The API updates an existing address.
updateDbxCustomer	The API updates personal information such as user name, date of birth and other PII fields.
verifyExistingPassword	The API verifies the existing password of a user.
updatePhone	The API updates the user phone number.
updateSecureAccessCode	The API updates the secure access code for a user.
updateUserAccountSettings	The API updates the account settings of a user.

P2P Transfers Local Services

The following API is shipped as a part of the this module:

API	Description
deletePayPerson	The API deletes a P2P transfer recipient/beneficiary.
editPayPerson	The API edits a P2P transfer recipient/beneficiary.
getRecentPayPerson	The API retrieves the list of recent pay persons accessed by a user.
getPayPersonHistory	The API gets all the P2P transactions done to a particular person.
getScheduledTransferAndP2pTransactions	The API gets all the scheduled transfers and P2P transactions of the user in mobile banking.
getSentP2PTransactions	The API gets all the P2P transactions made by the current user.

Static Content

The following API is shipped as a part of the this module:

API	Description
createCustomerTNCForLogin	The API stores customer terms and conditions consent during the first time login into Retail Banking applications.
createTermsAndConditions	The API is used to create Terms and Conditions.
getCustomerTermsAndConditionsPostLogin	The API gets language specific terms and conditions for given code.
getFAQs	The API fetches the informational content such as FAQs.
getPrivacyPolicy	The API fetches the informational content such as Privacy Policy.
getTermsAndConditions	The API is used to create Terms and Conditions.

Stop Payments Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
getDisputedTransactions	The API retrieves the list of disputed transactions for logged in user.
getStopCheckPaymentRequestTransactions	The API retrieves the list of disputed transactions for logged in user.

Transfer to External Account Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
deleteExternalAccount	The API deletes a specific external account.
editExternalAccount	The API edits any external account.
getAllExternalAccountsWithPagination	The API gets the list of all external account with pagination.
getToExternalAccountTransactions	This API retrieves the list of all transactions for which the given account is a recipient.
getUserScheduledTransactions	The API gets all the scheduled transactions of the logged in user.
makeTrialDeposit	The API creates a trial deposit to an other bank that is less than $0.50.
verifyExternalBankAccount	The API verifies the external bank account using beneficiary's credentials.

Transfer to Own Account Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
getSameBankAccount	The API retrieves the list of all internal bank accounts.

Transactions Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
cancelScheduledTransactionOccurrence	The API cancels the next scheduled transfer, such as bill pay or P2P transactions.
deleteTransaction	The API cancels any scheduled transfers, such as bill pay or P2P transactions.

Wire Transfers Local Services

Following is the list of APIs shipped as a part of the this module:

API	Description
addRecipient	The API registers a new wire transfer recipient/beneficiary.
getRecipientWireTransaction	The API retrieves the list of wire transfers done for a specific payee.
getUserWiredTransactions	The API retrieve the list of wire transfers of the logged in user.
getWireTransferRecipient	The API retrieve the list of all Wire Transfer Recipients of the logged in user.
saveRecipientAfterWireTransfer	The API creates Payee for a one time wire transfer.