Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

KeyCorp

KeyBank Account Information API

The Commercial Accounts Reporting API delivers real-time and historical account-level information for client-authorized commercial KeyBank accounts. It exposes operations to retrieve full account details and balances, search the list of accessible payment accounts, and query both prior-day (up to 180 days) and current-day transaction activity with paging. Requests require OAuth2 bearer tokens, client certificates, and an x-fapi-interaction-id UUID for traceability. Base host is https://partner-api.key.com with a QV sandbox at https://partner-api-qv.key.com.

Documentation Provider Profile APIs.io OpenAPI GitHub

KeyBank Account Information API is one of 10 APIs that KeyCorp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account Information, Commercial Banking, Reporting, and United States. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, organized into 2 resource areas, and defines 27 schemas. It is described by OpenAPI 3.1.0, at version 1.0.3.

Requests are made against 2 base URLs: https://partner-api-qv.key.com, https://partner-api.key.com.

4 operations 4 paths 27 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.3
Base URL
https://partner-api.key.com/commercial/accounts/v1
Contact
KeyBank Developer Support
Resource Areas
2

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. They span 2 resource areas: Account Information, Account Transactions. Each is listed below with its method, path, parameters, and response codes.

Account Information 2
GET
/commercial/accounts/v1/{accountId}
Retrieve account details
getAccount 6 params → 200206400401403406
GET
/commercial/accounts/v1/list
Search for accounts
searchForAccounts 6 params → 200400401403404406
Account Transactions 2
GET
/commercial/accounts/v1/{accountId}/transactions/previous
Search prior day account transactions
searchForPreviousDayAccountTransactionsV1 9 params → 200206400401403404406
GET
/commercial/accounts/v1/{accountId}/transactions/current
Search current day account transactions
searchForCurrentDayAccountTransactionsV1 7 params → 200400401403404406

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Transaction (12 properties), AccountDescriptor (4 properties), PageMetadata (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Account
object
Contains basic account information
Accounts
object
Paginated array of accounts
AccountWithDetails
object
Detailed information about an authorized client account. If the BalanceAsOfDate is provided, balance summary information is also returned.
AccountCategory
string
The account type for the transaction. Valid values: COMMERCIALACCOUNT
AccountDescriptor
object
Basic account information including the account category, GUID, and account number.
4 properties 1 required
Charsets
string
The supported character set for the content. UTF-8 contains the accepted Unicode character list for standard English and Latin characters.
CommercialAccount
object
Information related to the commercial account
CommercialBalance
object
A specific treasury management defined balance
3 properties
CommercialCode
object
Code for commercial transactions that retrieves the summary, account information, and related transaction codes from the treasury object. The code for a specif…
2 properties
CommercialTransaction
object
A transaction on a commercial account type.
ContentTypes
string
Types of supported document formats.
DateString
string
Date format based on ISO 8601 standards. Format: YYYY-MM-DD
Error
object
Contains details if there is an issue with the API or the account.
3 properties
FapiInteractionId
string
Universally unique identifier for this interaction, used across all API requests and responses. A valid ID must be 36 characters in length.
FiAttribute
object
Additional information provided by the client financial institution (FI). This information can be related addenda information and additional data related to th…
2 properties
HateoasLink
object
HATEOAS is 'Hypermedia As The Engine Of Application State,' a REST application constraint for URL addresses.
1 property 1 required
HateoasLinks
array
Array of hyperlinks associated with the call.
Identifier
string
Value for a unique identifier
LineItem
object
A line item within a transaction.
2 properties
PageMetadata
object
Page information based on the pagination controls and result set.
3 properties
PageMetadataLinks
object
Resource URLs for retrieving next or previous datasets.
2 properties
PaginatedArray
object
Page metadata and related URLs for the result set.
2 properties
Timestamp
string
Date and time format based on ISO 8601 standard. Format: 'YYYY-MM-DDThh:mm:ss.nnn
Transaction
object
Base entity for financial transactions
12 properties 1 required
TransactionStatus
string
The status of a transaction. Valid values: PENDING, POSTED
Transactions
object
Optionally paginated array of transactions
TreasuryManagementType
string
Identifies the source of the treasury management account. Valid values: BAI, BTRS, ISO, SWIFT

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keycorp-commercial-accounts-reporting-openapi.yml Raw ↑

Other APIs KeyCorp publishes across the network.

KeyBank ACH Origination API
AE Profile APIs.io
KeyBank Wire Transfer API
AE Profile APIs.io
KeyBank RTP Send Payment API
AE Profile APIs.io
KeyBank Account Validation API
AE Profile APIs.io
KeyBank ACH Inquiry API
AE Profile APIs.io
KeyBank Wire Inquiry API
AE Profile APIs.io
KeyBank RTP Inquiry API
AE Profile APIs.io
KeyBank Check Services API
AE Profile APIs.io
KeyBank Webhooks
AE Profile APIs.io
#Account Information#Commercial Banking#Reporting#United States
← Back to K APIs
API Details
ID
keycorp:account-information-api
Base URL
https://partner-api.key.com/commercial/accounts/v1
Docs
https://developer.key.com/docs/commercial/accounts
Provider
KeyCorp
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network