Use Cases

API - V 2.5

Download Swagger Spec

The end user (in this scenario, the financial institution's customer), wants to get a list of theri details or view a specific account in the system. This case includes the functions for retrieving contact, credential, product, and status information for FI customers registered to use Digital Banking.

Gets the list of accounts for the given institution customer Get the customer accounts GET /bankingservices/v2/fis/{di_fiid}/fiCustomer/{di_ficustomer}/accounts
Request:
Path Parameters:
  • di_fiid: Unique identifier for the FI
  • di_ficustomer: Unique customer identifier

Headers:

  • di_tid: A UUID string used as unique identifier for this token request
  • offering_id: Uniquely identifies the name of the client app making the request
  • Authorization: The bearer access token from the Authentication API
Gets the digital banking profile information for a customer Get customer information GET /bankingservices/v2/fis/{fiId}/Customers/{fiCustomerId}
Request:
         Path Parameters:
  • di_fiid: Unique identifier for the FI
  • di_ficustomer: Unique customer identifier
Query Parameters:
  • fiCustomerIdType: By Type of customerId, there are four possible values: GUID, MEMNUMBER, LOGINID, HOSTID

Headers:

  • di_tid: A UUID string used as unique identifier for this token request
  • Authorization: The bearer access token from the Authentication API
  • offering_id: Uniquely identifies the name of the client app making the request

Example Code

Here's an excerpt from the Accounts service:

Gets the list of accounts for the given institution customer

Sample Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns8:Accounts xmlns:ns2="[http://schema.intuit.com/domain/banking/financialInstitution/v2](http://schema.intuit.com/domain/banking/financialInstitution/v2)" xmlns:ns3="[http://schema.intuit.com/domain/banking/challengeQuestionInfo/v2](http://schema.intuit.com/domain/banking/challengeQuestionInfo/v2)" xmlns:ns4="[http://schema.intuit.com/fs/common/v2](http://schema.intuit.com/fs/common/v2)" xmlns:ns5="[http://schema.intuit.com/domain/banking/fiCustomer/v2](http://schema.intuit.com/domain/banking/fiCustomer/v2)" xmlns:ns6="[http://schema.intuit.com/domain/banking/preference/V2](http://schema.intuit.com/domain/banking/preference/V2)" xmlns:ns7="[http://schema.intuit.com/domain/banking/notification/v2](http://schema.intuit.com/domain/banking/notification/v2)" xmlns:ns8="[http://schema.intuit.com/domain/banking/account/v2](http://schema.intuit.com/domain/banking/account/v2)" xmlns:ns9="[http://schema.intuit.com/domain/banking/accountTransaction/v2](http://schema.intuit.com/domain/banking/accountTransaction/v2)" xmlns:ns10="[http://schema.intuit.com/domain/banking/businessBanking/v1](http://schema.intuit.com/domain/banking/businessBanking/v1)" xmlns:ns11="[http://schema.intuit.com/domain/banking/financialInfo/v2](http://schema.intuit.com/domain/banking/financialInfo/v2)" xmlns:ns12="[http://schema.intuit.com/domain/banking/Appcode/v2](http://schema.intuit.com/domain/banking/Appcode/v2)" xmlns:ns13="[http://schema.intuit.com/domain/banking/Segment/v2](http://schema.intuit.com/domain/banking/Segment/v2)" xmlns:ns14="[http://schema.intuit.com/domain/banking/plasticCard/v2](http://schema.intuit.com/domain/banking/plasticCard/v2)" xmlns:ns15="[http://schema.intuit.com/domain/banking/formattedAccountNumber/v2](http://schema.intuit.com/domain/banking/formattedAccountNumber/v2)" xmlns:ns16="[http://schema.intuit.com/domain/banking/fundingAccount/v2](http://schema.intuit.com/domain/banking/fundingAccount/v2)" xmlns:ns17="[http://schema.intuit.com/domain/banking/dbViewFICustomer/v1](http://schema.intuit.com/domain/banking/dbViewFICustomer/v1)" xmlns:ns18="[http://schema.intuit.com/domain/banking/transfer/v2](http://schema.intuit.com/domain/banking/transfer/v2)" xmlns:ns19="[http://schema.intuit.com/domain/banking/mobileMoney/v1](http://schema.intuit.com/domain/banking/mobileMoney/v1)" xmlns:ns20="[http://schema.intuit.com/domain/billpay/billPayment/v2](http://schema.intuit.com/domain/billpay/billPayment/v2)" xmlns:ns21="[http://schema.intuit.com/domain/banking/achId/v2](http://schema.intuit.com/domain/banking/achId/v2)" xmlns:ns22="[http://schema.intuit.com/domain/banking/image/v2](http://schema.intuit.com/domain/banking/image/v2)" xmlns:ns23="[http://schema.intuit.com/platform/integration/identity/authToken/v2](http://schema.intuit.com/platform/integration/identity/authToken/v2)" xmlns:ns24="[http://schema.intuit.com/fs/alternateCredentials/v2](http://schema.intuit.com/fs/alternateCredentials/v2)" xmlns:ns25="[http://schema.intuit.com/domain/banking/configuration/v2](http://schema.intuit.com/domain/banking/configuration/v2)" xmlns:ns26="[http://schema.intuit.com/domain/banking/batchProcessInfo/v2](http://schema.intuit.com/domain/banking/batchProcessInfo/v2)" xmlns:ns27="[http://schema.intuit.com/domain/banking/check/v2](http://schema.intuit.com/domain/banking/check/v2)" xmlns:ns28="[http://schema.intuit.com/domain/banking/entitlements/v2](http://schema.intuit.com/domain/banking/entitlements/v2)" xmlns:ns29="[http://schema.intuit.com/domain/banking/user/v1](http://schema.intuit.com/domain/banking/user/v1)">
    <ns8:account xmlns:xsi="[http://www.w3.org/2001/XMLSchema-instance](http://www.w3.org/2001/XMLSchema-instance)" xsi:type="ns8:DepositAccount">
        \<ns8:id>eGYPAgTpWZ437Xmh\_VYYumF7Uu8f8x0uihEPX2LbVxw</ns8:id>
        \<ns8:fiCustomerId>b33264360017b79e5102058009cfe704</ns8:fiCustomerId>
        \<ns8:fiId>05526</ns8:fiId>
        \<ns8:interfaceId>100099860-80000101-1</ns8:interfaceId>
        \<ns8:description>Business OFX Checking</ns8:description>
        \<ns8:nickName>Business OFX Checking</ns8:nickName>
        \<ns8:displayAccountNumber>\*0101</ns8:displayAccountNumber>
        \<ns8:accountNumber>
            \<ns8:hostValue>80000101</ns8:hostValue>
            \<ns8:displayValue>80000101</ns8:displayValue>
            \<ns8:pfmValue>80000101</ns8:pfmValue>
            \<ns8:rdcAccountValue>80000101</ns8:rdcAccountValue>
            \<ns8:rawHostValue>80000101</ns8:rawHostValue>
        </ns8:accountNumber>
        \<ns8:category>DEPOSIT</ns8:category>
        \<ns8:accountType>CHECKING</ns8:accountType>
        \<ns8:fiAccountType>
            \<ns8:type>1</ns8:type>
            \<ns8:rawType>1</ns8:rawType>
            \<ns8:description>Checking</ns8:description>
        </ns8:fiAccountType>
        \<ns8:displayPrimaryMemberNumber>\*9860</ns8:displayPrimaryMemberNumber>
        \<ns8:primaryHolderId>100099860</ns8:primaryHolderId>
        \<ns8:ownershipType>PRIMARY</ns8:ownershipType>
        \<ns8:balance>
            \<ns8:currentBalance>
                \<ns4:amount>4157683.43</ns4:amount>
            </ns8:currentBalance>
            \<ns8:availableBalance>
                \<ns4:amount>4157683.43</ns4:amount>
            </ns8:availableBalance>
        </ns8:balance>
        \<ns8:accountStatus>OPEN</ns8:accountStatus>
        \<ns8:accountStatuses>
            \<ns8:open>true</ns8:open>
            \<ns8:closed>false</ns8:closed>
            \<ns8:negativeBalance>false</ns8:negativeBalance>
            \<ns8:delinquent>false</ns8:delinquent>
            \<ns8:inCollection>false</ns8:inCollection>
            \<ns8:overLimit>false</ns8:overLimit>
            \<ns8:writtenOff>false</ns8:writtenOff>
            \<ns8:creditBalance>false</ns8:creditBalance>
            \<ns8:paymentCoupon>false</ns8:paymentCoupon>
            \<ns8:retirementPlan>false</ns8:retirementPlan>
            \<ns8:retPlanOwnedByDeceased>false</ns8:retPlanOwnedByDeceased>
        </ns8:accountStatuses>
        \<ns8:displayFlag>
            \<ns8:summary>true</ns8:summary>
            \<ns8:transferFrom>true</ns8:transferFrom>
            \<ns8:transferTo>true</ns8:transferTo>
            \<ns8:isHistoryEnabled>true</ns8:isHistoryEnabled>
            \<ns8:isHistoryEntitled>true</ns8:isHistoryEntitled>
        </ns8:displayFlag>
        \<ns8:routingNumber>222341234</ns8:routingNumber>
        \<ns8:interestRate>0.0</ns8:interestRate>
        \<ns8:interestYearToDate>
            \<ns4:amount>0.0</ns4:amount>
        </ns8:interestYearToDate>
        \<ns8:interestPriorYearToDate>
            \<ns4:amount>0.0</ns4:amount>
        </ns8:interestPriorYearToDate>
        \<ns8:enabled>true</ns8:enabled>
        \<ns8:accountHidden>false</ns8:accountHidden>
        \<ns8:memberNumber>100099860</ns8:memberNumber>
        \<ns8:ccAccountId>80000101^1^100099860</ns8:ccAccountId>
        \<ns8:accountStatusInt>0</ns8:accountStatusInt>
        \<ns8:micrNumber>800000022254</ns8:micrNumber>
        \<ns8:lastDepositAmount>
            \<ns4:amount>0.0</ns4:amount>
        </ns8:lastDepositAmount>
        \<ns8:dcBillPayAccountNumber>80000101</ns8:dcBillPayAccountNumber>
        \<ns8:accruedInterest>
            \<ns4:amount>0.0</ns4:amount>
        </ns8:accruedInterest>
        \<ns8:annualPercentageYield>0.0</ns8:annualPercentageYield>
    </ns8:account>
</ns8:Accounts>

Gets the digital banking profile information for a customer

‍Sample Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns5:FICustomer xmlns:ns2="[http://schema.intuit.com/domain/banking/financialInstitution/v2](http://schema.intuit.com/domain/banking/financialInstitution/v2)" xmlns:ns3="[http://schema.intuit.com/domain/banking/challengeQuestionInfo/v2](http://schema.intuit.com/domain/banking/challengeQuestionInfo/v2)" xmlns:ns4="[http://schema.intuit.com/fs/common/v2](http://schema.intuit.com/fs/common/v2)" xmlns:ns5="[http://schema.intuit.com/domain/banking/fiCustomer/v2](http://schema.intuit.com/domain/banking/fiCustomer/v2)" xmlns:ns6="[http://schema.intuit.com/domain/banking/preference/V2](http://schema.intuit.com/domain/banking/preference/V2)" xmlns:ns7="[http://schema.intuit.com/domain/banking/notification/v2](http://schema.intuit.com/domain/banking/notification/v2)" xmlns:ns8="[http://schema.intuit.com/domain/banking/account/v2](http://schema.intuit.com/domain/banking/account/v2)" xmlns:ns9="[http://schema.intuit.com/domain/banking/accountTransaction/v2](http://schema.intuit.com/domain/banking/accountTransaction/v2)" xmlns:ns10="[http://schema.intuit.com/domain/banking/businessBanking/v1](http://schema.intuit.com/domain/banking/businessBanking/v1)" xmlns:ns11="[http://schema.intuit.com/domain/banking/financialInfo/v2](http://schema.intuit.com/domain/banking/financialInfo/v2)" xmlns:ns12="[http://schema.intuit.com/domain/banking/Appcode/v2](http://schema.intuit.com/domain/banking/Appcode/v2)" xmlns:ns13="[http://schema.intuit.com/domain/banking/Segment/v2](http://schema.intuit.com/domain/banking/Segment/v2)" xmlns:ns14="[http://schema.intuit.com/domain/banking/plasticCard/v2](http://schema.intuit.com/domain/banking/plasticCard/v2)" xmlns:ns15="[http://schema.intuit.com/domain/banking/formattedAccountNumber/v2](http://schema.intuit.com/domain/banking/formattedAccountNumber/v2)" xmlns:ns16="[http://schema.intuit.com/domain/banking/fundingAccount/v2](http://schema.intuit.com/domain/banking/fundingAccount/v2)" xmlns:ns17="[http://schema.intuit.com/domain/banking/dbViewFICustomer/v1](http://schema.intuit.com/domain/banking/dbViewFICustomer/v1)" xmlns:ns18="[http://schema.intuit.com/domain/banking/transfer/v2](http://schema.intuit.com/domain/banking/transfer/v2)" xmlns:ns19="[http://schema.intuit.com/domain/banking/mobileMoney/v1](http://schema.intuit.com/domain/banking/mobileMoney/v1)" xmlns:ns20="[http://schema.intuit.com/domain/billpay/billPayment/v2](http://schema.intuit.com/domain/billpay/billPayment/v2)" xmlns:ns21="[http://schema.intuit.com/domain/banking/achId/v2](http://schema.intuit.com/domain/banking/achId/v2)" xmlns:ns22="[http://schema.intuit.com/domain/banking/image/v2](http://schema.intuit.com/domain/banking/image/v2)" xmlns:ns23="[http://schema.intuit.com/platform/integration/identity/authToken/v2](http://schema.intuit.com/platform/integration/identity/authToken/v2)" xmlns:ns24="[http://schema.intuit.com/fs/alternateCredentials/v2](http://schema.intuit.com/fs/alternateCredentials/v2)" xmlns:ns25="[http://schema.intuit.com/domain/banking/configuration/v2](http://schema.intuit.com/domain/banking/configuration/v2)" xmlns:ns26="[http://schema.intuit.com/domain/banking/batchProcessInfo/v2](http://schema.intuit.com/domain/banking/batchProcessInfo/v2)" xmlns:ns27="[http://schema.intuit.com/domain/banking/check/v2](http://schema.intuit.com/domain/banking/check/v2)" xmlns:ns28="[http://schema.intuit.com/domain/banking/entitlements/v2](http://schema.intuit.com/domain/banking/entitlements/v2)" xmlns:ns29="[http://schema.intuit.com/domain/banking/user/v1](http://schema.intuit.com/domain/banking/user/v1)">
    \<ns5:id>b33264360017b79e5102058009cfe704</ns5:id>
    \<ns5:fiId>05526</ns5:fiId>
    \<ns5:name>Sam U Simulator</ns5:name>
    \<ns5:memberNumber>100099880</ns5:memberNumber>
    \<ns5:hostCredential>
        \<ns4:loginId>100099880</ns4:loginId>
    </ns5:hostCredential>
    \<ns5:person>
        \<ns4:contactInfo>
            \<ns4:emailAddress>abc.xyz@[candescent.com](http://candescent.com)</ns4:emailAddress>
            \<ns4:emailReminder>2018-06-25-07:00</ns4:emailReminder>
        </ns4:contactInfo>
    </ns5:person>
    \<ns5:channelInfos>
        \<ns5:channelInfo>
            \<ns5:channelType>WEB</ns5:channelType>
            \<ns5:credential>
                \<ns4:loginId>USP082</ns4:loginId>
            </ns5:credential>
            \<ns5:service>0</ns5:service>
            \<ns5:id>0</ns5:id>
            \<ns5:failedLoginCount>0</ns5:failedLoginCount>
            \<ns5:validLoginCount>0</ns5:validLoginCount>
            \<ns5:userStatus>
                \<ns5:limbo>false</ns5:limbo>
                \<ns5:active>true</ns5:active>
                \<ns5:newUser>false</ns5:newUser>
                \<ns5:onHold>false</ns5:onHold>
                \<ns5:reinitiated>false</ns5:reinitiated>
                \<ns5:locked>false</ns5:locked>
                \<ns5:acceptedDisclosure>true</ns5:acceptedDisclosure>
                \<ns5:appliedForBPElectronicRegistration>false</ns5:appliedForBPElectronicRegistration>
                \<ns5:needsToAcceptDisclosure>false</ns5:needsToAcceptDisclosure>
                \<ns5:mustChangePassword>false</ns5:mustChangePassword>
                \<ns5:invalidEmailId>false</ns5:invalidEmailId>
                \<ns5:mustChangeAltUserId>false</ns5:mustChangeAltUserId>
                \<ns5:needsToAcceptSecondaryDisclosure>false</ns5:needsToAcceptSecondaryDisclosure>
                \<ns5:bpFrontPageFalseBpPendingPaymentsTrue>false</ns5:bpFrontPageFalseBpPendingPaymentsTrue>
                \<ns5:adminApprovedIBRegistrationInMC>false</ns5:adminApprovedIBRegistrationInMC>
                \<ns5:fiApprovalPending>false</ns5:fiApprovalPending>
                \<ns5:reset>false</ns5:reset>
                \<ns5:mfaEnrolledCookie>false</ns5:mfaEnrolledCookie>
                \<ns5:mfaMandatory>false</ns5:mfaMandatory>
                \<ns5:mfaOptional>false</ns5:mfaOptional>
                \<ns5:inquiryOnly>false</ns5:inquiryOnly>
                \<ns5:bpOptOut>false</ns5:bpOptOut>
                \<ns5:smsMobileActivationConfirmed>false</ns5:smsMobileActivationConfirmed>
                \<ns5:smsMobileEnrolled>false</ns5:smsMobileEnrolled>
                \<ns5:issoUserEnrolled>false</ns5:issoUserEnrolled>
                \<ns5:resetIssoUserEnrolled>false</ns5:resetIssoUserEnrolled>
                \<ns5:entitlements>false</ns5:entitlements>
                \<ns5:emailMfaEnrolled>false</ns5:emailMfaEnrolled>
                \<ns5:uspEnrolled>false</ns5:uspEnrolled>
                \<ns5:temporaryPassword>false</ns5:temporaryPassword>
            </ns5:userStatus>
            \<ns5:lastLoginDate>2022-01-11-08:00</ns5:lastLoginDate>
            \<ns5:lastLoginDateTime>2022-01-11T15:26:13-08:00</ns5:lastLoginDateTime>
        </ns5:channelInfo>
    </ns5:channelInfos>
    \<ns5:billPayEnabled>false</ns5:billPayEnabled>
    \<ns5:memberRegistrationDate>2013-01-24-08:00</ns5:memberRegistrationDate>
    \<ns5:productUserInfo>
        \<ns5:productType>IB</ns5:productType>
    </ns5:productUserInfo>
    \<ns5:productAppUserInfos>
        \<ns5:productAppUserInfo>
            \<ns5:appCode>APISDK</ns5:appCode>
            \<ns5:lastActivityDate>2022-02-23-08:00</ns5:lastActivityDate>
        </ns5:productAppUserInfo>
        \<ns5:productAppUserInfo>
            \<ns5:appCode>onlineStatement</ns5:appCode>
            \<ns5:OSPaperStatement>true</ns5:OSPaperStatement>
            \<ns5:OSEmailReminder>false</ns5:OSEmailReminder>
            \<ns5:OSDisclosure>true</ns5:OSDisclosure>
            \<ns5:esignStatus>false</ns5:esignStatus>
            \<ns5:OSGroup>true</ns5:OSGroup>
        </ns5:productAppUserInfo>
        \<ns5:productAppUserInfo>
            \<ns5:appCode>QOL</ns5:appCode>
            \<ns5:statusCode>ACTIVE</ns5:statusCode>
            \<ns5:acceptedDisclosureDate>2014-01-16-08:00</ns5:acceptedDisclosureDate>
            \<ns5:lastActivityDate>2018-01-11-08:00</ns5:lastActivityDate>
            \<ns5:updateDateTime>2018-01-11T14:58:25-08:00</ns5:updateDateTime>
        </ns5:productAppUserInfo>
    </ns5:productAppUserInfos>
    \<ns5:lastSRTDateTime>2015-12-04T09:10:57-08:00</ns5:lastSRTDateTime>
    \<ns5:billPayRegStatus></ns5:billPayRegStatus>
</ns5:FICustomer>
close

Sign in now!

Please sign up or sign in to add to watchlist

Sign in

Don’t have an account? 

Sign up
close

Added to watchlist!

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