Finicity Institutions API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Institutions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 6 paths,
and defines 67 schemas.
It is described by OpenAPI 3.2.0, at version 1.43.0.
Requests are made against a single base URL, https://api.finicity.com.
The identity and technical contract details declared by the specification.
InstitutionTransAgg_status
string
Beta Data - Can be ignored. Should use status field instead. The production status for the Transaction Aggregation product for the institution. - online - prod…
ZipCode
string
A ZIP code
CertifiedInstitutions
object
A list of financial institutions from the Get Certified Institutions API
5 properties
5 required
Rssd
integer
The RSSD ID is a unique identifier assigned to financial institutions by the Federal Reserve. While the length of the RSSD ID varies by institution, it cannot…
InstitutionUrlLogonApp
string
The URL of the institution's login page
InstitutionOverallStatus
string
Beta Data - Can be ignored. The overall status for the institution: - online - Connection is active, financial institution is available and functioning - offli…
DisplayingResults
integer
The number of results returned
InstitutionAddress
object
The address of a financial institution
6 properties
EmailAddress
string
An email address
InstitutionStateAgg_status
string
Beta Data - Can be ignored. Should use status field instead. The production status for the Statement Aggregation product for the institution. - online - produc…
InstitutionTransAgg
boolean
"true": The institution is certified for the Transaction Aggregation product "false": The institution is decertified for the Transaction Aggregation product
AddressLine2
string
Address line 2
ChildInstitution
object
4 properties
4 required
Institution
object
A financial institution
35 properties
12 required
InstitutionDisplayName
string
A version of the institution connection name that is more user friendly
AddressLine1
string
Address line 1
BillPayDataCertification
boolean
billPayData is certified
BrandingWrapper
object
1 property
1 required
InstitutionSpecialInstructions
array
Instructions given to the customer before they are sent to the institution website to login for OAuth institutions. Note: this helps the customer to provide th…
InstitutionStateAgg
boolean
"true": The institution is certified for the Statement Aggregation product "false": The institution is decertified for the Statement Aggregation product
PhoneNumber
string
A phone number (max length 15).
ErrorMessage
object
10 properties
1 required
AccountId
string
An account ID
RoutingNumberInteger
integer
Routing number
InstitutionClass
string
Institution's class
InstitutionVoa_status
string
Beta Data - Can be ignored. Should use status field instead. The production status for the VOA product for the institution. - online - product is functioning c…
FoundResults
integer
The total number of results matching search criteria
InstitutionOverallStatusTemp
string
Beta Data - Can be ignored. Should use status field instead. The overall status for the institution: - online - Connection is active, financial institution is…
InstitutionAha_status
string
Beta Data - Can be ignored. Should use status field instead. The production status for the Account History Aggregation product for the institution. - online -…
InstitutionTimeZone
string
The time zone of the institution.
InstitutionAccountOwner
boolean
"true": The institution is certified for the Account Owner product "false": The institution is decertified for the Account Owner product
InstitutionVoa
boolean
"true": The institution is certified for the VOA product "false": The institution is decertified for the VOA product
InstitutionUrlOnlineRegistration
string
Institution's signup page
InstitutionProductionStatus
object
7 properties
7 required
InstitutionName
string
The name of the institution
Country
string
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3).
InstitutionAch_status
string
Beta Data - Can be ignored. Should use status field instead. The production status for the ACH product for the institution. - online - product is functioning c…
InstitutionUrlForgotPassword
string
Institution's forgot password page
InstitutionStatus
string
Status for the institution: "online", "offline", "maintenance", "testing", "beta", "validated", "migrating"
PaymentInitiationCertification
boolean
Institution connection is certified for paymentInitiation
InstitutionVoi_status
string
Beta Data - Can be ignored. Should use status field instead. The production status for the VOI product for the institution. - online - product is functioning c…
MoreResultsAvailable
boolean
If the value of moreAvailable is "true", you can retrieve the next page of results by increasing the value of the start parameter in your next request:"...&sta…
InstitutionAvailableBalance
boolean
"true": The institution is certified for the Account Balance Check (ABC) product "false": The institution is decertified for the Account Balance Check (ABC) pr…
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
Institutions
object
A list of financial institutions from the Get Institutions API
5 properties
5 required
CertifiedInstitution
object
16 properties
4 required
InstitutionAch
boolean
"true": The institution is certified for the ACH product "false": The institution is decertified for the ACH product
Branding
object
All assets are SVGs so can be slightly resized without any issues.
5 properties
Currency
string
A currency code
InstitutionCountryCodes
array
StudentLoanDataCertification
boolean
"true": The institution is certified for the Student Loan Data product "false": The institution is decertified for the Student Loan Data product
NumericInstitutionId
integer
The ID of a financial institution, represented as a number
InstitutionVoi
boolean
"true": The institution is certified for the VOI product "false": The institution is decertified for the VOI product
InstitutionUrlHomeApp
string
The URL of the institution's primary home page
CertifiedInstitutionsWithRssd
object
A list of financial institutions from the Get Certified Institutions with RSSD API
5 properties
5 required
InstitutionSpecialText
string
Special instructions given to customers for login
InstitutionAccountTypeDescription
string
Values: Banking, Investments, Credit Cards/Accounts, Workplace Retirement, Mortgages and Loans, Insurance
InstitutionWrapper
object
1 property
1 required
InstitutionSpecialInstructionsTitle
string
The title of the special instructions, if one exists or is required.
LoanPaymentDetailCertification
boolean
"true": The institution is certified for the Loan Payment Detail product "false": The institution is decertified for the Loan Payment Detail product
InstitutionsWithRoutingNumber
object
List of institutions with matching routing numbers
43 properties
InstitutionAha
boolean
"true": The institution is certified for the Account History Aggregation product "false": The institution is decertified for the Account History Aggregation pr…
LiabilityDataCertification
boolean
liabilityData is certified
UnixDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
InstitutionOauthEnabled
boolean
"true": The institution is an OAuth connection "false": The institution isn't an OAuth connection
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Finicity publishes across the network.