My Apps

Viewing Your Apps
Registering Sandbox Apps
Request Production Access
Registering Production Apps
Provider Subscription Statuses
Search Apps
Export Subscription Data

Up to 10 sandbox apps allowed

You’re allowed to have up to 10 apps in the sandbox environment at a time.

Viewing Your Apps

The Hub organizes apps by environment. Click on the “Sandbox” or “Production” buttons to view apps in each environment.

View your sandbox apps by clicking the "Sandbox" button on the right side of the screen.

Onboarding required before registering apps in production

You must request production access and fill out the onboarding questionnaire before registering apps in production.

Registering Sandbox Apps

Click “Register sandbox app” to kick off the registration wizard. You’ll need to have the following information to complete registration:

Display name
Description
- a description of your app
Logo URL
- Consider using your full logo. Akoya uses this image for your consumer consent page. If you don’t have a dedicated app logo, you can use your company logo instead.
  - accepted width & height: 200px - 1080px (square or rectangular)
  - accepted file types: transparent PNG or JPG
  - maximum file size: 2 MB
Icon URL (optional)
- Consider using a sub-mark logo. We use this image as an avatar for your app in the Hub.
- accepted size: 40px - 200px (square)
- accepted file types: transparent PNG or JPG
- maximum file size: 2 MB
“Contact us” URL
- This is your company or app’s "Contact us" page.
Contact email address
- Emails from Akoya's support team regarding this app and any support cases will go to the address listed here. To ensure the correct parties receive these emails, consider using an email distribution list.
- Redirect URI(s)
- Separate multiple redirect URIs with commas.

Your new app will show up on the “My apps” page after registration is complete. The first time you view this page, a button will display to the right of the client secret field allowing you to download your credentials. This download button will only appear once. If you lose your client secret, you will have to reset it.

A sandbox app entity will appear, along with a randomly-generated client ID and placeholder redirect URI that you can modify later. See “Getting started” for more information about redirect URIs.

You gain access to all Akoya products in the sandbox environment.

Request Production Access

When you’re ready to move your first app into production, clicking the “Request production access” option in the left navigation bar triggers the onboarding questionnaire.

This form covers several topics, including:

Use cases
How your company consumes financial data
Actual and anticipated API call volume
Number of users supported
Technical readiness
Security controls

Form progress cannot be saved!

If you navigate away from the form before clicking the “Submit” button, you'll lose your progress. If desired, you can download a PDF copy of the form to pre-plan your answers.

Registering Production Apps

After Akoya grants you production access, the “Register a production app” button will be available in “My apps.” The process to register a new production app is similar to that of a sandbox app except that you also indicate which Akoya products you want the app to use.

The Account Info product is always included. See “Akoya Products” to learn more about Akoya's products and their use cases.

When you get to the last screen, you’ll notice a banner listing the total number of data providers.

The total data providers to be added will appear in a banner at the top of the screen.

We automatically initiate the registration process for all providers that support the products your app uses.

The connections tab will display the list of newly-processed subscribers with a “New” chip next to their names. This chip will remain visible for 7 days.

Once a provider processes your connection request, you’ll see a “Pending” chip in the “Status” column. Each provider has to approve your connection request before you can receive data.

A “processed” provider does not mean your connection is active

After processing, each provider needs to approve your connection request. The time frame varies by provider, but typically, a provider should approve your app within 5-10 business days at the latest.

Your app will auto-subscribe to any new providers we add to the network that support your app’s products.

Provider Subscription Statuses

Your app status will display next to the provider in the “Subscriptions” tab and may include the following:

Status	Description
Active	Your connection is enabled. This provider's data is available to this app.
Pending	Your subscription request is under review.
Processing	The provider is processing your subscription request..

Clicking on a provider will take you directly to that provider’s documentation and inventory page. The "Data Providers" section discusses this area further.

There, you can view specific documentation pertaining to that provider, organized into tabs.

Viewing/Modifying App Details

Changing App Name

If you need to change your app's name, submit a support ticket via the Support Center in the Hub.

The “Details” tab displays the following information and functionality:

App name (display name) [view]
Client ID [view]
Client secret [reset]
- We do not display client secrets for security reasons.
Akoya products [view]
- These are the Akoya products enabled for your application.
Redirect URI(s) [view, edit]
Description [view, edit]
Contact URL [view, edit]
Primary logo URL [view, edit]
Icon/avatar URL [view, edit]
Support email(s) [view, edit]
Creation date [view]

Resetting Your Client Secret

Resetting your secret cannot be undone

Resetting your client secret will invalidate all existing user refresh tokens. It will also require an update to your implementation.

