Data Recipient Hub v4.0.0

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

Overview

The Data Recipient Hub (The Akoya Hub) is a web-based application used for managing registered applications. It’s also a one-stop documentation gateway where you can review “Getting started” information, our API docs, Postman collections, 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 Akoya Hub.

Akoya Hub overview page

Akoya Hub overview page


Features

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

  • view your apps, their client IDs, and redirect URI(s)
  • reset client secrets
  • register new apps
  • request production access
  • review provider subscriptions for each of your apps
  • access our sandbox environment
  • manage team members

Gaining access

🚧

One Data Recipient Hub account per company!

Your company should maintain one Data Recipient Hub team account. The first team member to join the Akoya Hub should send invitations to the remaining members of the team. This section covers how to add additional team members.

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

Request an account by filling out our request form.

Account creation screen

Account creation screen

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 seven 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.

Sign up screen

Sign up screen

Next, you’ll be prompted to set up multi-factor authentication (MFA). This process is described in the “Configuring MFA” section under “Team management.” Once complete, your company account will be created with you as the initial user.


Logging in

After your account is set up, you (and any team members you add) can log in via the following process:

  1. Navigate to https://recipient.ddp.akoya.com/login

  2. Enter your company ID at the first login screen, and your individual credentials at the second.

Enter your company ID
Enter your company ID
Log in with your username and password
Log in with your username and password
  1. Next, you’ll be asked to enter a code from your authenticator app or hardware security key (see the “Configuring MFA” section).
  2. You may be asked to set up biometric login if you previously selected “remind me later.” Otherwise, you’ll be taken to the main overview page in the Akoya Hub.

Team management

The Team management section is where you’ll add and delete users from your Akoya Hub account. You can also edit your company’s display name, reset your password and edit your profile’s display name.

User roles

The Akoya 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).

Team management section

Team management section

Click the “Invite user” button, enter the name and email for the new user, and click the “Invite” button.

Invite user button
Invite user button
Invite button
Invite button

📘

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 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 Akoya Hub accounts.

Reset password

Click the pencil next to “Profile details.”

Click the pencil to access the reset password screen

Click the pencil to bring up the reset password screen

Click the “Reset” button, enter and confirm your new password in the next screen, and click “Save.”

Click “Reset” to open the password reset screen
Click “Reset” to open the password reset screen
Enter and confirm your new password
Enter and confirm your new password

Edit profile display name

Open the “Profile details” screen, as described in the “Reset password” section. The “Name” field will become editable. Click “Save” after making your changes.

Edit your display name, and click "Save"

Edit your display name, and click “Save”

Edit company display name

Click the pencil next to “Company details”

Click the pencil to bring up the "Company details" screen

Click the pencil to bring up the "Company details" screen

Edit your company’s display name, and click “Save.”

Edit company display name

Edit company display name

Removing users

To remove a user, click the trash can icon next to the user you want to delete.

Delete user

Delete user

Configuring MFA

After setting your password, you’ll be presented with the following screen to set up MFA. You can either use a software authenticator app (i.e. Google Authenticator) or a hardware security key.

MFA setup screen

MFA setup screen

Method 1 - Google Authenticator or similar

The following authentication apps are supported:

  • Google Authenticator
  • Duo
  • Authy

Scan the QR code and enter the six-digit code to finish the setup. The QR code in the example is blurred for security reasons.

A recovery code will display on the next screen. This code will allow you to log into your account without your device. Record this code in a safe place. Check the box indicating that you’ve saved your code, and click “Continue.”

Authenticator app QR code
Authenticator app QR code
Recovery code
Recovery code

Method 2 - Security key

📘

Note

We recommend using Chrome or Safari to register your security key with the Akoya Hub.


🚧

Exact procedure may vary!

The exact steps to register your device may vary depending on the specific device you’re using. The following section should be used as a guide only.

If you select the security key option, you’ll be taken to the following screen. Click “Use security key,” and insert your device when prompted.

Add security key
Add security key
Insert key to continue
Insert key to continue

At this point, you may be asked to enter a pin to unlock your device.

Activate security key
Activate security key
Enter a pin to unlock
Enter a pin to unlock

Name your device, and save your recovery code somewhere safe. You can use this code to log in if you ever lose your security key, or need to log in without it. Click “Continue” when finished.

Name your device
Name your device
Store your recovery code in a safe place
Store your recovery code in a safe place

If you reach this screen, you’ve successfully configured your security key. When you click “Continue,” You’ll be taken to the Akoya Hub overview page.

Successful registration

Successful registration

Biometric login

📘

We won't cover specific device instructions here

Due to the wide variety of biometric devices on the market, we will only cover registration from the Akoya side here. Please refer to your device’s instruction manual for further setup instructions or troubleshooting.

After you configure MFA, you’ll have the option of configuring biometric login (fingerprint or face recognition) if your device supports it.

Biometric login option

Biometric login option

Click “Continue” if you want to set up biometric login, and follow the prompts. Otherwise, select “Remind me later” or “not on this device” as appropriate.

Troubleshooting MFA

You lost access to your MFA app or security key

If you lose access to your authenticator device/app, you’ll need to use your recovery code to log in. At the “Verify your identity” screen, click the “Try another method” link, and select “Recovery code.”

Click “Try another method” to use the recovery code option
Click “Try another method” to use the recovery code option
Click “Recovery code” to proceed
Click “Recovery code” to proceed

