High level project checklist
For a business partner or team lead: A start to finish overview of integrating with the Akoya Data Access Network
The following project plan outlines steps in integrating with the Data Access Network. The plan covers engagement steps, scope, and development effort.
Time estimates are approximate!
All time estimates provided in these documents are ballpark figures for planning purposes only. Many factors beyond Akoya’s control affect project timelines, so this content is intended as an aid in developing your own project plans.
Discovery & engagement
Estimated timeframe: 4 weeks
| Task | Description |
|---|---|
| Review Guides and API Documentation | Understand 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 Hub | Your team's first user should join the Data Recipient Hub with Sandbox access where you can: 1. Share access with your colleagues. 2. Manage your client ID, secret, and redirect URI. 3. See available data providers, offered account types, and data elements. |
| Test calls and responses | At this step in the project, you may test Akoya API v2 calls via Postman or the Try It feature in the API documentation. |
Initial integration & connectivity
Estimated timeframe: 12 weeks
| Task | Description |
|---|---|
| Map data to your systems | Leveraging the data inventories per provider, map 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) |
| Enable data provider selection | Build (or integrate into existing) the ability for new and existing end-users to select data providers (with logos, optional) so that the user may authenticate and select accounts for sharing. |
| Obtain consent | Present to and retain consent from the end-user to access data from the selected data provider. Reference: consent language in contract |
Authenticate & select accounts
Estimated timeframe: 2-3 weeks
Establish connectivity to the data provider (Mikomo in Sandbox) so the end-user may authenticate and select accounts to share or revoke. The resulting per customer/per data provider tokens and client id/secret are retained securely.
For more information, see the Developer project checklist.
Obtain data
Estimated timeframe: 2-3 weeks
Based on your use case, integrate to the Akoya API v2 endpoints, validate any errors, ingest data, and display data for the end-user
For more information, see the Developer project checklist.
Test
Estimated timeframe: 2 weeks
Validate end-to-end experience:
- Data provider selection
- Consent and authentication
- Data retrieval, display, and processing
- Error handling
Prepare for Go Live
Estimated timeframe: 4 weeks
This work can be done in parallel with the integration work.
| Task | Description |
|---|---|
| Sign Contract | Akoya 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 migration plan | Define rollout plan: define target timeline, size and frequency of tranches, migration of existing users, enablement of new users, order of data provider implementation, etc. Share your plan with Akoya’s Partner Success Manager for capacity planning. |
| Request production credentials | When 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 in the Data Recipient Hub. Data providers will authorize you to access certain data clusters, products, and/or data elements as relevant to your use case. |
| Answer Security and Risk Review Questions | Akoya uses KY3P to perform security assessments; your information security team will need to be engaged. The SRR must be approved with any remediation items defined, prioritized, and resolved if high or critical. |
Go Live
Estimated timeframe: 1-2 weeks
| Task | Description |
|---|---|
| Register additional Apps, if applicable | Create subsequent Apps (the end-user facing app in the chain) per business needs on the Data Recipient Hub. |
| Validate in production | Smoke test in production among beta users, employees, and/or “friends of the firm” to validate consent flow and data integrity |
| Implement rollout plan | Migrate existing users and new users by App and/or provider |
Updated 9 months ago