Enhancements to Akoya service APIs (March 12, 2024)

Akoya is dedicated to improving our service APIs to allow more access and insight into the network. The Management API is no longer in beta, and a new, enhanced version of the API is coming soon. The Notifications API (in beta) has added a new feature for consent notifications. Read on for highlights of these new and upcoming enhancements and today’s launch of self-service credential generation.

Service credentials in the Hub

You can now generate your own credentials for Akoya service APIs through the Data Recipient Hub.

To generate credentials for the Management API or Notifications API in the Hub, go to the new My Company page and select the API Credentials tab. Click the appropriate API, accept the consent, and click Generate Credentials. Record and securely store the displayed credentials.


Credentials are not stored in the Hub

You must securely store your credentials on generation.

Once you have credentials, you’ll use them to get service tokens to use with Akoya service APIs such as the Management API or Notifications API.

For more information on using service tokens, see Service tokens.

Consent notifications

We’ve added an additional alert category to our Notifications API (beta). You may now receive a webhook notification when end-users have updated their consent through their bank’s website or portal. This feature is supported by many providers on the network.

This new enhancement to our Notifications services also includes a sneak peek of our upcoming Consent API with a GET Consent Grant endpoint. Keep an eye out for more information on what to expect in our Consent feature.

Upcoming enhancements to the App Management API

Management API v2

Akoya is working to make app subscriptions easier for you. To support upcoming changes to meet that goal, the Akoya App Management API will be releasing a new version.

What’s changing?

We’re simplifying app creation by automating the provider subscription process. We’re also updating our app creation endpoint to meet the register DCR (Dynamic Client Registration) and FDX endpoint specifications. This will allow easier integration for recipients who already have a DCR process.

Documentation and details for the new version will be shared soon!