High level project checklist

This document is a start to finish overview for project managers and business analysts to help them formulate a project plan for integration with the Akoya Data Access Network. Please use this high-level outline to determine which tasks your project will need during integration.


Review guides and API DocumentationUnderstand technical specifications for the authentication process and best practices. Review mock financial institution (Mikomo) requests and responses. Understand available products.
Access to the Data Recipient HubSign up for an account in the Data Recipient Hub, which includes sandbox access where you can:

1. Create an app in our sandbox environment for testing.

2. See available data providers, account types, data elements, and Akoya products supported.
Test calls and responsesAt this step in the project, you may test Akoya API calls via Postman or the Try It feature in the API documentation.

Initial integration & connectivity

Map data to your systemsLeveraging the data inventories per provider, map provider data to your internal databases/resources. Refer to the Data Recipient Hub for inventories and sandbox documentation for specifications and responses (via API or Postman).
Build a data provider selection UXBuild functionality into your app that allows new and existing end-users to select data providers so that the user may authenticate and select accounts for sharing.
Obtain consentEnsure you have a workflow to obtain and retain consent from the end-user.

Authenticate & select accounts

Establish connectivity to the data provider (Mikomo in sandbox) so the end-user may authenticate and select accounts to share or revoke. Implement secure storage for each of your app’s clientId/client_secret combinations and for all tokens. Tokens are unique for each user's consent per app and per provider.

For more information, see the technical implementation checklist: Developer project checklist.

Obtain data

Based on your use case, integrate the Akoya API endpoints, validate any errors, ingest data, and display data for the end-user.

For more information, see the technical implementation checklist: Developer project checklist.


Validate end-to-end experience:

  • Data provider selection

  • Consent and authentication

  • Data retrieval, display, and processing

  • Error handling

Prepare for Go Live

This work can be done in parallel with the integration work.

Sign contractAkoya has a standard terms of use outlining data access rights and consumer consent, security provisions, and risk allocation. The contract must be signed prior to production access.
Determine rollout planYour plan should determine which of your apps, Akoya products, and providers you’ll utilize for your first rollout. The plan should also include how you’ll identify a beta test group, migrate existing users, and direct new users through Akoya.
Request production credentialsWhen you are ready, request production access in the Data Recipient Hub. Client IDs and secrets for production apps, provider IDs, and production endpoints will be available there. Data providers will authorize you to access certain data clusters, products, and/or data elements as relevant to your use case.

Go Live

Register additional apps, if applicableCreate subsequent apps (the end-user facing app in the chain) per business needs in the Data Recipient Hub.
Validate in productionPerform beta testing to validate consent flow and data integrity.
Implement rollout planMigrate existing users and new users by app and/or provider.