Finicity Connect 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 11
Across 11 paths, the API surfaces 11 operations — 1 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.
Connect 11
Allow customers to log into their financial institutions and grant Finicity authorization
POST
/connect/v2/generate
Generate Data Connect URL
GenerateConnectUrlbody→ 200400401
POST
/connect/v2/generate/lite
Generate Lite Data Connect URL
GenerateLiteConnectUrlbody→ 200400401
POST
/connect/v2/generate/fix
Generate Fix Data Connect URL
GenerateFixConnectUrlbody→ 200400401404
POST
/connect/v2/send/email
Send Data Connect Email
SendConnectEmailbody→ 200400401
POST
/connect/v2/generate/jointBorrower
Generate Data Connect URL - Joint Borrower
GenerateJointBorrowerConnectUrlbody→ 200400401
POST
/connect/v2/generate/microentry/verify
Account Validation Assistant User Verification of Microdeposits
VerifyMicroEntryMicrodepositbody→ 200400401
POST
/connect/generate/transfer/bill-pay-switch
Generate Connect Transfer URL for Bill Pay Switch
GenerateTransferBillPaySwitchUrlbody→ 200400401
POST
/connect/generate/transfer/deposit-switch
Generate Connect Transfer URL for Deposit Switch
GenerateTransferDepositSwitchUrlbody→ 200400401
POST
/connect/v2/send/email/jointBorrower
Send Data Connect Email - Joint Borrower
SendJointBorrowerConnectEmailbody→ 200400401
GET
/connect/experiences
Get Experience IDs
GetAllExperience2 params→ 200400404
POST
/connect/experiences/{experience_id}/duplicate
Duplicate Experience for Indirect Partner
CreateConnectExperience1 parambody→ 200400401
Schemas 56
The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are ConnectParameters (17 properties), ConnectEmailParameters (16 properties), ConnectJointBorrowerEmailParameters (14 properties), ConnectJointBorrowerParameters (13 properties). Each schema is shown below with its type and property counts.
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 properties2 required
ReportCustomField
object
3 properties
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…
Context
string
The context in which you are using the Data Connect link.
ConsumerId
string
A consumer ID. See Create Consumer API for how to create a consumer ID.
MicroEntryVerifyRequestParameter
object
9 properties
WebhookContentType
string
The content type the webhook events will be sent in. Supported types: "application/json" and "application/xml".
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.
EmailOptions
object
Configuration for the Data Connect email's sent to customers
8 properties1 required
BankAccount
object
Deposit Switch account
4 properties3 required
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.
ConsumerInfo
object
The SSN and date of birth of a consumer
2 properties1 required
InstitutionSettings
object
Advanced options for configuration of which institutions to display in. See [Institution Settings](https://developer.mastercard.com/open-finance-us/documentati…
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…
CreateExperience
object
1 property
BillPaySwitchIdentity
object
Identity information for the user. Mandatory when use case is BPS.
9 properties6 required
ErrorMessage
object
10 properties1 required
ReportCustomFields
array
The reportCustomFields parameter is used when experiences are associated with a credit decisioning report. Designate up to 5 custom fields that you'd like asso…
AccountId
string
An account ID
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.…
Borrower
object
4 properties3 required
Card
object
Structure of the user card
5 properties4 required
ConnectTransferDepositSwitchLink
object
contains url to launch connect session
1 property
ConnectEmailParameters
object
16 properties4 required
ConnectGenerateTransferBillPaySwitchParameters
object
10 properties5 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…
ConnectParameters
object
17 properties2 required
ConnectEmailUrl
object
2 properties2 required
WebhookData
object
Allows additional identifiable information to be inserted into the payload of connect webhook events. See: [Custom Webhooks](https://developer.mastercard.com/o…
InstitutionLoginId
string
An institution login ID (from the account record)
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…
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…
BankAccounts
array
List of customer accounts (one or more) for Deposit Switch.
SocialSecurityNumberNoHyphens
string
The consumer's full SSN without hyphens
ConnectLink
string
A generated Connect URL
ConnectJointBorrowerEmailParameters
object
14 properties4 required
ConnectUrl
object
A Connect URL object
1 property1 required
ConnectJointBorrowerParameters
object
13 properties2 required
WebhookHeaders
object
Allows additional identifiable information to be included as headers of connect webhook event. See: [Custom Webhooks](https://developer.mastercard.com/open-fin…
Error
object
A single error.
5 properties
IndirectPartnerRequest
object
1 property1 required
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.
BorrowerType
string
"primary" or "jointBorrower"
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…
Borrowers
array
(MVS) Array of borrowers to pass the primary and joint borrower's customer and consumer IDs
FixConnectParameters
object
13 properties3 required
LiteConnectParameters
object
13 properties3 required
ExternalIdentity
string
The identifier for your employee or branch.
NumericInstitutionId
integer
The ID of a financial institution, represented as a number
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…
TransferDepositSwitchParameters
object
12 properties3 required
ExternalTransferDetails
object
The context type.
2 properties2 required
CustomerId
string
A customer ID. See Add Customer API for how to create a customer ID.
Experiences
object
3 properties
ConnectTransferBillPaySwitchLink
object
contains url to launch connect session
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Connect 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.