Enter your recovery code and click “Continue.” You’ll be given a NEW recovery code to use moving forward. Be sure to record this code in a safe place, and click “Continue.” You’ll be taken to the Akoya Hub Overview page.

If you don’t have the recovery code, please have a team member delete your account and re-invite you (see Removing users). You will receive a new invite via email. Follow the instructions above to accept the invitation and configure MFA.

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

🚧

Delete old MFA entries for the Akoya Hub in your authenticator app/security key

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


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 Akoya 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 “Sandbox testing app.”

Register your app - step 1

Register your app - step 1

Next, click “Register and download.”

Register your app - step 2

Register your app - step 2

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 “Getting started” page for more information on redirect URIs.

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

Client id and secret download

Client id and secret download

🚧

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.

Registering your app in production

When you’re ready to create a production app, you’ll need to fill out an onboarding questionnaire.

Navigate to the Overview page, and click “Begin questionnaire.”

Request production access

Request production access

The questionnaire covers the following topics, as shown in the screenshot below:

  • company information & primary contact
  • business and data needs
  • anticipated API call volume & financial institution connections
  • technical readiness
  • which data providers (financial institutions) you’re interested in subscribing to
  • your company’s security controls
Onboarding questionnaire

Onboarding questionnaire

🚧

Form progress cannot be saved!

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

After you submit the questionnaire, you’ll be taken to a confirmation screen. You’ll also receive an email confirmation with a reference number should you have any questions.

Our staff will review your answers, and reach out to you regarding the next steps.

After your Customer success manager has granted you production access, you’ll see a new “Register an app” button in “My apps.”

The "Register an app" button will display in "My apps" once you've been granted prod access

The "Register an app" button will display in "My apps" once you've been granted prod access

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


App registration form. All fields are mandatory except for the icon URL.

App registration form. All fields are mandatory except for the icon URL.


🚧

Don’t lose your client secret!

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



📘

Avatar vs logo

The (optional) "app avatar" is used as your team members' profile picture for their Akoya Hub accounts, as well as your company/app avatar for app management, registration, and subscription-related activities where an avatar-sized version of your logo is appropriate. If you choose not to provide an avatar, a generic placeholder will appear in its place.

On the other hand, the "app logo" (mandatory) is a full-sized version of your company/app logo. It would be used when a full-sized logo image would be more suitable, such as a self-hosted account selection screen.

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 “Details” tab displays the following information and functionality for your testing app:

  • client ID (view and copy)
  • client secret (reset only)
  • redirect URI(s) (view, copy, and edit)
  • description (view and edit)
  • contact URL (view and edit)
  • app logo (view and edit)
  • app avatar (view and edit)
  • support email(s) (view and edit)
  • creation date (view)

Details tab

Details tab

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.

Resetting your client secret is a disruptive action! Use this option with care
Resetting your client secret is a disruptive action! Use this option with care
Client secret reset screen
Client secret reset screen

Modifying your redirect URI

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

Edit your redirect URI
Edit your redirect URI
Edit multiple redirect URIs by separating them with commas
Edit multiple redirect URIs by separating them with commas

Modifying app description

Click the pencil icon next to “App description.” Enter your app’s description in the text field provided, and click “Submit.”

Edit your app’s description
Edit your app’s description
Enter a description for your app
Enter a description for your app

Modifying contact page URL

Click the pencil icon next to “Contact us page URL.” Enter your app’s contact page in the text field provided, and click “Submit.”

Edit your app’s contact page
Edit your app’s contact page
Enter your contact page URL here
Enter your contact page URL here

Modifying app logo

Click the pencil icon next to “App logo.” This logo will appear next to your app’s name in our management applications. Enter the URL where your logo image is hosted, and click “Submit.”

Edit your app’s logo
Edit your app’s logo
Enter the URL where your logo is hosted
Enter the URL where your logo is hosted

Modifying app avatar

📘

Avatar requirements

Accepted file types: transparent PNG, JPG, GIF, or WEBP

Size requirements: 240px to 1024px (square)

The app avatar is an icon (as opposed to a full-sized logo) that will show up next to your application name in our management applications.

Click the pencil icon next to “App avatar.” Enter the URL where your image is hosted, and click “Submit.”

Edit your app avatar
Edit your app avatar
Enter the URL where your avatar is hosted

Modifying support email(s)

Click the pencil icon next to “Support emails” to edit. Akoya technical support notifications and alerts will be sent to the emails specified here.

Edit support email(s)
Edit support email(s)
Enter your support email. Separate multiple email addresses with commas
Enter your support email. Separate multiple email addresses with commas

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.

Subscriptions screen (sandbox environment)

Subscriptions screen (sandbox environment)

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

Subscriptions screen (production)

Subscriptions screen (production)

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

Data provider documentation and data inventory page

Data provider documentation and data inventory page

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.

Docs page for Mikomo Bank

Docs page for Mikomo Bank

Account types tab

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

Account types page for Mikomo Bank, our mock financial institution

Account types page for Mikomo Bank, our mock financial institution

Data Inventory tab

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

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

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

Documentation tab

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

API documentation specifics for Mikomo Bank

API documentation specifics for Mikomo Bank

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.

Test users for Mikomo Bank

Test users for Mikomo Bank


Getting started & API documentation

The “Getting started” and “API documentation” menu options open links to our "Getting started" guide and API docs respectively so you can get up and running quickly.


Postman collection

The “Postman collection” option takes you to Akoya’s public Postman collections to help you test our APIs.


Change log

DateUpdate
2023‑Feb‑21Original