KeyBank Check Services API
The Check Services API manages stop payments and check image retrieval for commercial KeyBank accounts. It exposes operations to place a stop payment, list and retrieve check images, and a health check, letting treasury and accounts-payable teams control and audit paper and electronic check activity programmatically. Authenticated with OAuth2 bearer tokens and mutual TLS client certificates over https://partner-api.key.com, with a QV sandbox environment for integration testing.
KeyBank Check Services API is one of 10 APIs that KeyCorp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Check Services, Commercial Banking, Payments, and United States. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, organized into 3 resource areas, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.1.1.
Requests are made against 2 base URLs: https://partner-api-qv.key.com, https://partner-api.key.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
KeyBank Check Services API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Access token supplied in the Authorization header using the Bearer scheme (e.g. Authorization: Bearer {token}).
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. They span 3 resource areas: StopPayments, ImageCheck, HealthCheck. Each is listed below with its method, path, parameters, and response codes.
Place new stop payments
List check images
Verify you can connect to the API service.
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CheckImage (9 properties), StopPayments (8 properties), StopPaymentPlaceRequest (6 properties), Exception (6 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from KeyCorp 9
Other APIs KeyCorp publishes across the network.