Data Recipient Hub User Manual

Not sure where to start in the Hub? Check out our user guide!

For page updates, check the change log.

Overview

The Data Recipient Hub (the Hub) is a web-based application used for managing registered applications. It’s also a one-stop documentation gateway where you can review Quickstart information, API docs, and provider-specific documentation for all financial institutions in the Akoya Data Access Network (DAN).

This manual will walk you through all the features and options available to you in the Hub.


Features

Aside from its function as a documentation gateway, the Hub also allows you to:

  • view your apps, their client IDs, and redirect URI(s)

  • reset client secrets

  • register new apps

  • review provider subscriptions for each of your apps

  • access our sandbox environment

  • manage team members


Gaining access

Gaining access to the The Hub is a self-service process:

Request a Hub account by filling out our Request form.

You’ll receive an automatically-generated email from [email protected] with the subject line “Welcome to the Akoya Data Recipient Hub” containing a login link, your username, and temporary password. This password expires in 10 days. If it does, you’ll have to re-submit the form.

At the initial login screen, you’ll be prompted to set a password of your choice. After setting your password, you’ll need to review and agree to our terms of use.

After you agree to the terms of use, the “Set password” button will become clickable.

Next, you’ll be prompted to set up multi-factor authentication (MFA). This process is described in the “Configuring MFA” section under “Team management.”


Team management

The Team management section is where you’ll add and delete users from your Hub account.

User roles

The Hub has one user role (admin). Users can add/update apps, and add/delete users.

Adding users

The account you use to sign up with Akoya will be your company’s first user. Afterward, you can set up users from the Team management section or by clicking your company name at the bottom of the navigation pane (both links take you to Team management).

Click the "Invite user" button.

Enter the name, email, and phone number for the new user.

📘

The name field is free text

You can enter a first name and last name, a first name only, or whatever other naming convention is appropriate for your organization.

When you’re finished, click “Invite.”

When you click invite, the user will receive an invitation email from [email protected] with the subject “Welcome to the Akoya Data Recipient Hub.” The body of the email will contain the person’s username and a temporary password.

The user will be prompted to change this temporary password at first login.

🚧

The temporary password expires in 10 days!

If the new user hasn’t completed the initial login by then, you’ll need to delete/recreate the user to generate a new invite.

After setting your password, you’ll be taken to the multi-factor authentication (MFA) setup screen. Setting up MFA is mandatory for Hub accounts.

Removing users

To remove a user, go to “Team Management” and click the trash can icon next to the user you want to delete.

Configuring MFA

After setting your password, you’ll be presented with the following screen to set up MFA.

The following authentication apps are supported:

📘

Google Authenticator is recommended

We recommend using Google Authenticator due to ease of use.

  • Google Authenticator
  • Duo
  • Authy

Scan the QR code and enter the six-digit code to finish the setup.

Troubleshooting MFA

You lost access to your MFA app

If you lose access to your authentication app, please have a team member delete your account and re-invite you (see Removing users). You will receive a new invite. Follow the instructions above to accept the invitation and configure your MFA. If you’re using Google Authenticator, the new entry will show up in your authentication app as “Recipient Hub ([email protected]).” Entries in other apps may vary slightly.

If your account is the only one in the Hub, please contact support.

🚧

Delete old MFA entries for the Hub

When your Hub account is recreated, the old “Recipient Hub” entry in your authentication app will no longer work. Delete it before setting up your account again.

You’re unable to log in using your authentication app

If your account has been recreated, verify that you are using codes from the “Recipient Hub” entry that was created in your authentication app at the time you recreated your account. The old one will no longer work.

Otherwise, delete your account and recreate it.


My apps

📘

One app in sandbox

You’re only allowed to have one app in our sandbox environment at a time.

Registering your app in sandbox

When you log into the Hub for the first time and visit the “My apps” section, you’ll see the following screen, inviting you to register your app in our sandbox environment. Click “Register and download.”

A sandbox app entity will be created with a randomly-generated client ID and placeholder redirect URI that you can modify later to your own app’s redirect URI.

📘

More info on redirect URIs

See the data recipients “Getting started” page for more information on redirect URIs.

A CSV file download will also trigger, containing your client ID and secret.

🚧

Client secrets cannot be retrieved!

Record your client secret in safe place; if you lose it, you will need to reset it.

Once you register your app, you can return to the “My app” page to reference information about your app.

📘

Creating a production app

When you’re ready to create a production app, contact your Partner Success Manager.

Registering your app in production

After your Partner Success Manager has granted you production access, you’ll see a new “Register an app” button in “My apps.”

Fill out the short registration form, and click “Register and download.” A CSV download will trigger, containing your client ID and secret.

🚧

Don’t lose your client secret!

Again, remember to store your client secret in a safe place!

Details for your production app will now appear in “My apps.”

Viewing/modifying app details

🚧

Don’t forget to register your redirect URI(s)!

Your redirect URI(s) must be registered (process described above) before you can make successful API calls. Any calls made with an unregistered redirect URI will return a 400: Bad Request.

The “Credentials” tab displays your app’s client ID, redirect URI(s) and app creation date.

Modifying your redirect URI

If you need to edit your redirect URI or add additional ones, click on the ellipses next to the entry.

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

Resetting your client secret

If you need to reset your client secret, click the reset symbol next to “Client Secret.”

You’ll receive a warning message about potential service disruption after the reset. Type “RESET” to confirm and click the “Reset and download” button to reset the client secret. Another CSV download will trigger containing your new client secret.

Viewing your subscribed providers

The “Subscriptions” tab displays all your subscribed providers. For your sandbox testing app, the only provider will be our mock financial institution, Mikomo.

In production, an app shows as either “subscribed” or “not active.”

Clicking on a provider will take you directly to that provider’s documentation and inventory page within the “Data providers” section.

Here, you can view specific documentation pertaining to that provider, organized into tabs. The provider pages will be discussed in the next section.


Data providers

🚧

The Data Providers list includes all providers on our network

The “Data providers” menu option displays an exhaustive list of all providers on the Akoya platform and does not reflect your own subscriptions. To view your subscriptions, click “My apps,” select your application, and click “Subscriptions.”

The “Data providers” section displays a list of all providers on the Akoya Data Access Network (DAN) and their implementation status (Coming Soon, Sandbox, and Production).

Clicking on any provider will take you to that provider’s documentation page.

Products tab

The “Products” tab displays a list of all account types and their corresponding product codes.

Data Inventory tab

The “Data Inventory” tab displays a list of data elements supported by that provider.

Documentation tab

The “Documentation” tab contains documentation with implementation considerations specific to that provider.

Sample Users tab

📘

All sample users exist in our sandbox provider, Mikomo Bank

To aid in your testing possible responses, we have also created example users for the providers in our network reflecting nuances in data elements supported. The accounts associated with these users contain dummy account data from Mikomo. We do not store actual provider account data in our systems.

The “Sample Users” tab includes a list of test accounts for use in the sandbox environment.

In the column to the right, change the “Username” and “Payload” dropdowns to view the JSON example responses.


Quickstart & API documentation

The Quickstart and API menu options open links to our Quickstart guide and API docs respectively so you can get up and running quickly.


Change log

DateUpdate
2022‑Mar‑22Original
2022‑Mar‑29Added sections: Removing users, Troubleshooting MFA
2022‑Apr‑26Updated to support Akoya’s new self-service signup process.