Finicity Reports API
Fetch generated reports when ready
Finicity Reports API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 8 operations across 8 paths, and defines 223 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.
8 operations
8 paths
223 schemas
6 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Finicity Reports API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Finicity-App-Key (FinicityAppKey).
An API key is passed in the header as Finicity-App-Token (FinicityAppToken).
By default, every request must be authenticated.
FinicityAppKey— The "Finicity-App-Key" from the developer dashboardFinicityAppToken— A token returned by the /authentication API
Paths & Operations 8
Across 8 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Reports 8
Fetch generated reports when ready
POST
/decisioning/v1/reports/{reportId}/partners
Report Reissue
GET
/decisioning/v3/reports/{reportId}
Get Report by Report ID
GET
/decisioning/v3/customers/{customerId}/reports/{reportId}
Get Report by Customer
POST
/decisioning/v3/consumers/{consumerId}/reports/{reportId}deprecated
Get Report by Consumer
GET
/decisioning/reports/{reportId}
Get Report by Report ID
GET
/decisioning/v1/customers/{customerId}/reports
Get List of Reports by Customer
GET
/decisioning/v1/consumers/{consumerId}/reports
Get List of Reports by Consumer
GET
/decisioning/v1/partners/{partnerId}/billing/reseller
Get Billing Summary for Partner
Schemas 223
The contract defines 223 schemas that model the data the API accepts and returns. The most detailed are VOAReportAccount (21 properties), PayrollEmploymentRecord (19 properties), PrequalificationReportAccount (19 properties), VOIReportAccount (18 properties). Each schema is shown below with its type and property counts.
ReportCustomField
object
3 properties
VOIReportConstraintsOut
object
4 properties
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…
StatePeriod
object
Statistics for one period in the report of a StateAttribute.
11 properties
5 required
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…
AddressLine1
string
Address line 1
TransactionalAttribute
object
An attribute which represents some categorization/classification of transactions. Enumerates those identified transactions and reports aggregations of them ove…
4 properties
4 required
ReportAccountOwnerAddress
string
The mailing address of the account owner(s). If the owner information is not available, this field will not appear in the report. If the account has multiple o…
AccountAnalytics
object
Analytics calculated for one account in the report.
3 properties
3 required
CashFlowMonthlyCashFlowCreditSummaries
object
9 properties
9 required
VOIReportAccount
object
18 properties
VOIEWithStatementData
object
4 properties
1 required
PayStatEarningsCategorizationType
string
The categorization based on the earning line's description. Possible values: "bereavement" "bonus" "commission" "holiday" "jury duty" "overtime" "pension" "pto…
ForesightAnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
6 properties
ErrorMessage
object
10 properties
1 required
GeoLocationItems
object
2 properties
ReportWithFirstThirdParty
object
A report
9 required
AccountId
string
An account ID
ReportTransactionBase1
object
5 properties
3 required
AccountDetailsTxBased
object
ExtractDeductions
boolean
Field to indicate whether to extract the deductions on all pay statements
VOIEPaystubPayStatement
object
PayrollEmploymentHistoryVOIE
object
8 properties
6 required
BusinessId
string
Unique identifier of the business
BusinessAddressLine1
string
A street address
VOIEWithTXVerifyReportConstraintsOut
object
5 properties
1 required
Report
object
A report
9 required
AnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
4 properties
ReportIncomeEstimate
object
4 properties
4 required
VOAReport
object
A VOA report
AFCashFlowAnalyticsReport
object
A Cash Flow Analytics Report
StatementReport
object
A Statement report
DirectDeposit
object
7 properties
Country
string
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3).
CashFlowMonthlyCashFlowCharacteristicsSummaries
object
4 properties
4 required
VOIETXVerifyReportAccount
object
15 properties
6 required
ForesightAnalyticsFirstThirdPartyReport
object
A Foresight Analytics Report
AFPaymentHistoryAnalyticsReport
object
A Cash Flow Analytics Report
ReportAccountOwnerAsOfDate
integer
The ownerAsOfDate field is populated if the account owner information was retrieved from a prior report and will show the created date of that report. Reports…
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…
MonthlyIncome
object
Current estimated monthly pay for the employment. This is a mandatory field only for VOIE-payroll report type.
6 properties
1 required
ReportStatus
string
A report generation status. Possible values: inProgress success failure
PayStatementReport
object
A Pay Statement report
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
CashFlowCashFlowBalanceSummary
object
11 properties
10 required
ForesightAnalyticsReport
object
A Foresight Analytics Report
VOIETXVerifyReportIncomeStream
object
13 properties
6 required
PartnerName
string
Name of a Finicity partner
PurposeCode
string
FCRA required 2-digit Permissible Purpose Code, specifying the reason for retrieving this report.
AnalyticsReportsAccount
object
15 properties
6 required
Deductions
object
2 properties
2 required
NumericInstitutionId
integer
The ID of a financial institution, represented as a number
NetMonthly
object
3 properties
2 required
ConsumerDetails
object
Details about the consumer. Populated if the report requires a consumer record to be generated.
11 properties
AsOfDate
integer
The last time the payroll data was updated in the payroll provider's system
CashFlowCashFlowCreditSummary
object
7 properties
7 required
CashFlowMonthlyCashFlowCredits
object
9 properties
9 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…
CashFlowMonthlyCashFlowBalances
object
7 properties
6 required
ReportType
string
A report type. Possible values: voi voa voaHistory history voieTxVerify voieWithReport voieWithInterview voieWithStatement paystatement preQualVoa assetSummary…
CashFlowCashFlowCredit
object
7 properties
1 required
ZipCode
string
A ZIP code
PayStatementData
object
Data to be included within the pay statement report
4 properties
1 required
ForesightAnalyticsFirstThirdPartyReportAck
9 required
TransactionsReportAccount
object
Fields used for the Transaction History Report (CRA products)
11 properties
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.
PrequalificationReport
object
A Prequalification report
PayStatementReportConstraints
object
2 properties
1 required
TransactionalPeriod
object
Statistics for one period in the report of a TransactionalAttribute.
9 properties
3 required
PortfolioId
string
A unique identifier that will be consistent across all reports created for the same customer
AnnualIncome
object
7 properties
2 required
PrequalificationReportConstraintsOut
object
4 properties
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…
CashFlowCashFlowDebit
object
7 properties
1 required
IncludePending
boolean
If pending transactions must be included
PhoneNumber
string
A phone number (max length 15).
TimeIntervalTypeEnum
string
Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLYCALENDAR - MONTHLYROLL…
PaymentRiskInsightsReportAck
11 required
SocialSecurityNumberLastDigits
string
Last 4 digits of a SSN
VOIEPayrollReport
object
A VOIE Payroll report
AFBalanceAnalyticsReport
object
A Balance Analytics Report
CashFlowMonthlyCashFlowDebitSummaries
object
7 properties
7 required
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…
ReportStartDate
integer
The postedDate of the earliest transaction analyzed for the report. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://devel…
PayStat
object
7 properties
PaymentRiskInsightsReport
object
A Payment Risk Insights Report
StreamModel
object
Describes a history of repeated transactions between the same parties.
6 properties
6 required
ReportTransaction
object
TxVerifyInterview
object
2 properties
1 required
PayrollEmployeeAddress
object
4 properties
PayrollDataOut
object
6 properties
PayrollVOIEIncomeRecord
object
8 properties
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
CashFlowCashFlowBalance
object
11 properties
9 required
SortObject
object
Sorting information for the results
3 properties
BusinessName
string
The name of a business
ForesightAnalyticsReportConstraints
object
3 properties
VOAWithIncomeReportAccount
object
BillingResellerReport
object
Paginated billing report data for reseller partners
11 properties
CadenceDetails
object
3 properties
PayrollProviderName
string
The name of the provider who provides payroll data to payroll source
PayrollReportConstraintsOut
object
3 properties
1 required
AnalyticsReportConstraintsOut
object
4 properties
PayrollEmploymentHistoryVOE
object
7 properties
6 required
VOIEPaystubWithStatementPayStatement
object
ActiveStatus
string
Possible values: "ACTIVE", "INACTIVE"
Lender
object
1 property
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)
BusinessDetails
object
Business details associated with a Payment Risk Insights report.
3 properties
2 required
PayrollEmployeeRecord
object
5 properties
1 required
AccountCurrency
string
A currency code for account
BaseReportAck
object
Properties shared by all generated reports
16 properties
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
ReportTransactionNewTxBased
object
City
string
City
SecurityFreezeErrorMessage
object
3 properties
2 required
PageableObject
object
Pagination information for the request
6 properties
EndUserUrl
string
Reseller end user URL
ExternalCustomerId
string
External Customer ID is a unique identifier assigned to the customer by the data holder. This field allows you to map the customer (and transactions) back to y…
NumericCustomerId
integer
A customer ID represented as a number. See Add Customer API for how to create a customer ID.
ForesightAnalyticsReportFirstThirdPartyConstraints
BaseReportAckWithPortfolioId
Properties shared by all generated reports having a portfolio ID
PayrollEmployerAddress
object
4 properties
ReportSummary
object
8 properties
6 required
VOETransactionsReportIncomeStream
object
10 properties
9 required
ReportPin
string
A unique key returned per report for consumer Portal
ReportEndDate
integer
The postedDate of the latest transaction analyzed for the report. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://develop…
VOIEPaystubWithTXVerifyReport
object
A VOIE Paystub With TXVerify report
MiddleName
string
The middle name of the account holder
StatementReportConstraints
object
2 properties
1 required
Employee
object
6 properties
CashFlowPossibleLoanDepositsAccount
object
12 properties
11 required
VOEPayrollReport
object
A VOE Payroll report
PayrollDataRetrievalId
string
An ID to identify the data retrieved from the payroll providers for the report.
CashFlowMonthlyCashFlowBalanceSummaries
object
7 properties
6 required
CashFlowMonthlyCashFlowCharacteristics
object
4 properties
4 required
ReportStyle
string
A report style. Possible values are directAPIPayroll, credentialedPayroll, paystatement, voieWithInterview, voieWithStatement, voieWithReport
PayStatementForVoie
object
18 properties
7 required
CashFlowReportConstraintsOut
object
5 properties
ReportInstitution
object
4 properties
3 required
FindTransactionAmountFrom
number
A decimal value to return transactions with amount greater than or equal to findTransactionAmountFrom. - If both findTransactionAmountFrom and findTransactionA…
VOIReport
object
A VOI report
DirectPayStatements
object
5 properties
4 required
Deduction
object
5 properties
CashFlowCashFlowDebitSummary
object
7 properties
7 required
CashFlowCashFlowCharacteristic
object
9 properties
3 required
MainPayStatementFields
object
10 properties
2 required
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
VOAReportAccount
object
21 properties
VOIEWithInterviewData
object
4 properties
1 required
PayFrequency
string
The current pay frequency or how often a regular pay check is: Daily Weekly Bi-Weekly Semi-Monthly Monthly Quarterly Semi-Annual Annual Every 2.6 wks Every 4 w…
StateAttribute
object
An attribute which represents some state over time, such as a balance or a calculation, including derivatives, ratios, or projections. Reports the state over t…
2 properties
2 required
TransactionsReport
object
A Transactions report
NumericAccountId
integer
An account ID represented as a number
PayrollEmploymentRecord
object
19 properties
4 required
ForesightAnalyticsReportAck
11 required
VOIEReportConstraints
object
The request details from the report generation that were used to generate the report
2 properties
1 required
GseEnabled
boolean
Mastercard Open Finance internal use only to flag reports that should not be retrieved by the GSE's (Government-Sponsored Enterprise). This is a mandatory fiel…
ExtractEarnings
boolean
Field to indicate whether to extract the earnings on all pay statements
VOETransactionsReportAccount
object
10 properties
VOIReportIncomeStream
object
15 properties
7 required
Employer
object
6 properties
PaymentRiskInsightsReportData
object
Parameters supplied by the client requesting the analytics.
4 properties
1 required
ReportSummaries
object
1 property
1 required
AccountDetails
object
5 properties
CashFlowPossibleLoanDeposits
object
1 property
1 required
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…
EstimateInclusion
string
Possible values: "HIGH", "MODERATE", "LOW", "NO"
EmployerName
string
Name of the employer as stated by the employer in the payroll system
TransactionsReportConstraintsOut
object
6 properties
PaystubMonthlyIncomeRecord
object
4 properties
ConsumerId
string
A consumer ID. See Create Consumer API for how to create a consumer ID.
VOIEPaystubReport
object
A VOIE Paystub report
GeoLocation
array
Geolocation array of objects;
TimeIntervalType
string
Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLYCALENDAR - MONTHLYROLL…
VOAReportConstraintsOut
object
5 properties
PrequalificationReportAccount
object
19 properties
ReportAccountIds
array
An array of account IDs to be included in the report (all accounts will be included if not set)
ReportIncomeStreamSummary
object
5 properties
3 required
VOAIReportIncomeStream
object
A report income stream record
15 properties
7 required
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…
PaystubTxVerifyMonthlyIncomeRecord
object
6 properties
CustomerAnalytics
object
Analytics and attributes generated at a customer level
3 properties
3 required
ReportTransactionBase2
object
7 properties
Earnings
object
5 properties
2 required
ReportAccountOwnerName
string
The name(s) of the account owner(s). If the owner information is not available, this field will not appear in the report. If the account has multiple owners th…
VOETransactionsReport
object
A VOE Transactions report
VOAWithIncomeReportConstraintsOut
object
7 properties
TransactionId
integer
A transaction ID
ReportRequestId
string
Finicity indicator to track all activity associated with this report
CashFlowReport
object
A Cash Flow report
VOIEPayStatement
object
17 properties
ReportInstitutionAccount
object
An account record
BillingReport
object
Billing report details for a single report entry
15 properties
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…
StateTimeInterval
object
For a StateAttribute, describes a time interval type being reported and a list of periods generated according to that type.
2 properties
2 required
TransactionalTimeInterval
object
For a TransactionalAttribute, describes a time interval type being reported and a list of periods generated according to that type.
2 properties
2 required
CashFlowReportAccount
object
17 properties
VOETransactionsReportConstraintsOut
object
5 properties
CashFlowCashFlowCharacteristicsSummary
object
9 properties
7 required
CashFlowPossibleLoanDepositsInstitutions
object
4 properties
4 required
CashFlowMonthlycashflowDebits
object
7 properties
7 required
VOAWithIncomeReport
object
A VOA with income report
AnalyticsType
string
Analytics type. Allowed Values are benchmarking and forecasting.
ReportAccountPosition
object
8 properties
CustomerType
string
The type of customer ("active" or "testing" or "" for all types)
ExtractDirectDeposit
boolean
Field to indicate whether to extract the direct deposits on all pay statements
PaymentRiskInsightsReportConstraints
object
4 properties
FindTransactionCategory
array
An array of categories to return transactions with an exact match to the array of category. Limit of 10.
ReportTitle
string
Title of the report
BusinessAddressLine2
string
Address Line2, Apt/Unit Details
State
string
State
PayrollVOEIncomeRecord
object
1 property
FirstName
string
The first name of the account holder
ReportId
string
A report ID
AnalyticsReportAck
10 required
PrequalificationReportAssetSummary
object
6 properties
3 required
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…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Finicity 12
Other APIs Finicity publishes across the network.
Finicity Connect
Finicity Verification of Assets (VoA) API
Finicity Verification of Income & Employment (VoIE) API
Finicity Transaction Analysis (Cash Flow) API
Finicity Payments (Account Validation) API
Finicity Open Banking Data Access (FDX)
Finicity Account Validation Assistance API
Finicity Accounts API
Finicity Accounts (Simple) API
Finicity App Registration API
Finicity Authentication API
Finicity Balance Analytics API
#Reports
Where this information came from
This is an independent, third-party profile of Finicity Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.