Critical upgrade to API gateway platform

ACTION REQUIRED - Migration activities go from 15 April 2025 to 15 August 2025

There is an upcoming change that will affect your connection to KeyBank API services. The Apigee API gateway platform is being upgraded to a more powerful platform that offers data security enhancements and autonomous controls for API services and applications.

Complete the following migration activities prior to August 15, 2025. These changes affect both Non-Production and Production environments. By August 15, 2025, the old host names with “keybank.com” are not available and the environment certificates with the old hostnames will not be valid.

Migration activities

  1. Add new certificates. Keep an eye out for a secure email with the attached certificates to add to your trust store.

  2. Update the URL paths by environment.

    ENVIRONMENTCURRENT PATHNEW PATH
    Non-Production (QV)https://partner-api-qv.keybank.comhttps://partner-api-qv.key.com
    Simulatorhttps://partner-api.keybank.comhttps://partner-api.key.com
    Productionhttps://partner-api.keybank.comhttps://partner-api.key.com
  3. If you are a webhook client, add this IP address to your current IP Allow List: 156.77.0.0/16. The webhook IP address works for all environments.

New element in error response

There is a new element that has been added to KeyBank error responses, Api-Url. This is in addition to the current error response and no other information changes.

Error response example

{
  "ErrorMessage": “Error received from backend service”,
  "TransactionId": "Transaction Id",
  "X-CorrelationId": "Overall system level transaction identifier",
  "TransactionTime": "DateTime",
  “Api-Url”: “Requested API url",
  "ServiceError": {
    “ConnectError”: “Error details due to connectivity between Apigee and backend/downstream”,
    “Error Details“: "Error message from backend/downstream"
   }
}

Coming up - NEXTGen Reporting API

There is a new version of the information reporting APIs. In Q2 of 2025, KeyBank's API Users will see the new NEXTGen Reporting API rollout. Replacing the Previous Day and Intraday APIs, the NEXTGen Reporting API provides real-time access to account information, balances, and transaction history. With these API functions, you can reconcile transactions, review account balances, treasury reporting, and get bank account information. Stay tuned!