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 Customers API

Enroll and manage customers

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 7 operations across 5 paths, and defines 24 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 5 paths 24 schemas 1 DELETE3 GET2 POST1 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 Customers 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 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 7

Enroll and manage customers

POST
/aggregation/v2/customers/testing
Add Testing Customer
AddTestingCustomer body → 201400401409
POST
/aggregation/v2/customers/active
Add Customer
AddCustomer body → 201400401409
GET
/aggregation/v1/customers
Get Customers
GetCustomers 5 params → 200400401404
GET
/aggregation/v1/customers/{customerId}/application
Get Customer With App Data by ID
GetCustomerWithAppData 1 param → 200400401404
GET
/aggregation/v1/customers/{customerId}
Get Customer by ID
GetCustomer 1 param → 200400401404
PUT
/aggregation/v1/customers/{customerId}
Modify Customer by ID
ModifyCustomer 1 param body → 204400401403409
DELETE
/aggregation/v1/customers/{customerId}
Delete Access to Customer by ID
DeleteCustomer 1 param → 204400401404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ErrorMessage (10 properties), Customer (9 properties), NewCustomer (6 properties), Customers (4 properties). Each schema is shown below with its type and property counts.

DisplayingResults
integer
The number of results returned
EmailAddress
string
An email address
DisputeStatementErrorMessage
object
3 properties 2 required
PhoneNumber
string
A phone number (max length 15).
ErrorMessage
object
10 properties 1 required
AccountId
string
An account ID
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…
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…
CustomerWithAppData
A finicity customer record with application info
8 required
FoundResults
integer
The total number of results matching search criteria
LastName
string
The last name of the account holder
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…
AssetId
string
An asset ID. Generated by Data Connect or by using the Store Customer Pay Statement API.
Customers
object
A list of customers
4 properties 3 required
NewCustomer
object
A new customer to be enrolled
6 properties 1 required
CustomerType
string
The type of customer ("active" or "testing" or "" for all types)
ApplicationName
string
The name of the application assigned to the customer
CreatedCustomer
object
A new customer that was just enrolled
3 properties 3 required
FirstName
string
The first name of the account holder
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.
CustomerUpdate
object
Represent an update to customer fields
2 properties
Customer
object
A finicity customer record
9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

finicity-customers-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 App Registration API
AE Profile APIs.io
Finicity Authentication API
AE Profile APIs.io
Finicity Balance Analytics API
AE Profile APIs.io
#Customers
← Back to F APIs
API Details
ID
finicity:finicity-customers-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-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/finicity-customers-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 Customers 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.