How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Finicity

Finicity App Registration API

Register and assign apps to customers

Documentation Provider Profile APIs.io OpenAPI GitHub

Finicity App Registration API is one of 41 APIs that Finicity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include App Registration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 79 schemas. It is described by OpenAPI 3.2.0, at version 1.43.0.

Requests are made against a single base URL, https://api.finicity.com.

7 operations 7 paths 79 schemas 3 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.43.0
Base URL
https://api.finicity.com
Authentication
API Key, API Key
Contact
API Support
Resource Areas
1

Authentication & Security 2

Finicity App Registration 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 dashboard
  • FinicityAppToken — A token returned by the /authentication API

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

App Registration 7

Register and assign apps to customers

POST
/aggregation/v1/partners/applications
Register App
RegisterApp body → 201400401
PUT
/aggregation/v1/partners/applications/{preAppId}
Modify App Registration
ModifyAppRegistration 1 param body → 200400401404
GET
/aggregation/v2/partners/applicationsdeprecated
Get App Registration Status (Deprecated)
GetAppRegistrationStatus 8 params → 200400401404
GET
/applications
Get App Registration Details
getApplications 6 params → 200400401
GET
/applications/{application_id}/institutions
Get App Registration Status by Institution
getRegisteredInstitutions 4 params → 200400401404
PUT
/aggregation/v1/customers/{customerId}/applications/{applicationId}
Set Customer App ID
SetCustomerAppID 2 params → 200400401404
PUT
/aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/migration
Migrate Institution Login Accounts
MigrateInstitutionLoginAccounts 2 params → 200400401404

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are CustomerAccountDetail (128 properties), CustomerAccountPosition (35 properties), CustomerAccount (29 properties), Application (11 properties). Each schema is shown below with its type and property counts.

AuthorizationExpires
boolean
A Boolean flag that indicates whether the customer’s authorization period has a defined authorization end date.
InstitutionResponse
object
4 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…
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…
CustomerAccountMarketSegment
string
The market segment of the account. Possible values: personal, business
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…
AppStatus
object
Registration status details for the application
10 properties 6 required
DisplayingResults
integer
The number of results returned
CustomerAccountPosition
object
Details for investment account holdings
35 properties
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…
FinancialInstitution
object
5 properties
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…
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…
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…
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…
AddressLine2
string
Address line 2
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…
AddressLine1
string
Address line 1
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…
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…
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…
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…
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…
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…
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…
NumericPreAppId
integer
Identifier to track the application registration from the App Registration and Get App Registration Status APIs, represented as a number
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](…
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…
ErrorMessage
object
10 properties 1 required
AccountId
string
An account ID
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…
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…
App
object
List of applications
9 properties
FoundResults
integer
The total number of results matching search criteria
AggregationStatus
string
"pending" during account discovery, always "active" following successful account activation
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…
InstitutionLoginId
string
An institution login ID (from the account record)
AccountType
string
The list of supported account types. "checking": Standard checking "savings": Standard savings "cd": Certificates of deposit "moneyMarket": Money Market "credi…
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
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…
SecurityIdType
string
The security type. This field is related to the securityId field. Possible values: "CUSIP" "ISIN" "SEDOL" "SICC" "VALOR" "WKN"
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…
AuthorizationEndDate
integer
Authorization end date and time in epoch format (not used if AuthorizationExpires is false).
ApplicationResponse
object
4 properties
AppFinancialInstitutionStatus
object
The registration status fields for each specific OAuth financial institution
7 properties 5 required
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…
RegisteredApplication
object
2 properties 2 required
InstitutionId
string
The ID of a financial institution
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…
CustomerAccountParentAccountId
string
The assigned account ID for the account one level higher in the student loan account hierarchy
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…
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…
Name
string
The account name from the institution
PartnerId
string
Your Partner ID displayed in the [Developer Dashboard](https://developer.mastercard.com/account/log-in)
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
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…
AggregationStatusCode
integer
The status of the most recent aggregation attempt (see [Aggregation Status Codes](https://developer.mastercard.com/open-finance-us/documentation/products/manag…
CustomerAccounts
object
A list of customer accounts
1 property 1 required
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…
AuthorizationStartDate
integer
Authorization start date and time in epoch format.
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…
Currency
string
A currency code
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…
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…
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/…
AppStatuses
object
The response for the Get App Registration Status API returns an array of status objects.
5 properties 5 required
NumericInstitutionId
integer
The ID of a financial institution, represented as a number
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…
NumericInstitutionLoginId
integer
An institution login ID (from the account record), represented as a number
ApplicationName
string
The name of the application assigned to the customer
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…
PreAppId
string
Identifier to track the application registration from the App Registration and Get App Registration Status APIs
UnixDate
integer
A date in Unix epoch time (in seconds). See: [Handling Epoch Dates and Times](https://developer.mastercard.com/open-finance-us/documentation/errors/best-practi…
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
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…
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
DisplayPosition
integer
Display position of the account at the financial institution, "1" being the top listed account
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…
Application
object
11 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

finicity-app-registration-api-openapi.yml Raw ↑

Other APIs Finicity publishes across the network.

Finicity Connect
AE Profile APIs.io
Finicity Verification of Assets (VoA) API
AE Profile APIs.io
Finicity Verification of Income & Employment (VoIE) API
AE Profile APIs.io
Finicity Transaction Analysis (Cash Flow) API
AE Profile APIs.io
Finicity Payments (Account Validation) API
AE Profile APIs.io
Finicity Open Banking Data Access (FDX)
AE Profile APIs.io
Finicity Account Validation Assistance API
AE Profile APIs.io
Finicity Accounts API
AE Profile APIs.io
Finicity Accounts (Simple) API
AE Profile APIs.io
Finicity Authentication API
AE Profile APIs.io
Finicity Balance Analytics API
AE Profile APIs.io
Finicity Bank Statements API
AE Profile APIs.io
#App Registration
← Back to F APIs
API Details
ID
finicity:finicity-app-registration-api
Base URL
https://api.finicity.com
Docs
https://developer.mastercard.com/open-banking-us/documentation/
Provider
Finicity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=finicity-app-registration-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/finicity-app-registration-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Finicity App Registration 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.