The purpose of this documentation is to provide guidance to developers on the order in which they should call APIs for AllData® Aggregation from Fiserv. It also outlines the APIs to call for specific use cases and solutions. This information is meant for clients that do not use Fiserv widgets.
In all instances noted below, the client must first be created in the AllData system. Fiserv professional services team creates the client’s administrative account and whitelists the client’s IP address. Contact your professional services team member for additional support.
Each client will have a client ID and at least one home ID created in the AllData system. Some clients may choose to use multiple home IDs depending on different use cases. A client can provision multiple customers (users) under its home ID. A user may have more than one financial institution account under his or her profile.
For all use cases outlined below, the client must create a user profile using the CreateUser API. The user profile consists of the user ID, password, and several optional fields, including name, address, and so on.
Clients must follow the bootstrapping process to synchronize the Fiserv AllData connections directory on their end. This one-time process uses the GetFinancialInstInfo API. Clients can also periodically refresh to get the latest changes made by financial institutions. See the AllData Web Services API Specifications document for additional details.
A wide variety of organizations can benefit from bank account ownership verification, such as lenders (including mortgage lenders), ACH payment processors, e-commerce platforms and wealth management organizations.
This use case is necessary for a partner to verify the bank account ownership of its end users. This can be accomplished through AllData by exposing the following APIs that allow end users to connect to their financial institutions accounts using their login credentials.
Note: This series of APIs only validates that the user can log in and has ownership of the account. If the client requires routing and account numbers, see "Add payment account" below.
Balance verification is useful for lenders, ACH payment processors, e-commerce platforms and others. This use case is necessary for a client to verify the balance(s) of the account(s) linked to the consumer.
Adding a payment account is useful for organizations specializing in ACH money movement, which can include lenders (including mortgage lenders), e-commerce platforms and bill payment providers.
AllData can be used to add an ACH payment account of an end user after that account has been verified. The full account number and routing number must be collected for the account to be added as a payment account.
Transaction history is useful for any organization requiring insight into consumer account activity. AllData can be used to obtain the transaction history for a number of accounts including savings, checking, credit card, money market and investments.
Asset verification is useful for lenders, who often need to know the net worth of their borrowers.
AllData can be used to verify the assets held by an end user. These assets are grouped into categories including bank accounts, investment accounts, retirement accounts, home values and insurance policies.
Liability verification is useful for lenders because they often need to know the outstanding financial commitments of their borrowers.
AllData can be used to verify the liabilities of an end user. Liabilities are grouped into categories including credit cards, mortgages, loans and bills.
AllData PFM is used for partners who want to provide end users with budgeting tools, savings goals, statements (including bank statements and tax documents), forecasting, home values, and cash flow analysis.
AllData can be configured to categorize transactions.
All the APIs noted in the above use cases are applicable to PFM since PFM tools are typically used to provide a complete picture of an end user’s financial position. In addition to the APIs noted above, the following can also be applied to the PFM use case: