Finicity Balance Analytics API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Balance Analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
1 operation
across 1 path,
and defines 89 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.
SecurityFreezeErrorMessage
object
3 properties
2 required
EndUserUrl
string
Reseller end user URL
ReportType
string
A report type. Possible values: voi voa voaHistory history voieTxVerify voieWithReport voieWithInterview voieWithStatement paystatement preQualVoa assetSummary…
ZipCode
string
A ZIP code
ReportCustomField
object
3 properties
VOIReportConstraintsOut
object
4 properties
NumericCustomerId
integer
A customer ID represented as a number. See Add Customer API for how to create a customer ID.
TransactionsReportConstraintsOut
object
6 properties
ConsumerId
string
A consumer ID. See Create Consumer API for how to create a consumer ID.
PayStatementData
object
Data to be included within the pay statement report
4 properties
1 required
EmailAddress
string
An email address
VOAIncomeReportIncomeFromDate
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…
UserType
string
Type of User, Allowed values Personal/Business
FindTransactionDescriptionMemo
string
A string to return transactions that have an exact match to Description/Memo. - Description/Memo - Found in the PDF report for reach transactions. - A combinat…
FindTransactionAmountTo
number
A decimal value to return transactions with amount less than or equal to findTransactionAmountTo. - If both findTransactionAmountFrom and findTransactionAmount…
Age
integer
Age is an optional parameter. This data is used to determine the age band the customer falls into.
GeoLocation
array
Geolocation array of objects;
ReportPin
string
A unique key returned per report for consumer Portal
TimeIntervalType
string
Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLYCALENDAR - MONTHLYROLL…
PayStatementReportConstraints
object
2 properties
1 required
VOAReportConstraintsOut
object
5 properties
AddressLine1
string
Address line 1
AnalyticsReportConstraints
object
4 properties
ReportAccountIds
array
An array of account IDs to be included in the report (all accounts will be included if not set)
PrequalificationReportConstraintsOut
object
4 properties
VOIEWithStatementData
object
4 properties
1 required
IncomeStreamConfidenceMinimum
integer
Include income streams in the report, based on the income stream's confidence score. For example, Use the value 50 to include only income streams with a confid…
MiddleName
string
The middle name of the account holder
StatementReportConstraints
object
2 properties
1 required
IncludePending
boolean
If pending transactions must be included
PhoneNumber
string
A phone number (max length 15).
ForesightAnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
6 properties
ErrorMessage
object
10 properties
1 required
GeoLocationItems
object
2 properties
SocialSecurityNumberLastDigits
string
Last 4 digits of a SSN
ReportCustomFields
array
The reportCustomFields parameter is used when experiences are associated with a credit decisioning report. Designate up to 5 custom fields that you'd like asso…
ShowNsf
boolean
Include the non-sufficient funds (NSF) summary JSON and the NSF summary PDF section in the report. Data included: Account Total number of NSF funds Days since…
AccountId
string
An account ID
PayrollDataRetrievalId
string
An ID to identify the data retrieved from the payroll providers for the report.
VOAWithIncomeReportConstraintsOut
object
7 properties
ReportRequestId
string
Finicity indicator to track all activity associated with this report
ExtractDeductions
boolean
Field to indicate whether to extract the deductions on all pay statements
EmploymentId
string
This is a Mastercard assigned ID to the employment record. It remains consistent for that employment record, even if the report is refreshed. It can be used to…
BusinessId
string
Unique identifier of the business
BusinessAddressLine1
string
A street address
VOIEWithTXVerifyReportConstraintsOut
object
5 properties
1 required
CashFlowReportConstraintsOut
object
5 properties
AnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
4 properties
FindTransactionAmountFrom
number
A decimal value to return transactions with amount greater than or equal to findTransactionAmountFrom. - If both findTransactionAmountFrom and findTransactionA…
LastName
string
The last name of the account holder
Income
integer
Income is an optional parameter. It is the dollar amount for the customer's annual household income and is used to determine the income band the customer falls…
TxVerifyInterview
object
2 properties
1 required
Country
string
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3).
VOETransactionsReportConstraintsOut
object
5 properties
PayrollDataOut
object
6 properties
ConsumerEndUser
object
Reseller end user information. This is populated only when the report requires a consumer record to be generated and the consumer object includes end user deta…
8 properties
6 required
FindTransactionConstraints
object
Parameters used to return transactions matching the given criteria. The presence of multiple parameters will be treated as an AND function.
4 properties
DisputeStatement
string
A consumer-provided statement describing the nature of an unresolved dispute. This field is populated only if a consumer dispute remains unresolved, and the co…
ReportStatus
string
A report generation status. Possible values: inProgress success failure
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
BusinessName
string
The name of a business
AnalyticsType
string
Analytics type. Allowed Values are benchmarking and forecasting.
ForesightAnalyticsReportConstraints
object
3 properties
VOIEWithInterviewData
object
4 properties
1 required
CustomerType
string
The type of customer ("active" or "testing" or "" for all types)
NumericAccountId
integer
An account ID represented as a number
ExtractDirectDeposit
boolean
Field to indicate whether to extract the direct deposits on all pay statements
PartnerName
string
Name of a Finicity partner
PayrollReportConstraintsOut
object
3 properties
1 required
VOIEReportConstraints
object
The request details from the report generation that were used to generate the report
2 properties
1 required
AnalyticsReportConstraintsOut
object
4 properties
FindTransactionCategory
array
An array of categories to return transactions with an exact match to the array of category. Limit of 10.
ConsumerDetails
object
Details about the consumer. Populated if the report requires a consumer record to be generated.
11 properties
ExtractEarnings
boolean
Field to indicate whether to extract the earnings on all pay statements
ReportTitle
string
Title of the report
BusinessAddressLine2
string
Address Line2, Apt/Unit Details
FirstName
string
The first name of the account holder
ReportId
string
A report ID
StatementData
object
2 properties
1 required
ReportAccountIdsString
string
A whitespace-separated list of account IDs to be included in the report (all accounts will be included if not set)
AnalyticsReportAck
10 required
BusinessDetails
object
Business details associated with a Payment Risk Insights report.
3 properties
2 required
ReportCreatedDate
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…
BaseReportAck
object
Properties shared by all generated reports
16 properties
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…
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
PayrollAccountId
string
The payrollAccountIds for the Credentialed Payroll accounts the consumer has connected. Will be used to constrain the report to only include the specified acco…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Finicity publishes across the network.
