Finicity Aggregation (Accounts & Transactions) API
Consumer-permissioned account and transaction aggregation across banks, credit unions, cards, loans and investment accounts, delivering account details, balances and categorized transactions.
Finicity Aggregation (Accounts & Transactions) API is one of 7 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Aggregation, Account, and Transaction. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes 157 operations across 139 paths, organized into 35 resource areas, and defines 783 schemas. It is described by OpenAPI 3.0.3, at version 1.43.0.
Requests are made against a single base URL, https://api.finicity.com.
157 operations
139 paths
783 schemas
11 DELETE72 GET62 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Finicity Aggregation (Accounts & Transactions) 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 157
Across 139 paths, the API surfaces 157 operations — 11 DELETE, 72 GET, 62 POST, 12 PUT. They span 35 resource areas, including Authentication, Connect, Customers, Consumers, Accounts, Accounts (Simple), Transactions, Identity, and 27 more. Each is listed below with its method, path, parameters, and response codes.
Authentication 2
Generate authentication tokens and manage credentials
POST
/aggregation/v2/partners/authentication
Create Access Token
PUT
/aggregation/v2/partners/authentication
Modify Partner Secret
Connect 11
Allow customers to log into their financial institutions and grant Finicity authorization
POST
/connect/v2/generate
Generate Data Connect URL
POST
/connect/v2/generate/lite
Generate Lite Data Connect URL
POST
/connect/v2/generate/fix
Generate Fix Data Connect URL
POST
/connect/v2/send/email
Send Data Connect Email
POST
/connect/v2/generate/jointBorrower
Generate Data Connect URL - Joint Borrower
POST
/connect/v2/generate/microentry/verify
Account Validation Assistant User Verification of Microdeposits
POST
/connect/generate/transfer/bill-pay-switch
Generate Connect Transfer URL for Bill Pay Switch
POST
/connect/generate/transfer/deposit-switch
Generate Connect Transfer URL for Deposit Switch
POST
/connect/v2/send/email/jointBorrower
Send Data Connect Email - Joint Borrower
GET
/connect/experiences
Get Experience IDs
POST
/connect/experiences/{experience_id}/duplicate
Duplicate Experience for Indirect Partner
Customers 7
Enroll and manage customers
POST
/aggregation/v2/customers/testing
Add Testing Customer
POST
/aggregation/v2/customers/active
Add Customer
GET
/aggregation/v1/customers
Get Customers
GET
/aggregation/v1/customers/{customerId}/application
Get Customer With App Data by ID
GET
/aggregation/v1/customers/{customerId}
Get Customer by ID
PUT
/aggregation/v1/customers/{customerId}
Modify Customer by ID
DELETE
/aggregation/v1/customers/{customerId}
Delete Access to Customer by ID
Consumers 4
Create and manage consumers associated with customers in order to use report services
POST
/decisioning/v1/customers/{customerId}/consumer
Create Consumer for the Customer
GET
/decisioning/v1/customers/{customerId}/consumer
Get the Consumer Record for the Given Customer
GET
/decisioning/v1/consumers/{consumerId}
Get Consumer by ID
PUT
/decisioning/v1/consumers/{consumerId}
Modify Consumer by ID
Accounts 10
Fetch or refresh customer accounts
GET
/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts
Get Customer Accounts by Institution Login ID
POST
/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts
Refresh Customer Accounts by Institution Login ID
POST
/aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts
Refresh Customer Accounts by Institution Login ID for Data Access Tiers
DELETE
/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}
Delete Access to Customer Accounts by Institution Login ID
GET
/aggregation/v2/customers/{customerId}/accounts/{accountId}
Get Customer Account by ID
DELETE
/aggregation/v1/customers/{customerId}/accounts/{accountId}
Delete Access to Customer Account by ID
GET
/aggregation/v1/customers/{customerId}/accounts
Get Customer Accounts
POST
/aggregation/v1/customers/{customerId}/accounts
Refresh Customer Accounts
POST
/aggregation/v2/customers/{customerId}/accounts
Refresh Customer Accounts for Data Access Tiers
GET
/aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts
Get Customer Accounts by Institution ID
Accounts (Simple) 4
Fetch simple customer accounts
GET
/aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts/simple
Get Customer Accounts by Institution ID (Simple)
GET
/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts/simple
Get Customer Accounts by Institution Login ID (Simple)
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/simple
Get Customer Account by ID (Simple)
GET
/aggregation/v1/customers/{customerId}/accounts/simple
Get Customer Accounts (Simple)
Transactions 9
Fetch customer and account transactions and generate reports asynchronously
POST
/aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions/historic
Load Historic Transactions for Customer Account
GET
/aggregation/v3/customers/{customerId}/transactions
Get All Customer Transactions
GET
/aggregation/customers/{customerId}/transactions/{uniqueTransactionId}
Get Transaction by UniqueTransactionId
GET
/aggregation/v2/customers/{customerId}/transactions/{transactionId}
Get Customer Transaction by ID
GET
/aggregation/v4/customers/{customerId}/accounts/{accountId}/transactions
Get Customer Account Transactions
POST
/decisioning/v2/customers/{customerId}/transactions
Generate Transactions Report for the Customer
POST
/aggregation/customers/{customerId}/recurring-transactions
Get Recurring Transactions for Customer
POST
/aggregation/customers/{customerId}/transactions/refreshes
Trigger Customer Account Refresh
GET
/aggregation/customers/{customerId}/transactions/refreshes/{refreshId}
Get Customer Account Refresh Status
Identity 3
Match the request details to the Institution account holder details
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/owner
Get Account Owner
GET
/aggregation/v3/customers/{customerId}/accounts/{accountId}/owner
Get Account Owner Details
POST
/account-owner-verification-matchings/customers/{customerId}/accounts/{accountId}
Account Owner Match
Payment Success Indicator 6
Predict a transaction's likelihood to settle
POST
/payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators
Generate FCRA Payment Success Indicators
GET
/payments/customers/{customerId}/accounts/{accountId}/fcra-payment-success-indicators/{payRequestId}
Get FCRA Payment Success Indicators by Pay Request ID
POST
/payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators
Generate Non-FCRA Payment Success Indicators
GET
/payments/customers/{customerId}/accounts/{accountId}/payment-success-indicators/{payRequestId}
Get Non-FCRA Payment Success Indicators by Pay Request ID
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator/fcra
Get FCRA Payment Success Indicator (Legacy)
GET
/aggregation/v2/customers/{customerId}/accounts/{accountId}/payments/paymentIndicator
Get Non-FCRA Payment Success Indicator (Legacy)
App Registration 7
Register and assign apps to customers
POST
/aggregation/v1/partners/applications
Register App
PUT
/aggregation/v1/partners/applications/{preAppId}
Modify App Registration
GET
/aggregation/v2/partners/applicationsdeprecated
Get App Registration Status (Deprecated)
GET
/applications
Get App Registration Details
GET
/applications/{application_id}/institutions
Get App Registration Status by Institution
PUT
/aggregation/v1/customers/{customerId}/applications/{applicationId}
Set Customer App ID
PUT
/aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration
Migrate Institution Login Accounts
Institutions 6
Search and fetch financial institutions
GET
/institution/v2/certifiedInstitutions/rssd
Get Certified Institutions With RSSD
GET
/institution/v2/institutions
Get Institutions
GET
/institution/v2/certifiedInstitutions
Get Certified Institutions
GET
/institution/v2/institutions/{institutionId}
Get Institution by ID
GET
/institution/v2/institutions/{institutionId}/branding
Get Institution Branding by ID
GET
/institution/v1/institutions/routingNumber/{routing_number}
Get Institutions by Routing Number
Small Business Credit Analytics 2
Fetch merchant location matches and generate reports
GET
/decisioning/sbca/location-matches
Get Merchant Location Matches
POST
/decisioning/customers/{customerId}/sbca
Generate Small Business Credit Analytics Report
Verify Assets 4
Generate asset reports asynchronously
POST
/decisioning/v2/customers/{customerId}/voa
Generate VOA Report for the Customer
POST
/decisioning/v2/customers/{customerId}/voaHistory
Generate VOA With Income Report for the Customer
POST
/decisioning/v2/customers/{customerId}/preQualVoa
Generate Prequalification (CRA) Report for the Customer
POST
/decisioning/v2/customers/{customerId}/assetSummary
Generate Prequalification (Non-CRA) Report
Verify Income and Employment 7
Generate income and employment reports asynchronously
POST
/decisioning/v2/customers/{customerId}/voi
Generate VOI Report for the Customer
POST
/decisioning/v2/customers/{customerId}/voePayroll
Generate VOE - Payroll Report for the Customer
POST
/decisioning/v2/customers/{customerId}/voeTransactions
Generate VOE - Transactions Report for the Customer
POST
/decisioning/v2/customers/{customerId}/payStatement
Generate Pay Statement Report for the Customer
POST
/decisioning/v2/customers/{customerId}/voieTxVerify/withInterview
Generate VOIE Paystub (With TXVerify) Report for the Customer
POST
/decisioning/v2/customers/{customerId}/voieTxVerify/withStatement
Generate VOIE - Paystub Report for the Customer
POST
/decisioning/v2/customers/{customerId}/voiePayroll
Generate VOIE - Payroll Report for the Customer
Bank Statements 4
Fetch account statements and generate reports asynchronously
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/statement
Get Customer Account Statement
POST
/decisioning/v2/customers/{customerId}/statement
Generate Statement Report for Customer
GET
/aggregation/v3/customers/{customerId}/accounts/{accountId}/statement
Get Customer Account Multiple Statement Details
GET
/aggregation/v1/customers/{customerId}/assets/{assetId}
Get Asset by Customer and ID
Balance Analytics 1
Balance Analytics for businesses
POST
/decisioning/v2/customers/{customerId}/reports/balance-analytics/userTypes/{userType}
Generate Balance Analytics Report for the customer - Personal/Business
Cash Flow Analytics 1
Cash Flow Analytics for business
POST
/decisioning/v2/customers/{customerId}/reports/cashflow-analytics/userTypes/{userType}
Generate Cash Flow Analytics Report for the customer - Personal/Business
Payment History Report 1
Payment History Report for business
POST
/decisioning/customers/{customerId}/reports/payment-history/userTypes/business
Generate Payment History Report for the Customer - Business
Pay Statements 1
Upload pay statements
POST
/aggregation/v1/customers/{customerId}/payStatements
Store Customer Pay Statement
Payments 5
Fetch ACH details and account balances
GET
/aggregation/v2/customers/{customerId}/accounts/{accountId}/loanDetails
Get Loan Payment Details
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/details
Get Account ACH Details
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalance/live
Get Available Balance
GET
/aggregation/v1/customers/{customerId}/accounts/{accountId}/availableBalancedeprecated
Get Available Balance - Cached
GET
/aggregation/v3/customers/{customerId}/accounts/{accountId}/details
Get Account ACH Details with RTP/FedNow
Portfolios 3
Generate portfolios of the most recent reports
GET
/decisioning/v1/customers/{customerId}/portfolios/{portfolioId}
Get Portfolio by Customer and Portfolio
GET
/decisioning/v1/consumers/{consumerId}/portfolios/{portfolioId}
Get Portfolio by Consumer and Portfolio
GET
/decisioning/v1/portfolios/{portfolioId}
Get Portfolio by Portfolio ID
TxPush 4
Manage TxPush subscriptions
POST
/aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush
Subscribe to TxPush Notifications
DELETE
/aggregation/v1/customers/{customerId}/accounts/{accountId}/txpush
Disable TxPush Notifications
POST
/aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions
Create TxPush Test Transaction
DELETE
/aggregation/v1/customers/{customerId}/subscriptions/{subscriptionId}
Delete TxPush Subscription
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
Cash Flow 2
Generate cash flow reports asynchronously
POST
/decisioning/v2/customers/{customerId}/cashFlowBusiness
Generate Cash Flow Report for the Customer (Business)
POST
/decisioning/v2/customers/{customerId}/cashFlowPersonal
Generate Cash Flow Report for the Customer (Personal)
Account Validation Assistance 3
Micro entries and account verification
POST
/microentry/v1/customers/{customerId}
Initiate Micro Entries
POST
/microentry/v1/customers/{customerId}/accounts/{accountId}/amounts
Verify Micro Entries
GET
/microentry/v1/customers/{customerId}/accounts/{accountId}
Get Micro Entries Details
Third Party Access 3
Generate and manage access keys for other partners
POST
/aggregation/v1/partners/accessKey
Generate Third Party Access Key
PUT
/aggregation/v1/partners/accessKey/{consentReceiptId}
Update Third Party Access
DELETE
/aggregation/v1/partners/accessKey/{consentReceiptId}
Revoke Third Party Access
Customer Authorization Details 1
APIs to retrieve customer authorization details
GET
/customers/institution-logins/{institution_login_id}/authorization-details
Get Customer Authorization Details
Businesses API 4
Create and manage business associated with customers in order to use Balance Analytics or Cash Flow Analytics
POST
/business-services/customers/{customer_id}/businesses
Create a New Business for a Customer
GET
/business-services/customers/{customer_id}/businesses
Get Business for Customer
PUT
/business-services/businesses/{business_id}
Update Business by ID
GET
/business-services/businesses/{business_id}
Get Business by ID
Transfer 5
Fetch details of the deposit and bill pay switches
GET
/transfer/customers/{customer_id}/deposit-switches
Get Deposit Switches by Customer ID
GET
/transfer/externals/{external_id}/deposit-switches
Get Deposit Switches by External ID
GET
/transfer/customers/{customer_id}/deposit-switches/{switch_id}
Get Deposit Switch by ID
GET
/transfer/customers/{customer_id}/bill-pay-switches
Get Pay Switches by Customer ID
GET
/transfer/customers/{customer_id}/bill-pay-switches/{switch_id}
Get Pay Switch by ID
Webhook Subscription 12
APIs for Managing Partner Webhook Event Subscriptions
POST
/notification-subscriptions/webhooksdeprecated
Create Webhook Subscription
GET
/notification-subscriptions/webhooksdeprecated
List Webhook Subscriptions
GET
/notification-subscriptions/webhooks/{subscription_id}deprecated
Get Webhook Subscription Details
PUT
/notification-subscriptions/webhooks/{subscription_id}deprecated
Update Webhook Subscription
DELETE
/notification-subscriptions/webhooks/{subscription_id}deprecated
Delete Webhook Subscription
PUT
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}deprecated
Update Webhook Subscription Event
DELETE
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}deprecated
Delete Webhook Subscription Event
PUT
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}/statusdeprecated
Enable or Disable Webhook Subscription Event
GET
/notification-subscriptions/webhooks/eventsdeprecated
List Available Webhook Subscription Events
PUT
/notification-subscriptions/webhooks/{subscription_id}/statusdeprecated
Enable or Disable All Webhook Events Under a Given Webhook Subscription
GET
/notification-subscriptions/webhooks/{subscription_id}/test-subscriptionsdeprecated
Test Webhook Subscription Based on Subscription ID
GET
/notification-subscriptions/webhooks/{subscription_id}/events/{webhook_event_id}/test-subscriptionsdeprecated
Test Webhook Subscription Based on Subscription ID and Webhook Event ID
Connect Components 7
Allow customers to log into their financial institutions and grant Finicity authorization
POST
/connect-components/institutions/{institution_id}/oauth-urls
Create OAuth URL
POST
/connect-components/institutions/{institution_id}/login-forms
Create Login Form
POST
/connect-components/customers/{customer_id}/institution-login-ids/{institution_login_id}/reconnections
Initiate Reconnection
POST
/connect-components/configurations
Create Components Configuration
GET
/connect-components/configurations
Get All Configurations for Current Partner
GET
/connect-components/configurations/{configuration_id}
Get Configuration Details
DELETE
/connect-components/configurations/{configuration_id}
Delete Configuration
Transaction Data Enrichment 1
Enhance the transaction data set
POST
/data-enrichment/transactions
Performs Enrichment of the Provided Transactions
Consumer Foresight 3
Generate consumer foresight analytics reports
POST
/decisioning/customers/{customerId}/reports/payment-risk-insights/userTypes/{userType}
Generate Payment Risk Insights Report for the Customer
POST
/decisioning/customers/{customerId}/reports/foresight-analytics/userTypes/{userType}
Generate foresight analytics non-CRA report for the customer - Personal
POST
/decisioning/reports/foresight-analytics/userTypes/{userType}
Generate Non CRA Foresight Analytics Report Using 1st/3rd Party Transaction Data
Payment Enablement Bundle 2
Any or all of the Payments endpoints in one API call
GET
/aggregation/v1/paysuite/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts
Fetch all the requested field details using institution login ID
GET
/aggregation/v1/paysuite/customers/{customerId}/accounts/{accountId}
Fetch all the requested details using the account ID
Data Sharing Consent 4
Manage data sharing consents
GET
/data-sharing-consents
Get Customer Data Sharing Consents By Customer ID
GET
/data-sharing-consents/{consent_receipt_id}
Get Customer Data Sharing Consent By ID
DELETE
/data-sharing-consents/{consent_receipt_id}
Revoke Data Sharing Consent by ID
DELETE
/data-sharing-consents/{consent_receipt_id}/institutionLogins/{institution_login_id}
Revoke Data Sharing Consent for an Institution by Institution Login ID
Schemas 783
The contract defines 783 schemas that model the data the API accepts and returns. The most detailed are CustomerAccountDetail (128 properties), InstitutionsWithRoutingNumber (43 properties), Transaction (39 properties), AccountOwnerIdentityInsights (36 properties). Each schema is shown below with its type and property counts.
LocationMatches
object
SBCA location match response data
1 property
LocationDetail
object
A Location detail
8 properties
IdType
string
The identifier type for finding the merchant.
IdValue
string
The identifier value pertaining to the identifier type.
IndirectPartnerRequest
object
1 property
1 required
MatchRank
integer
The rank of the match compared to other potential matches.
MerchantName
string
Name of merchant.
StreetAddress
string
The full street address of the merchant.
PostalCode
string
The postal code in the merchant's address.
RecurringTransactionsDetails
object
Recurring transactions details
2 properties
CustomerRecurringTransactions
object
Recurring transactions for customer
2 properties
RecurringOutFlowTransaction
object
Debit recurring transaction stream.
12 properties
AccountIds
object
A list of account IDs
1 property
RecurringInFlowTransaction
object
Credit recurring transaction stream.
12 properties
AccountRecurringTransactions
object
Recurring transactions for each account
3 properties
GeoLocation
array
Geolocation array of objects;
GeoLocationItems
object
2 properties
AnalyticsType
string
Analytics type. Allowed Values are benchmarking and forecasting.
PaymentRiskInsightsReportData
object
Parameters supplied by the client requesting the analytics.
4 properties
1 required
ForesightAnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
6 properties
ForesightAnalyticsReportFirstThirdPartyConstraints
PaymentRiskInsightsReportConstraints
object
4 properties
ForesightAnalyticsReportConstraints
object
3 properties
GoldStandardErrorMessage
object
1 property
1 required
ServiceAgreement
object
An object that contains the language the terms and conditions were present in and the date the customer accepted the terms and conditions.
2 properties
2 required
ConfigurationId
string
Unique identifier of the configuration object
Configuration
object
Used to modify behavior during the login flow
4 properties
EventStreamId
string
Unique reference to the event stream used to send events to the SDK
FilterAccounts
array
An optional filter to apply during account activation with institutions that support legacy login forms.
AccountClassificationType
array
An optional filter to apply during account activation with institutions that support Oauth integration. Supported filters are: personal, business, and unknown.
AoRequired
boolean
When set to true, the user must explicitly permission Account Owner details at OAuth-supported institutions. If they do not, a [239] error is returned, and the…
NameScore
object
List of account owner Identity Insights
5 properties
1 required
AccountOwnerVerificationMatchingDetails
object
Owner of a customer account
14 properties
4 required
AccountOwnerVerificationMatchResults
object
2 properties
SingleLineAddress
string
A street address
AccountOwnerVerificationMatchingAddresses
array
List of addresses
AccountOwnerVerificationMatchingAddress
object
10 properties
AccountOwnerVerificationMatchingRequestName
object
4 properties
2 required
AccountOwnerVerificationMatchingRequestAddress
object
8 properties
AccountOwnerVerificationMatchingRequest
object
5 properties
1 required
BusinessList
array
BusinessId
string
Unique identifier of the business
Business
PhoneNumberFormat
object
2 properties
NewPhoneNumber
string
A phone number ([E.164](https://en.wikipedia.org/wiki/E.164) format) minLength: 7
Lender
object
1 property
NewBusiness
object
8 properties
4 required
ACHDetails
object
The routing and account number information to initiate ACH transfers
2 properties
2 required
AccountAnalytics
object
Analytics calculated for one account in the report.
3 properties
3 required
AccessToken
object
A temporary access token to be passed in the Finicity-App-Token HTTP header of all subsequent API requests
1 property
1 required
AccountDetails
object
5 properties
AccountDetailsTxBased
object
AccountId
string
An account ID
AccountNumberDisplay
string
Account identifier derived by Mastercard from the account number provided by the financial institution. The format varies depending on the institution. We reco…
AccountNumberLast4
string
The last 4 digits of the account number, derived by Mastercard from the account number provided by the financial institution. This is only returned for ACH-ena…
AccountOwner
object
Owner of a customer account
3 properties
2 required
AddressScore
object
9 properties
AccountOwnerVerificationAddress
object
Account owner address
10 properties
AccountOwnerAddress
object
Account owner address
9 properties
AccountOwnerAddresses
array
List of addresses
AccountOwnerDetails
object
Owner of a customer account
14 properties
3 required
AccountOwnerDocumentation
object
Account owner documentation
3 properties
AccountOwnerDocumentations
array
List of account owner documentation. Not currently available in the US region.
EmailScores
object
1 property
AccountOwnerVerificationMatchingEmails
array
List of emails
AccountOwnerVerificationMatchingEmail
object
Account owner email
4 properties
AccountOwnerEmail
object
Account owner email
3 properties
AccountOwnerEmailPrimary
boolean
The email is primary.
AccountOwnerEmailType
string
The account owner's email type. "Personal" "Business"
AccountOwnerEmails
array
List of emails
AccountOwnerHolders
object
1 property
1 required
AccountOwnerIdentityInsights
object
List of account owner Identity Insights
36 properties
AccountOwnerName
string
The full name of the account owner. Multiple account owners are returned in one string per the source data from the institution.
PhoneScores
object
1 property
AccountOwnerVerificationPhone
object
Consumer phone
4 properties
AccountOwnerPhone
object
Consumer phone
3 properties
AccountOwnerPhoneType
string
The account owner's phone type: "HOME" "BUSINESS" "CELL" "FAX"
AccountOwnerPhones
array
List of phones
AccountOwnerVerificationMatchingPhones
array
List of phones
AccountOwnerRelationshipType
string
The type of relationship to the account: "AUTHORIZEDUSER" "BUSINESS" "FORBENEFITOFPRIMARY" "FORBENEFITOFPRIMARYJOINTRESTRICTED" "FORBENEFITOFSECONDARY" "FORBEN…
AccountStatus
string
An account status
AccountType
string
The list of supported account types. "checking": Standard checking "savings": Standard savings "cd": Certificates of deposit "moneyMarket": Money Market "credi…
ActiveStatus
string
Possible values: "ACTIVE", "INACTIVE"
CountryCodeNumber
string
The country code digit representing the phone number for specific country
CountryCode
string
Two-letter ISO 3166-1 alpha-2 country code
NewAddress
object
6 properties
Address
string
A street address
AddressLine1
string
Address line 1
AddressLine2
string
Address line 2
AddressLine3
string
Address line 3
AddressToName
string
The match status between the input name and the queried entity. not-found match no-match
AddressType
string
The type of address location: "Business" "Home" "Mailing"
AddressValidityLevel
string
The most granular level to which the address could be validated. Ex. If the address was only valid to the city level (but not to the house level), it would ret…
ForesightAnalyticsReport
object
A Foresight Analytics Report
ForesightAnalyticsFirstThirdPartyReport
object
A Foresight Analytics Report
AFBalanceAnalyticsReport
object
A Balance Analytics Report
AFCashFlowAnalyticsReport
object
A Cash Flow Analytics Report
PaymentRiskInsightsReport
object
A Payment Risk Insights Report
AFPaymentHistoryAnalyticsReport
object
A Cash Flow Analytics Report
AggregationStatus
string
"pending" during account discovery, always "active" following successful account activation
CustomerAccountMultipleStatements
object
A list of customer account statements
1 property
1 required
AggregationStatusCode
integer
The status of the most recent aggregation attempt (see [Aggregation Status Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manag…
PaymentRiskInsightsReportAck
11 required
ForesightAnalyticsReportAck
11 required
ForesightAnalyticsFirstThirdPartyReportAck
9 required
AnalyticsReportAck
10 required
AnalyticsReportsAccount
object
15 properties
6 required
AnalyticsReportConstraints
object
4 properties
AnalyticsReportConstraintsOut
object
4 properties
AnalyticsReportData
object
Parameters supplied by the client requesting the analytics.
4 properties
AnnualIncome
object
7 properties
2 required
AppFinancialInstitutionStatus
object
The registration status fields for each specific OAuth financial institution
7 properties
5 required
AppRegistrationStatus
string
The status of an app registration request. "A" means approved. "P" means pending which is the status when initially submitted or when the app is modified and a…
AppStatus
object
Registration status details for the application
10 properties
6 required
App
object
List of applications
9 properties
ApplicationResponse
object
4 properties
CustomerAccountMultipleStatement
object
Statement represents the bank statements for a given customer's account
7 properties
2 required
AppStatuses
object
The response for the Get App Registration Status API returns an array of status objects.
5 properties
5 required
Description
string
Date range representing the period for when the statement data is generated.
DocumentDate
string
The date when the statement was generated.
Index
string
The index for the statement. This can range from 1 to 24 statement indexes.
Application
object
11 properties
11 required
ApplicationId
string
applicationId value returned from the Get App Registration Status API and the partner assign the customers to. This cannot be changed once set. Only applicable…
ApplicationName
string
The name of the application assigned to the customer
AsOfDate
integer
The last time the payroll data was updated in the payroll provider's system
Asset
object
An asset
1 property
1 required
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
AvailableBalance
object
8 properties
8 required
BalanceAnalyticsAccountResult
object
5 properties
4 required
BalanceAnalyticsBusinessSummary
object
Balance analytics summarized across all accounts in the report
3 properties
BalanceAnalyticsMetrics
object
Balance analytics metrics and calculations
15 properties
BalanceAnalyticsReport
object
Balance analytics report data as JSON
7 properties
3 required
BalanceAndCashFlowAnalyticsReportConstraints
object
Request parameters from the partner to control the customer accounts included in the report, and the length of time to report on.
2 properties
BaseReportAck
object
Properties shared by all generated reports
16 properties
BaseReportAckWithPortfolioId
Properties shared by all generated reports having a portfolio ID
Birthday
object
A birth date
3 properties
Borrower
object
4 properties
3 required
BorrowerType
string
"primary" or "jointBorrower"
Borrowers
array
(MVS) Array of borrowers to pass the primary and joint borrower's customer and consumer IDs
Branding
object
All assets are SVGs so can be slightly resized without any issues.
5 properties
BrandingWrapper
object
1 property
1 required
AFBusiness
object
2 properties
2 required
BusinessDetails
object
Business details associated with a Payment Risk Insights report.
3 properties
2 required
BusinessName
string
The name of a business
CadenceDetails
object
3 properties
CashFlowActivityDepositsCredits
object
3 properties
2 required
CashFlowActivityWithdrawalsDebits
object
3 properties
2 required
CashFlowAnalyticsAccountResult
object
5 properties
4 required
CashFlowAnalyticsBusinessSummary
object
Cash flow analytics summarized across all accounts in the report
3 properties
2 required
CashFlowAnalyticsMetrics
object
Cash flow analytics metrics and calculations
6 properties
CashFlowCashFlowBalance
object
11 properties
9 required
CashFlowCashFlowBalanceSummary
object
11 properties
10 required
CashFlowCashFlowCharacteristic
object
9 properties
3 required
CashFlowCashFlowCharacteristicsSummary
object
9 properties
7 required
CashFlowCashFlowCredit
object
7 properties
1 required
CashFlowCashFlowCreditSummary
object
7 properties
7 required
CashFlowCashFlowDebit
object
7 properties
1 required
CashFlowCashFlowDebitSummary
object
7 properties
7 required
CashFlowInflowAttributes
object
Inflow Attributes
7 properties
5 required
CashFlowInsufficientFundsFees
object
Non-Sufficient Fund Fees
3 properties
CashFlowMonthlyCashFlowBalanceSummaries
object
7 properties
6 required
CashFlowMonthlyCashFlowBalances
object
7 properties
6 required
CashFlowMonthlyCashFlowCharacteristics
object
4 properties
4 required
CashFlowMonthlyCashFlowCharacteristicsSummaries
object
4 properties
4 required
CashFlowMonthlyCashFlowCreditSummaries
object
9 properties
9 required
CashFlowMonthlyCashFlowCredits
object
9 properties
9 required
CashFlowMonthlyCashFlowDebitSummaries
object
7 properties
7 required
CashFlowMonthlycashflowDebits
object
7 properties
7 required
CashFlowNegativeTriggers
object
Transactions that may be warning signs of bad creditworthiness
1 property
CashFlowNumWeeksZeros
object
Weeks with zero transactions during the known history of the account
3 properties
3 required
CashFlowOutflowAttributes
object
Outflow attributes
7 properties
5 required
CashFlowPossibleLoanDeposits
object
1 property
1 required
CashFlowPossibleLoanDepositsAccount
object
12 properties
11 required
CashFlowPossibleLoanDepositsInstitutions
object
4 properties
4 required
CashFlowReport
object
A Cash Flow report
CashFlowReportAccount
object
17 properties
CashFlowReportAck
12 required
CashFlowReportConstraints
object
5 properties
CashFlowReportConstraintsOut
object
5 properties
CashFlowTransactionAnalyticsAttributes
object
Transaction Analytics Attributes
7 properties
3 required
Categories
string
The different categories for transactions. "ATM Fee" "Advertising" "Air Travel" "Alcohol & Bars" "Allowance" "Amusement" "Arts" "Auto & Transport" "Auto Insura…
Categorization
object
Categorization Record
8 properties
3 required
CertifiedInstitution
object
16 properties
4 required
CertifiedInstitutionsWithRssd
object
A list of financial institutions from the Get Certified Institutions with RSSD API
5 properties
5 required
CertifiedInstitutions
object
A list of financial institutions from the Get Certified Institutions API
5 properties
5 required
ChildInstitution
object
4 properties
4 required
City
string
City
ClassificationConfidenceScore
number
The confidence score 0 – 1.0 of the name classification.
ConnectEmailParameters
object
16 properties
4 required
ConnectEmailUrl
object
2 properties
2 required
ConnectFromDate
integer
The fromDate parameter is used when experiences are associated with a credit decisioning report and any other reports with transaction data. The value is in ep…
ConnectJointBorrowerEmailParameters
object
14 properties
4 required
ConnectJointBorrowerParameters
object
13 properties
2 required
ConnectLanguage
string
By default, the Data Connect application is in English. You don't need to pass this parameter unless you want to translate Data Connect into one of our support…
ConnectLink
string
A generated Connect URL
ConnectParameters
object
17 properties
2 required
ConnectUrl
object
A Connect URL object
1 property
1 required
ConnectTransferBillPaySwitchLink
object
contains url to launch connect session
1 property
ConnectTransferDepositSwitchLink
object
contains url to launch connect session
1 property
ConsentReceiptId
string
Third party access key receipt ID. Generated by generate third party access key API.
ConsumerDetails
object
Details about the consumer. Populated if the report requires a consumer record to be generated.
11 properties
Consumer
object
A Mastercard Open Finance consumer record
15 properties
13 required
ConsumerDateOfBirth
integer
The consumer's date of birth in Unix epoch time (in seconds). See: Handling Epoch Dates and Times. The timestamp should be set at the start of day of birth.
ConsumerId
string
A consumer ID. See Create Consumer API for how to create a consumer ID.
ConsumerInfo
object
The SSN and date of birth of a consumer
2 properties
1 required
ConsumerUpdate
object
12 properties
ConvertToRepayment
integer
(Student Loan) The date the loan enters into repayment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.masterc…
Country
string
Country code is Iso3166-1 Alpha-2 code and Alpha 3 standard (max length 3).
CreatedConsumer
object
A consumer that was just created
3 properties
CreatedCustomer
object
A new customer that was just enrolled
3 properties
3 required
CreatedTestTxPushTransaction
object
Response for TxPush test transaction
2 properties
2 required
Currency
string
A currency code
Customer
object
A finicity customer record
9 properties
4 required
CompositeScore
integer
A risk score from 0-100 that indicates the likelihood of return risk, where a higher score indicates a higher likelihood of settlement or lower likelihood of r…
CustomerAccount
object
An account represents a bank account such as a checking or savings that the customer has added via the Connect interface.
29 properties
12 required
CustomerAccountAggregationAttemptDate
integer
A timestamp showing the last aggregation attempt, whether successful or not. This will not be present until you have run your first aggregation for the account…
CustomerAccountAggregationSuccessDate
integer
A timestamp showing the last successful aggregation of the account. This will not be present until you have run your first aggregation for the account. A date…
CustomerAccountBalanceDate
integer
A timestamp showing when the balance was captured by the FI. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.ma…
CustomerAccountCreatedDate
integer
A timestamp showing when the account record was created. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.master…
CustomerLastUpdatedDate
integer
A timestamp showing when the account was last modified. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.masterc…
CustomerAccountMarketSegment
string
The market segment of the account. Possible values: personal, business
CustomerAccountDetail
object
Additional customer account details. Not all data points will return for each account type. You can see the account type that each data point will return for i…
128 properties
CustomerAccountLastTransactionDate
integer
The date of the latest transaction on the account. This will not be present until you have run your first aggregation for the account. A date in Unix epoch tim…
CustomerAccountOldestTransactionDate
integer
The date of the oldest transaction in the transactions for the account. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://d…
CustomerAccountParentAccountId
string
The assigned account ID for the account one level higher in the student loan account hierarchy
CustomerAccountPosition
object
Details for investment account holdings
35 properties
CustomerAccountSimple
object
An account represents a bank account such as a checking or savings that the customer has added via the Connect interface.
19 properties
10 required
CustomerAccounts
object
A list of customer accounts
1 property
1 required
CustomerAccountsSimple
object
A list of accounts with basic information of a customer
1 property
1 required
CustomerAnalytics
object
Analytics and attributes generated at a customer level
3 properties
3 required
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
AuthorizationStartDate
integer
Authorization start date and time in epoch format.
AuthorizationEndDate
integer
Authorization end date and time in epoch format (not used if AuthorizationExpires is false).
AuthorizationExpires
boolean
A Boolean flag that indicates whether the customer’s authorization period has a defined authorization end date.
ExternalId
string
An external ID that was shared by the partner to distinguish switches. For example, BranchID.
CustomerType
string
The type of customer ("active" or "testing" or "" for all types)
CustomerUpdate
object
Represent an update to customer fields
2 properties
CustomerUsername
string
The customer's username, assigned by the partner (a unique identifier), following these rules: minimum 6 characters maximum 255 characters any mix of uppercase…
CustomerWithAppData
A finicity customer record with application info
8 required
Customers
object
A list of customers
4 properties
3 required
DateAsOf
integer
(All Account Types) Most recent date of the following information. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://develo…
DateTimeWithZone
string
A date-time with time zone
DecimalNumber
number
Decimal number
Deduction
object
5 properties
Deductions
object
2 properties
2 required
DirectDeposit
object
7 properties
DirectDeposits
object
4 properties
DirectPayStatements
object
5 properties
4 required
DisplayPosition
integer
Display position of the account at the financial institution, "1" being the top listed account
DisplayingResults
integer
The number of results returned
Earnings
object
5 properties
2 required
EmailAddress
string
An email address
EmailDomainCreationDate
string
Returns a date that the email domain was created.
EmailFirstSeenDays
number
Count of days since the email was first observed in Ekata's Identity Network. If the email has not been observed before, firstseendays will be 0.
EmailOptions
object
Configuration for the Data Connect email's sent to customers
8 properties
1 required
EmailToName
string
The match status between the input name and the queried entity. not found match no-match
EmailRisk
number
Email Risk Score assesses the risk level of an email address by leveraging features from our Identity Graph and Identity Network. It provides the strongest ind…
RequestRefId
string
The generated unique web transaction identifier.
EmailValid
boolean
True if the email address is valid.
Employee
object
6 properties
Employer
object
6 properties
EmployerName
string
Name of the employer as stated by the employer in the payroll system
ErrorMessage
object
10 properties
1 required
EstimateInclusion
string
Possible values: "HIGH", "MODERATE", "LOW", "NO"
ExpectedPayoffDate
integer
(Student Loan) The expected date of the payoff date. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard…
Card
object
Structure of the user card
5 properties
4 required
Experience
string
The experience field allows you to customize: Brand: color and logo Icon: displayed on the "Share your data" page Popular institutions: displayed on the Bank S…
TransferExperience
string
The experience field allows you to customize: To toggle landing screen visibility Note: the Finicity sales engineers (SE) help you set up a default experience…
ExtractDeductions
boolean
Field to indicate whether to extract the deductions on all pay statements
ExtractDirectDeposit
boolean
Field to indicate whether to extract the direct deposits on all pay statements
ExtractEarnings
boolean
Field to indicate whether to extract the earnings on all pay statements
FirstName
string
The first name of the account holder
FirstPaymentDate
integer
(Mortgage/Loan) First payment due date. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-fin…
FixConnectParameters
object
13 properties
3 required
FoundResults
integer
The total number of results matching search criteria
GovernmentId
string
A federal or state issued identification number in alphanumeric characters. Canada: Passport: 8 digits Driver: 6-9 digits
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…
IdentityRiskScore
number
Comprehensive identity risk score with a higher score indicating a riskier account sign-up.
Indicator
object
4 properties
4 required
IndicatorsByDay
array
An Array of 3-10 days, providing the potentialSettlementDate, compositeScore, scoreIndicator, and reasons.
PaymentSuccessIndicator
object
9 properties
7 required
ReasonItem
object
A collection of 8 reason codes, with a score ranging from 0-100, that explains the drivers that caused the score.
8 properties
8 required
PotentialSettlementDate
string
The date for all days included in the response.
SettleByDate
string
The expected date that the funds, from the consumer’s account, will be moved to the receiving account. settleByDate in ISO 8601 date format (YYYY-MM-DD). settl…
PayRequestId
string
Unique identifier of the Payments request
PaymentSuccessIndicatorsTransactionAmount
number
The transaction amount
PaymentSuccessIndicatorsTransaction
object
An object containing the requested transaction info.
2 properties
2 required
PaymentSuccessIndicatorsAddress
object
The customer's address
6 properties
PaymentSuccessIndicatorsPhone
object
The phone information
2 properties
PaymentSuccessIndicatorsUser
object
The user's information
4 properties
PaymentSuccessIndicatorsProperties
object
Properties to request a Payment Success Indicator score
2 properties
1 required
FcraPaymentSuccessIndicators
object
A Payment Success Indicators score response, indicating how likely a transaction is to be returned. NSF and Unauthorized return risks are provided if the score…
8 properties
6 required
PaymentSuccessIndicators
object
A Payment Success Indicators score response, indicating how likely a transaction is to be returned. NSF and Unauthorized return risks are provided if the score…
8 properties
6 required
FcraNsfReturnRisk
object
The result or error occurred during the execution of the nsf return risk prediction
2 properties
NsfReturnRisk
object
The result or error occurred during the execution of the nsf return risk prediction
2 properties
FcraNsfReturnRiskResult
object
The successful result of the execution of the nsf return risk
3 properties
2 required
NsfReturnRiskResult
object
The successful result of the execution of the nsf return risk
2 properties
2 required
NsfDailyResults
array
An Array of 3-10 days, providing the potentialSettlementDate, score, indicator, and reasons.
NsfIndicator
object
4 properties
3 required
NsfReasonItem
object
A collection of 8 reason codes, with a score ranging from 0-100, that explains the drivers that caused the nsf score.
8 properties
8 required
UnauthorizedReturnRisk
object
The result or error occurred during the execution of the unauthorized return risk prediction
2 properties
StatementCloseDate
integer
(Mortgage/Loan) Date the statement closed. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://docs.finicity.com/endpoint-syn…
SettlementAmount
number
The transaction amount in USD $.
PayPurposeCode
string
The 2-digit code (1P) assigned to indicate the intended purpose. 1P represents the following permissible purpose: “Determine whether a consumers payment method…
IdentityRiskReasonCode
string
Reason code for the identity risk score. Must be exactly two uppercase letters.
DeviceRiskScore
number
Comprehensive risk score associated with a device, with a higher score indicating a riskier device. A number between 0 and 1.
DeviceType
string
The device type used to authorize your product or service.
DeviceBrowser
string
The name of the browser used to authorize your product or service.
DevicePlatform
string
The device platform used to authorize your product or service.
DevicePhoneEmailFirstSeen
integer
Days since the combination of device, phone, and email was first seen
DeviceBrowserIpTzDifference
integer
Time zone difference between device browser and IP location
DeviceIpEmailFirstSeen
integer
Days since the combination of device, IP, and email was first seen
DeviceInsightEvent
object
3 properties
DeviceRiskHistoryEvent
object
5 properties
UDID
string
The generated unique device identifier.
IncludePending
boolean
If pending transactions must be included
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…
InitialMlDate
integer
(Mortgage/Loan) Original date of loan. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-fina…
InitiatedMicroDeposit
object
5 properties
Institution
object
A financial institution
35 properties
12 required
InstitutionAccountOwner
boolean
"true": The institution is certified for the Account Owner product "false": The institution is decertified for the Account Owner product
InstitutionAch
boolean
"true": The institution is certified for the ACH product "false": The institution is decertified for the ACH product
InstitutionAddress
object
The address of a financial institution
6 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…
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…
InstitutionId
string
The ID of a financial institution
InstitutionLoginId
string
An institution login ID (from the account record)
InstitutionName
string
The name of the institution
InstitutionSettings
object
Advanced options for configuration of which institutions to display in. See [Institution Settings](https://developer.mastercard.com/open-finance-us/documentati…
InstitutionStateAgg
boolean
"true": The institution is certified for the Statement Aggregation product "false": The institution is decertified for the Statement Aggregation product
InstitutionTransAgg
boolean
"true": The institution is certified for the Transaction Aggregation product "false": The institution is decertified for the Transaction Aggregation product
InstitutionVoa
boolean
"true": The institution is certified for the VOA product "false": The institution is decertified for the VOA product
InstitutionVoi
boolean
"true": The institution is certified for the VOI product "false": The institution is decertified for the VOI product
InstitutionWrapper
object
1 property
1 required
InstitutionConnectionHealth
object
Health status and success rates for connection features.
15 properties
InstitutionProductionStatus
object
7 properties
7 required
Institutions
object
A list of financial institutions from the Get Institutions API
5 properties
5 required
InstitutionsWithRoutingNumber
object
List of institutions with matching routing numbers
43 properties
InstitutionResponse
object
4 properties
FinancialInstitution
object
5 properties
InsufficientFundsTransaction
object
5 properties
3 required
InvestmentTransactionTypes
string
Keywords in the description and memo fields were used to translate investment transactions into these types. Possible values: "cancel" "purchaseToClose" "purch…
IpAddressDistance
number
The distance (in miles) between the IP address and the physical address.
IpGeolocationCountryCode
string
The ISO-3166 alpha-2 country code associated with the geolocation of the IP address.
IpGeolocationSubdivision
string
More granular detail about the IP address location.
IpLastSeenDays
number
Count of days since the IP address was last observed in Ekata's Identity Network. If the IP address has not been observed before, IpLastSeenDays will be 0.
IpPhoneDistance
number
The distance (in miles) between the IP address and the closest physical address associated with the phone number.
EmailMailboxVelocity
number
The velocity of the mailbox.
EmailIsDisposable
boolean
True if the email address is from a disposable email service.
IpRisk
boolean
True if the IP address is considered risky, based on multiple IP data points and velocity calculations.
IpRiskScore
number
Comprehensive risk score associated with an IP address, with a higher score indicating a riskier IP address. A number between 0 and 1 rounded to three decimal…
isHostedInMobileApp
boolean
Indicates whether Data Connect is hosted in a web view / secure container of the partner mobile app. It is only required for NON SDK integrations.
IsWebView
boolean
"true": Indicates that the Data Connect Session will be displayed within a WebView. When the isWebView parameter is true the redirectUri parameter is required.…
LastName
string
The last name of the account holder
LastPaymentDate
integer
(Credit Card/Line Of Credit) The date of the last payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mast…
LastPaymentDueDate
integer
(Mortgage/Loan) Due date of last payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-f…
LastPaymentReceiveDate
integer
(Mortgage/Loan) The date of the last payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/op…
LiteConnectParameters
object
13 properties
3 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
LoanPaymentDetails
object
Loan payment details for a customer account
4 properties
3 required
LoanPaymentDetailsAccount
object
8 properties
4 required
LoanPaymentDetailsGroup
object
Group details
7 properties
5 required
LoanPaymentDetailsLoan
object
Loan details
6 properties
4 required
LoanStatusEndDate
integer
(Student Loan) The end date of the current status. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.c…
LoanStatusStartDate
integer
(Student Loan) The start date of the current status. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard…
MainPayStatementFields
object
10 properties
2 required
MarketSegment
string
Use case for requesting the consumer's data. Current supported enumerations are: Auto Background Credit Card Employment Government Identity KYC Mortgage Person…
MaturityDate
integer
(Checking/Savings/CD/MoneyMarket) Maturity date of account type. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://develope…
MicroDepositCallbackUrl
string
A callback URL where to receive micro deposit notifications
MicroDepositCount
integer
Count of micro entries
MicroDepositDetails
object
7 properties
MicroDepositInitiation
object
3 properties
1 required
MicroDepositStatus
string
The following values may be returned in the field of a status: "Pending" : Micro entries not yet deposited to customer's account "Completed": Micro entries dep…
MicroDepositStatusDescription
string
Micro entries status description
MicroDepositVerification
object
A list of amounts
1 property
1 required
MicroDepositVerificationError
object
2 properties
MicroEntryVerifyRequestParameter
object
9 properties
MiddleName
string
The middle name of the account holder
MonthlyIncome
object
Current estimated monthly pay for the employment. This is a mandatory field only for VOIE-payroll report type.
6 properties
1 required
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…
MoreResultsAvailableForTransactions
string
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…
Name
string
The account name from the institution
NameClassificationType
string
The classification of the account holder: "person / personal / home" "business" "other"
NetMonthly
object
3 properties
2 required
NewConsumer
object
A new consumer to be created. Along with the required fields, the following fields are conditionally required: 1. SSN & Birthday(DOB): - Either ssn or birthday…
12 properties
3 required
NewCustomer
object
A new customer to be enrolled
6 properties
1 required
MetaData
string
OBAO is a program that is being offered to Mastercard issuers where when the new account is issued a Mastercard Debit or Prepaid account. OBAO offered partners…
NextPaymentDate
integer
(Mortgage/Loan) Due date for the next payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/o…
NoZoneDateTime
string
A date-time without time zone
NumericAccountId
integer
An account ID represented as a number
NumericCustomerId
integer
A customer ID represented as a number. See Add Customer API for how to create a customer ID.
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…
NumericInstitutionId
integer
The ID of a financial institution, represented as a number
PaymentInitiationCertification
boolean
Institution connection is certified for paymentInitiation
BillPayDataCertification
boolean
billPayData is certified
LiabilityDataCertification
boolean
liabilityData is certified
InstitutionAccountTypeDescription
string
Values: Banking, Investments, Credit Cards/Accounts, Workplace Retirement, Mortgages and Loans, Insurance
InstitutionUrlHomeApp
string
The URL of the institution's primary home page
InstitutionUrlLogonApp
string
The URL of the institution's login page
InstitutionOauthEnabled
boolean
"true": The institution is an OAuth connection "false": The institution isn't an OAuth connection
InstitutionUrlForgotPassword
string
Institution's forgot password page
InstitutionUrlOnlineRegistration
string
Institution's signup page
InstitutionClass
string
Institution's class
InstitutionSpecialText
string
Special instructions given to customers for login
InstitutionTimeZone
string
The time zone of the institution.
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…
InstitutionSpecialInstructionsTitle
string
The title of the special instructions, if one exists or is required.
InstitutionStatus
string
Status for the institution: "online", "offline", "maintenance", "testing", "beta", "validated", "migrating"
InstitutionDisplayName
string
A version of the institution connection name that is more user friendly
InstitutionCountryCodes
array
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…
InstitutionOverallStatus
string
Beta Data - Can be ignored. The overall status for the institution: - online - Connection is active, financial institution is available and functioning - offli…
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…
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…
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…
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…
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…
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 -…
NumericInstitutionLoginId
integer
An institution login ID (from the account record), represented as a number
NumericPreAppId
integer
Identifier to track the application registration from the App Registration and Get App Registration Status APIs, represented as a number
ObbAccountDetails
object
Details of the account and financial institution
14 properties
3 required
ObbAccountOwner
object
Who is on record as the owner of the account. May be the business name, the business owner name, or otherwise.
2 properties
2 required
ObbAverageWeeklyBalance
object
4 properties
4 required
ObbCurrentReportRequestDetails
object
Requested attributes of the report
5 properties
3 required
ObbDailyBalance
object
3 properties
3 required
ObbDataAvailability
object
Availability of historical data at the time the report was requested
4 properties
2 required
ObbDateRangeAndAmount
object
4 properties
3 required
ObbDateRangeAndCount
object
4 properties
4 required
ObbErrorMessage
object
OBB Error response message
2 properties
2 required
ObbInstitution
object
Details of the financial institution this account is home to
4 properties
1 required
ObbNumWeeksAverageBalanceIncreasing
object
Report of average account balance week over week and count of weeks where the average balance increased
3 properties
3 required
ObbReportHeader
object
Details about the business the report is generated for and metadata about the report
8 properties
2 required
ObbWeekOfYear
object
3 properties
3 required
OpenDate
integer
(Checking/Savings/CD/MoneyMarket) Date when account was opened. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer…
OriginalMaturityDate
integer
(Mortgage/Loan) Original date of loan maturity. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/…
OriginalPayrollReportId
string
The report ID of the original payroll report for refresh use cases. If used, only the employment records from the original report will be included in the refre…
OutOfSchoolDate
integer
(Student Loan) The date the borrower graduated or dropped below half-time enrollment in school. A date in Unix epoch time (in seconds). See: [Handling Epoch Da…
PartnerCredentials
object
2 properties
2 required
PartnerCredentialsWithNewSecret
object
3 required
PartnerId
string
Your Partner ID displayed in the [Developer Dashboard](https://developer.mastercard.com/account/log-in)
DisputeStatementErrorMessage
object
3 properties
2 required
SecurityFreezeErrorMessage
object
3 properties
2 required
PartnerName
string
Name of a Finicity partner
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…
PayStat
object
7 properties
PayStatEarningsCategorizationType
string
The categorization based on the earning line's description. Possible values: "bereavement" "bonus" "commission" "holiday" "jury duty" "overtime" "pension" "pto…
PayStatement
object
A pay statement document and pay statement label
2 properties
2 required
PayStatementData
object
Data to be included within the pay statement report
4 properties
1 required
PayStatementReport
object
A Pay Statement report
PayStatementReportAck
A Pay Statement report being generated
13 required
PayStatementReportConstraints
object
2 properties
1 required
PayStatementsFromDate
integer
Limits the pay statement history in the VOIE - Payroll report income record. Pay statements are only included if the payDate of the statement is equal to or gr…
PaymentDueDate
integer
(Credit Card/Line Of Credit) Due date for the next payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mas…
PayoffAmountDate
integer
(Mortgage/Loan) Date of final payment. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-fina…
PayrollData
object
4 properties
PayrollDataOut
object
6 properties
PayrollDataRetrievalId
string
An ID to identify the data retrieved from the payroll providers for the report.
PayrollAggregatorResponseId
string
This is an internal ID to track the retrieval of data from the internal payroll aggregator service. This is not intended to be used by the client.
PayrollEmployeeAddress
object
4 properties
PayrollEmployeeRecord
object
5 properties
1 required
PayrollEmployerAddress
object
4 properties
PayrollProviderName
string
The name of the provider who provides payroll data to payroll source
PayrollEmploymentHistoryVOE
object
7 properties
6 required
PayrollEmploymentHistoryVOIE
object
8 properties
6 required
PayrollEmploymentRecord
object
19 properties
4 required
PayrollReportAck
A Payroll report being generated
13 required
PayrollReportConstraints
object
5 properties
1 required
PayrollReportConstraintsOut
object
3 properties
1 required
PayrollVOEIncomeRecord
object
1 property
PayrollVOIEIncomeRecord
object
8 properties
PaystubMonthlyIncomeRecord
object
4 properties
PaystubTxVerifyMonthlyIncomeRecord
object
6 properties
PeriodEndDate
integer
End date of period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentatio…
PeriodStartDate
integer
(Checking/Savings/CD/MoneyMarket) Start date of period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.masterc…
PhoneCarrier
string
The company that provides voice and/or data services for the phone number. Carriers are returned at the MVNO level.
PhoneCountry
string
Country calling code of the phone number as defined by ITU-T E.123 and E.164 international standards (max length 3)".
PhoneCountryCode
string
The ISO-3166 alpha-2 country code associated with the phone number.
PhoneEmailFirstSeenDays
number
Count of days since the combination of phone and email was first observed in Ekata's Identity Network. If that combination has not been observed before, phoneE…
PhoneLastSeenDays
number
Count of days since the phone was last observed in Ekata's Identity Network. If the phone has not been observed before, phoneLastSeenDays will be 0.
PhoneLineType
string
The line type of the phone number. landline - traditional wired phone line. fixed-voip - VoIP-based fixed line phones. mobile - wireless phone line. voicemail…
PhoneNumber
string
A phone number (max length 15).
PhoneToAddress
string
The match status between the input phone and the queried entity. match - Phone location matches input address line 1, address line 2, city, state, and postal c…
PhoneToName
string
The match status between the input name and the queried entity. not-found match no-match
PhoneValid
boolean
True if the phone number is valid.
PortfolioConsumer
object
7 properties
6 required
PortfolioId
string
A unique identifier that will be consistent across all reports created for the same customer
PortfolioReport
object
5 properties
5 required
PortfolioSummary
object
2 properties
2 required
PortfolioWithConsumerSummary
3 required
PreAppId
string
Identifier to track the application registration from the App Registration and Get App Registration Status APIs
PrequalificationReport
object
A Prequalification report
PrequalificationReportAccount
object
19 properties
PrequalificationReportAck
A Prequalification report being generated
13 required
PrequalificationReportAssetSummary
object
6 properties
3 required
PrequalificationReportConstraints
object
4 properties
PrequalificationReportConstraintsOut
object
4 properties
PurposeCode
string
FCRA required 2-digit Permissible Purpose Code, specifying the reason for retrieving this report.
RailType
string
The Rail (ACH / RTP) used for initiating bank deposit(s).
AutoVerifiedAccount
integer
This field stores an ID for the linked bank account to verify the microdeposits. It will have a value populated only when the microdeposits are auto verified s…
Receiver
object
5 properties
4 required
RedirectUri
string
The URL that customers will be redirected to after completing Finicity Connect. Required unless Data Connect is embedded inside our application (iframe). Requi…
RegisteredApplication
object
2 properties
2 required
RepaymentPlanEndDate
integer
(Student Loan) The end date of the current repayment plan. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mast…
RepaymentPlanStartDate
integer
(Student Loan) The start date of the current repayment plan. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.ma…
Report
object
A report
9 required
ReportWithFirstThirdParty
object
A report
9 required
ReportAccountIds
array
An array of account IDs to be included in the report (all accounts will be included if not set)
ReportAccountIdsString
string
A whitespace-separated list of account IDs to be included in the report (all accounts will be included if not set)
ReportCustomField
object
3 properties
BillingResellerReport
object
Paginated billing report data for reseller partners
11 properties
PageableObject
object
Pagination information for the request
6 properties
SortObject
object
Sorting information for the results
3 properties
BillingReport
object
Billing report details for a single report entry
15 properties
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…
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…
ReportId
string
A report ID
ReportIncomeEstimate
object
4 properties
4 required
ReportIncomeStreamSummary
object
5 properties
3 required
ReportInstitution
object
4 properties
3 required
ReportInstitutionAccount
object
An account record
ReportPin
string
A unique key returned per report for consumer Portal
AccountCurrency
string
A currency code for account
ReportRequestId
string
Finicity indicator to track all activity associated with this report
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…
ReportStatus
string
A report generation status. Possible values: inProgress success failure
ReportSummaries
object
1 property
1 required
ReportSummary
object
8 properties
6 required
ReportTitle
string
Title of the report
ReportTransactionBase1
object
5 properties
3 required
ReportTransactionBase2
object
7 properties
ReportTransaction
object
ReportTransactionNewTxBased
object
ReportAccountPosition
object
8 properties
ReportType
string
A report type. Possible values: voi voa voaHistory history voieTxVerify voieWithReport voieWithInterview voieWithStatement paystatement preQualVoa assetSummary…
SBCAReportType
string
A Small Business Credit Analytics Report type. Possible values: sbcaanalyticsnoncra sbcabenchmarksnoncra
RoutingNumber
string
Routing number of receiving bank
RoutingNumberInteger
integer
Routing number
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…
ScoreIndicator
string
scoreIndicator conveys the compositeScore, projecting 3 possible values: "Highly Likely to Settle", "Likely to Settle", and "Less Likely to Settle"
SecurityIdType
string
The security type. This field is related to the securityId field. Possible values: "CUSIP" "ISIN" "SEDOL" "SICC" "VALOR" "WKN"
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…
SingleUseUrl
boolean
"true": The URL link expires after a Data Connect session successfully completes. Note: when the singleUseUrl and the experience parameters are passed in the s…
SocialSecurityNumber
string
A full SSN with or without hyphens
SocialSecurityNumberLastDigits
string
Last 4 digits of a SSN
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…
SSNPayroll
string
The consumer's full SSN without hyphens. Only required for the Direct API Payroll solution, not required for the Credentialed Payroll solution.
SocialSecurityNumberNoHyphens
string
The consumer's full SSN without hyphens
State
string
State
StatementData
object
2 properties
1 required
StatementEndDate
integer
(Credit Card/Line Of Credit) End date of statement period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mast…
StatementReport
object
A Statement report
StatementReportAck
A Statement report being generated
13 required
StatementReportConstraints
object
2 properties
1 required
StatementStartDate
integer
(Credit Card/Line Of Credit) Start date of statement period. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.ma…
StatementType
string
Account statement types
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
StatePeriod
object
Statistics for one period in the report of a StateAttribute.
11 properties
5 required
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
StreamModel
object
Describes a history of repeated transactions between the same parties.
6 properties
6 required
StringUnixDate
string
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…
StudentLoanDataCertification
boolean
"true": The institution is certified for the Student Loan Data product "false": The institution is decertified for the Student Loan Data product
SubscriptionId
integer
ID of a TxPush subscription
SubscriptionRecord
object
TxPush subscription details
5 properties
5 required
SubscriptionType
string
A TxPush subscription type ("account" or "transaction")
Suffix
string
A generational or academic suffix
TaxId
string
Country specific tax ID associated with the customer. Canada: Social Insurance Number (SIM) or Numero d'assurance sociale (NAS) Format: 123-456-789
TestTxPushTransaction
object
A fake transaction for TxPush testing
5 properties
3 required
ThirdPartyAccessKeyData
object
An object representing the third party access key request customerId: This is recipient's customer identifier partnerId: This is recipient partner identifier t…
5 properties
4 required
ThirdPartyAccessKeyReceiptData
object
An object representing the third party access key receipt customerId: This is recipient's customerId represented as a pseudo identifier. accountId: This is the…
1 property
ThirdPartyAccessPeriod
object
Object which describes access validity
3 properties
3 required
ThirdPartyAccessPeriodTypes
string
Multiple types will be supported. Presently below types are supported. "timeframe": Specifies a timeframe bounded by a startTime and endTime. The startTime is…
ThirdPartyAccessProduct
object
Product for which access token to be generated
5 properties
3 required
ThirdPartyAccessProductTypes
string
Third party access token can be generated for the following product types: "moneyTransferDetails": Retrieve account details for money transfer "availableBalanc…
ThirdPartyAccessProof
object
An object representing a digital signature of the access key
3 properties
ThirdPartyAccessProvenance
object
Provenance regarding the calling client like clientFingerprint, ipAddress and token.
3 properties
ThirdPartyAccessReceipt
object
An object representing consent receipt
8 properties
ThirdPartyAccessReceiptData
object
An object representing consent access data
2 properties
TimeIntervalType
string
Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLYCALENDAR - MONTHLYROLL…
TimeIntervalTypeEnum
string
Possible values for strategies in which attributes may be aggregated and reported across varying time intervals. Allowed Values - MONTHLYCALENDAR - MONTHLYROLL…
Transaction
object
39 properties
7 required
TransactionCreatedDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was added to our platform. See: [Handling Epoch Dates and Times](ht…
TransactionDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it occurred. See: [Handling Epoch Dates and Times](https://developer.m…
TransactionEffectiveDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it became effective on an account by an institution. See: [Handling Ep…
TransactionFirstEffectiveDate
integer
A date in Unix epoch time (in seconds). Represents the first timestamp of the transaction recorded in the effectiveDate field. See: [Handling Epoch Dates and T…
TransactionId
integer
A transaction ID
TransactionOptionExpireDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction expiration date when it became expires on an account by an institution. See…
TransactionPostedDate
integer
A date in Unix epoch time (in seconds). Represents the timestamp of the transaction when it was posted or cleared by the institution. This value isn't required…
TransactionType
string
If provided by the institution, the following values may be returned in the field of a record: "atm" "cash" "check" "credit" "debit" "deposit" "directDebit" "d…
Transactions
object
A list of transactions
8 properties
7 required
DailyBalance
object
3 properties
3 required
Beginning
number
Beginning daily account balance
Ending
number
Ending daily account balance.
TransactionsFromDate
string
Value of the fromDate request parameter that generated this response. This date is in Unix epoch time (in seconds).
TransactionsReport
object
A Transactions report
TransactionsReportAccount
object
Fields used for the Transaction History Report (CRA products)
11 properties
TransactionsReportAck
A Transaction report being generated
13 required
TransactionsReportConstraints
object
5 properties
TransactionsReportConstraintsOut
object
6 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
FindTransactionAmountTo
number
A decimal value to return transactions with amount less than or equal to findTransactionAmountTo. - If both findTransactionAmountFrom and findTransactionAmount…
FindTransactionCategory
array
An array of categories to return transactions with an exact match to the array of category. Limit of 10.
FindTransactionAmountFrom
number
A decimal value to return transactions with amount greater than or equal to findTransactionAmountFrom. - If both findTransactionAmountFrom and findTransactionA…
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…
TransactionsToDate
string
Value of the toDate request parameter that generated this response. This date is in Unix epoch time (in seconds).
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
TransactionalPeriod
object
Statistics for one period in the report of a TransactionalAttribute.
9 properties
3 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
ConnectGenerateTransferBillPaySwitchParameters
object
10 properties
5 required
ExternalIdentity
string
The identifier for your employee or branch.
Context
string
The context in which you are using the Data Connect link.
ExternalTransferDetails
object
The context type.
2 properties
2 required
TransferDepositSwitchParameters
object
12 properties
3 required
TxPushCallbackUrl
string
A callback URL to receive TxPush notifications
TxPushSubscriptionParameters
object
1 property
1 required
TxPushSubscriptions
object
1 property
1 required
TxVerifyInterview
object
2 properties
1 required
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…
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…
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…
Age
integer
Age is an optional parameter. This data is used to determine the age band the customer falls into.
UserType
string
Type of User, Allowed values Personal/Business
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…
VOAIReportIncomeStream
object
A report income stream record
15 properties
7 required
VOAReport
object
A VOA report
VOAReportAccount
object
21 properties
VOAReportAck
A VOA report being generated
13 required
VOAReportConstraints
object
4 properties
VOAReportConstraintsOut
object
5 properties
VOAWithIncomeReport
object
A VOA with income report
VOAWithIncomeReportAccount
object
VOAWithIncomeReportAck
A VOA with income report being generated
13 required
VOAWithIncomeReportConstraints
object
6 properties
VOAWithIncomeReportConstraintsOut
object
7 properties
VOEPayrollReport
object
A VOE Payroll report
VOETransactionsReport
object
A VOE Transactions report
VOETransactionsReportAccount
object
10 properties
VOETransactionsReportAck
A VOE Transactions report being generated
13 required
VOETransactionsReportConstraints
object
5 properties
VOETransactionsReportConstraintsOut
object
5 properties
VOETransactionsReportIncomeStream
object
10 properties
9 required
VOIEPayStatement
object
17 properties
VOIEPayrollReport
object
A VOIE Payroll report
VOIEPaystubReport
object
A VOIE Paystub report
VOIEPaystubReportAck
object
A VOIE Paystub report being generated
13 required
PayStatementForVoie
object
18 properties
7 required
VOIEPaystubWithStatementPayStatement
object
VOIEPaystubPayStatement
object
VOIEPaystubWithTXVerifyReport
object
A VOIE Paystub With TXVerify report
VOIEPaystubWithTXVerifyReportAck
A VOIE Paystub With TXVerify report being generated
13 required
VOIEReportConstraints
object
The request details from the report generation that were used to generate the report
2 properties
1 required
VOIETXVerifyReportAccount
object
15 properties
6 required
VOIETXVerifyReportIncomeStream
object
13 properties
6 required
VOIEWithInterviewData
object
4 properties
1 required
VOIEWithStatementData
object
4 properties
1 required
VOIEWithTXVerifyReportConstraints
object
5 properties
1 required
VOIEWithTXVerifyReportConstraintsOut
object
5 properties
1 required
VOIReport
object
A VOI report
VOIReportAccount
object
18 properties
CustomerAuthorizationDetails
object
3 properties
3 required
VOIReportAck
A VOI report being generated
13 required
VOIReportConstraints
object
4 properties
VOIReportConstraintsOut
object
4 properties
VOIReportIncomeStream
object
15 properties
7 required
VerifiedMicroDeposit
object
2 properties
Warnings
string
An array containing warning messages. Warnings can be one of: Address: Input postal code was corrected Address: Input state corrected Email: Address is too lon…
Alerts
string
An alert generated when processing the request.
Webhook
string
The publicly available URL you want to be notified with events as the user progresses through the application. See [Connect Webhook Event](https://developer.ma…
WebhookContentType
string
The content type the webhook events will be sent in. Supported types: "application/json" and "application/xml".
WebhookData
object
Allows additional identifiable information to be inserted into the payload of connect webhook events. See: [Custom Webhooks](https://developer.mastercard.com/o…
WebhookHeaders
object
Allows additional identifiable information to be included as headers of connect webhook event. See: [Custom Webhooks](https://developer.mastercard.com/open-fin…
WithInsights
boolean
If Identity Insights data must be returned or not
Insights
boolean
If Identity Insights data must be returned or not
ZipCode
string
A ZIP code
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…
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…
ReportStyle
string
A report style. Possible values are directAPIPayroll, credentialedPayroll, paystatement, voieWithInterview, voieWithStatement, voieWithReport
PaymentInstructions
object
A list of payment instructions
1 property
PaymentInstruction
object
6 properties
2 required
Descriptor
object
2 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…
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…
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…
Experiences
object
3 properties
CreateExperience
object
1 property
EndUserUrl
string
Reseller end user URL
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
DepositSwitchesSummary
object
3 properties
2 required
ExternalDepositSwitchesSummary
object
2 properties
1 required
DepositSwitchDetails
object
10 properties
8 required
PaySwitchesSummary
object
3 properties
2 required
PaySwitchDetails
object
10 properties
8 required
AllowedBalanceCacheInterval
integer
Cache interval in minutes for available balance retrieval. If omitted, the default interval is 30 minutes. If 0, always fetch live balance. If greater than 0,…
BillPaySwitchIdentity
object
Identity information for the user. Mandatory when use case is BPS.
9 properties
6 required
BankAccounts
array
List of customer accounts (one or more) for Deposit Switch.
BankAccount
object
Deposit Switch account
4 properties
3 required
ErrorWrapper
object
A top level object for errors.
1 property
1 required
Errors
object
Object that contains the list of errors.
1 property
1 required
ErrorList
array
The list of errors.
Error
object
A single error.
5 properties
WebhookUrl
string
The webhook Url where the event notifications will be sent. The URL must be aligned with RFC 2396.
Status
string
The status of the event (e.g. active, inactive, pending, removed).
Condition
object
3 properties
1 required
WebhookEvent
object
3 properties
1 required
Event
object
5 properties
3 required
SubscriptionDetail
object
6 properties
5 required
Events
array
List of events for the subscription.
WebhookEvents
array
List of webhook subscription event.
CountResults
integer
The number of subscriptions currently displayed in the response.
OffsetResults
integer
The number of items you asked the start of the list to be offset.
LimitResults
integer
The number of items you asked the list to be limited.
TotalResults
integer
The total number of items in the collection.
Subscriptions
object
5 properties
5 required
AvailableEvent
object
3 properties
3 required
Subscription
object
Request body to create or update a subscription.
2 properties
1 required
EventStatusUpdate
object
1 property
1 required
LinkedAccountDate
integer
A timestamp showing when the customer first linked the account via Data Connect. A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](…
EnrichTransactionsPayload
object
Request body that contains transactions to be enriched.
1 property
1 required
TransactionPayload
object
16 properties
7 required
EnrichedTransactions
object
Request body that contains transactions to be enriched.
1 property
EnrichedTransaction
object
26 properties
AdditionalDetails
string
DESAddress
object
Address source of the transactions.
9 properties
Entities
array
Entities refer to the distinct parties involved in the transaction.
InputMerchantInformation
object
InputMerchantInformation is an object containing merchant details in the request body.
11 properties
ShowDailyBalance
boolean
Fields
string
Mention API fields that needs to be fetched
PaymentEnablementBundle
object
7 properties
3 required
ErrorCount
integer
The number of errors or failures that have occurred while processing the API request. If all the requested parameters are returned successfully then this value…
AccountCount
integer
Total number of accounts returned.
AccountIdentitySuccessCount
integer
Total number of successful sections returned when requesting accountIdentity. If not provided, value will be 0.
BalanceDetailsSuccessCount
integer
Total number of successful sections returned when requesting balanceDetails. If not provided, value will be 0.
PaymentInstructionSuccessCount
integer
Total number of successful sections returned when requesting paymentInstruction. If not provided, value will be 0.
PEBAccountDetails
object
10 properties
4 required
AccountSimpleDetails
object
15 properties
6 required
PaymentInstructionPEB
object
4 properties
2 required
FieldErrors
array
Lists of errors while getting the data
PebAllowedBalanceCacheInterval
integer
Time interval in minutes to check balance data against live balance from financial institution or from latest cached
FieldError
object
3 properties
3 required
AvailableBalancePEB
object
8 properties
7 required
PhoneNumberWithCountryCode
object
A phone number with corresponding country code.
2 properties
2 required
BusinessPersonallyLiable
boolean
Indicates whether a business owner is personally liable for a loan.
BusinessDetailsRequest
object
4 properties
4 required
LocationId
string
The unique identifier for the merchant location.
MetricType
string
The metric family or report type. Possible values are retailsalesanalytics, retailsalesbenchmarks
MetricFrequency
string
Frequency of the metric aggregation/reporting. Possible values are Monthly, Weekly.
HasConsent
boolean
Indicates that the merchant has provided explicit consent.
SBCAParams
object
Parameters for small business credit analytics metrics retrieval.
4 properties
4 required
SBCAMetricsReportConstraints
object
Request constraints required to create Small Business Credit Analytics report.
1 property
1 required
SBCAanalyticsReportData
object
Analytics reports data required to create business analytics.
2 properties
2 required
SBCAAnalyticsReport
object
A generated report for Small Business Credit Analytics. The report is enriched with retail sales analytics metrics.
12 properties
12 required
SBCABenchmarkReport
object
A generated report for Small Business Credit Analytics. The report is enriched with retail sales benchmark metrics.
12 properties
12 required
SBCAAnalyticsResponseData
array
Analytics response data for SBCA report. This will be present in the report for the report retailsalesanalytics.
SBCABenchmarkResponseData
array
Benchmark response data for SBCA report. This will be present in the report for the report retailsalesbenchmarks.
BusinessAddressLine1
string
A street address
BusinessAddressLine2
string
Address Line2, Apt/Unit Details
PortfolioSummaryForSinglePortfolio
object
A portfolio summary of a single portfolio report and consumer information
3 properties
3 required
FannieErrorMessage
object
4 properties
3 required
UniqueTransactionId
string
A globally unique transaction identifier derived from accountId and transactionId.
DataSharingConsentContext
string
Represents the context in which consent receipt was created. Possible values are 1. partner - User grants consent to access account data 2. crossPartner - User…
ConsentErrorMessage
object
8 properties
1 required
ConsentAccountId
string
A unique identifier of an account within the Mastercard Open Banking system.
ConsentCustomerId
string
A Mastercard Open Finance customer ID. See also: "Add Customer".
ConsentInstitutionLoginId
string
A unique identifier of the authentication session with the Financial Institution within the Mastercard Open Banking system.
DataSharingConsentReceipts
object
List of consent receipts
4 properties
4 required
DataSharingConsentReceipt
object
The consent receipt
15 properties
9 required
InstitutionInfo
object
Represents the institution which has data that the user consents to share
12 properties
8 required
InstitutionArrangementAccessPeriod
object
A period of time allowed for accessing the customer’s data for the particular institution. This information must be displayed to the customers in the consent a…
2 properties
2 required
InstitutionArrangementStatusDetails
object
Details of the Institution status.
2 properties
2 required
DataHandling
object
2 properties
2 required
ConsentAccountDetails
object
5 properties
2 required
DataScopes
array
List of data scopes requested or granted for this operation.
ConsentAccessPeriod
object
A period of time allowed for accessing the customer’s data granted by this consent. If the consent contains more than one institution arrangement, then this pe…
2 properties
2 required
ISODateTime
string
A date and time in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD). See also: [How do I handle Dates and Times?](https://developer.mastercard.com/open-finance-us/docu…
DisclosureDetails
object
2 properties
2 required
ConsentStatusDetails
object
Details on the status of the consent.
2 properties
2 required
TransactionRefreshRequestStatus
string
This is the request status, supported request statuses are: NEW INPROGRESS COMPLETED FAILED
TransactionRefreshMode
string
Specifies the type of transaction refresh to perform, defaults to 'standard'. Supported modes are, standard - Triggers a standard refresh. The system will fetc…
TransactionRefreshID
string
Unique identifier for refresh request
TransactionRefreshSuccessCount
integer
Total number of successful accounts refreshed.
TransactionRefreshFailedCount
integer
Total number of accounts failed to refresh.
InitiateNewTransactionRefresh
object
New transaction refresh request: Request must contain at least institutionLoginId OR accountIds If both are provided, accountIds takes preference "standard" is…
5 properties
TransactionRefreshInitiated
object
Transaction refresh response
9 properties
TransactionRefreshStatusDetails
object
Transaction refresh status
8 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Finicity 6
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)
#Aggregation#Account#Transaction
Where this information came from
This is an independent, third-party profile of Finicity Aggregation (Accounts & Transactions) 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.