Click the reset icon next to the "Client secret" line item.

You’ll receive a warning message about potential service disruption after the reset. A button appears, allowing you to download your new client secret. The screenshot shows a sandbox app, but the process is the same for a production app.

Resetting your client secret by clicking the reset icon at the right side of the screen. This is a disruptive action!

Modifying Your Redirect URI

If you’re adding multiple URIs, separate each one with a comma and click “Save.”

Edit your redirect URI(s) by clicking the pencil on the right side of the screen.

Separate multiple URIs with commas in the "Redirect URIs" field, then click the "Save" button.

Modifying Logo and Icon URLs

The "Registering sandbox apps" section discusses the app logo and icon requirements. Requirements for company and app logos/icons are the same.

Modifying Support Email(s)

Click the pencil icon next to “Support emails” to edit (near the bottom of the page).

Search Apps

Search for apps based on display name or client ID by entering a value in the search box at the top of the screen.

Search for a sandbox or production app by display name or client ID. Results will display in the window as you type.

Export Subscription Data

You can export a complete or filtered provider subscription list to CSV or JSON.

CSV Supported Fields

Field	Description
provider_name	Provider display name
provider_id	Unique provider ID
subscription_status	See the “Provider subscription statuses” table
supported_products	Akoya product(s) supported by the provider

JSON Supported Data Elements

Name	Data Type	Description
active	Array (Object)	Providers that are currently enabled for your app and the Akoya products each provider supports.
pending	Array (Object)	Provider subscriptions that are in pending status and the Akoya products each provider supports.
processing	Array (Object)	Provider subscriptions that are in processing status and the Akoya products each provider supports.
status.id	String	Unique provider ID
active.displayName	String	Provider display name
status.clusters	Array (Object)	All Akoya products the given provider supports
status.clusters.id	String	Unique ID of the given Akoya product
status.clusters.name	String	Akoya product name
status.clusters.description	String	Akoya product description
status.clusters.required	Boolean	Whether the provider must support the given product. Currently, only Account Info should be set to true.
status.subscriptionStatus	String	Provider subscription status

Example

These are sample CSV and JSON exports.

Note

The actual JSON export is unbeautified. This example has been formatted for easier viewing.

CSV

provider_name,provider_id,subscription_status,supported_products
Mikomo,mikomo,PENDING,"account_info,investments,payments,balances,customers,transactions"

JSON

{
  "pending": [
    {
      "id": "mikomo",
      "displayName": "Mikomo",
      "clusters": [
        {
          "id": "18owqx33-uf6p-4yhs-hxyf-yiwf9d9lx3em",
          "name": "transactions",
          "description": "Up to two years of transaction data across account types, including amounts, dates, and descriptions.",
          "required": false
        },
        {
          "id": "ex4f8efr-449e-2g5f-vg16-td95mceyl52r",
          "name": "account_info",
          "description": "Account display name, masked account number, type, description.",
          "required": true
        },
        {
          "id": "svm024fm-hvg6-n7x0-dpw4-e0tx9vi1ctjd",
          "name": "investments",
          "description": "Detailed information on underlying holdings and positions of investment accounts.",
          "required": false
        },
        {
          "id": "lqxoc2ha-odfj-qgr2-d719-1ttpnecb4bes",
          "name": "payments",
          "description": "Identifiers necessary to make ACH and RTP payments.",
          "required": false
        },
        {
          "id": "srep6cnk-ze4m-khcx-8cfz-brm86qg6ealb",
          "name": "balances",
          "description": "Balances and rates of bank accounts, credit cards, loans, investments, and more.",
          "required": false
        },
        {
          "id": "6sc1b2sa-36z4-gccp-711z-r0o817nhrufz",
          "name": "customers",
          "description": "Verified contact information on file, including name, email, address, and phone number.",
          "required": false
        }
      ],
      "subscriptionStatus": "PENDING"
    }
  ],
}

Overview Data Providers

Viewing Your Apps
Registering Sandbox Apps
Request Production Access
Registering Production Apps
Provider Subscription Statuses
Search Apps
Export Subscription Data

Introduction

Use Cases

Technical Guides

Data Recipient Hub

Testing

Akoya Test Users

Validating with Sandbox

Reference

OpenAPI Specs

Akoya Token API v2.2.0

Akoya Service Token API v1.0.1

Akoya APIs v3.0.0

Account Information

Balances

Customers

Investments

Payments

Statements

Tax

Transactions

Akoya Apps Management API v2.0.0

Apps

Products

Subscriptions

Providers

Akoya Notifications API v1.1.0

Akoya Consent API v1.1.0