Sandbox overview
Akoya provides a sandbox for integrating and testing your application. Implement consent flow, token retrieval, and data requests all using the Akoya sandbox.
The Akoya sandbox allows you to make calls to Akoya APIs for tokens and data.
Every data request in the Data Access Network requires an ID token. To test in sandbox, you must log in as a user and complete the account selection and consent flow process to retrieve an ID token. Akoya has provided a mock data provider for your testing use.
What is sandbox?
Sandbox is a service provided by Akoya for testing Akoya endpoints. Mikomo, a mock data provider, is the only provider available using sandbox. Mikomo includes a test library with representative samples from various data providers. The data available from these users is detailed in the Catalog below.
We recommend using Postman for testing. For more information on using Postman, see: Postman collection
Requirements for sandbox:
- An app registered in the Data Recipient Hub
- 5 TPS (transactions per second) rate limit
- The following parameters:
| Parameter | Value |
|---|---|
| client_id, client_secret, redirect_uri | your variable values |
| connector note: the connector parameter is the same as the providerId | mikomo |
| idp_url | sandbox-idp.ddp.akoya.com |
| permission_url | sandbox-permission.api.ddp.akoya.com |
| products_url | sandbox-products.ddp.akoya.com |
| providerId | mikomo |
Mikomo catalog
Mikomo users are created with static, example response payloads. These payloads are representative and can be used to understand the type of data you may receive through the Data Access Network. Sandbox accounts may also be used for your integration and testing needs. For testing support, we’ve included a variety of Akoya products, provider accounts types, account statuses, transaction loads, and error states.
Note: for all test users, the username and password are the same.
Payments use case
- GenericUser_Payments_ACH (ACH only)
- CHECKING(0):
g833202fb0866d0ad83472c429
- CHECKING(0):
- GenericUser_Payments_BOTH (ACH & RTP)
- CHECKING(0):
g833202fb0866d0ad83472c429
- CHECKING(0):
- GenericUser_Payments_BOTH_TAN (ACH & RTP - TAN)
- CHECKING(0):
g833202fb0866d0ad83472c429
- CHECKING(0):
Personal financial management use case
- GenericUser_Pfm
- CHECKING(300):
3625947435 - SAVINGS(47):
7266620396 - MORTGAGE(1):
1e30bded-6c39-4635-84d1-ced8cdc7a8d5 - CREDITCARD(47):
5532879 - IRA(3):
2044231936 - 401K(0):
1859112729 - BROKERAGE(4):
7638022448
- CHECKING(300):
Wealth management
- GenericUser_WealthManagement
- IRA(3):
2044231936 - 401K(0):
1859112729 - BROKERAGE(4):
7638022448
- IRA(3):
Lending and credit
- GenericUser_LendingAndCredit
- MORTGAGE(103):
ccs1r56l9cy8q19xvdu98aur6hhjl8obpz3sp2vlu1vhv3bbkvtiwq59z93zr77t - CREDITCARD(300):
y1wyj5dwqvlgli3o638arl99ngu863uqc76pekcyx7q08wfk0dt9jozd0u94ph45
- MORTGAGE(103):
Provider data
Notice
Representative test users are created with live data from each data provider and collected through the Data Access Network. However, this sample data does not include all possible responses.
To find more information on test users, refer to each data provider's documentation section in the Data Recipient Hub.
Error testing
Some errors are difficult to replicate. For instance, there is no way for you to revoke an end-user’s consent via their bank’s app or website to test the errors that would result in your app. When data is requested for these users, the result will always be an error.
To test with these Mikomo users, go through the consent flow as usual to obtain an ID token. Then, any data call will result in the errors listed below.
Note: username and password are the same.
| user/pwd | error type | message |
|---|---|---|
| mikomo_500 | 500 | Internal server error |
| mikomo_501 | 501 | Subsystem unavailable |
| mikomo_601 | 601 | Customer not found |
| mikomo_602 | 602 | Customer not authorized |
| mikomo_701 | 701 | Account not found |
| mikomo_702 | 702 | Invalid start or end date |
| mikomo_703 | 703 | Invalid date range |
| mikomo_704 | 704 | Account type not supported |
Change log
| Date | Update |
|---|---|
| 2024-Sept-19 | Added lending and credit test user. |
| 2024-Sept-12 | Updated with new Mikomo users. |
| 2024-Aug-06 | Added dev help resources. |
| 2023-Aug-23 | Added required params for Akoya API v2; removed reference to v1; added Statements and a reference to mikomo_11 in the Products table. |
| 2022-Oct-21 | Updated “Error testing” section with new mikomo_704 user. |
| 2022‑Jun‑13 | Updated document for clarification, added Catalog section to detail use cases, and added reference for new user, mikomo_10 |
Need help?
Check out our Developer Community, or visit the Support Center in the Data Recipient Hub.
Looking for provider nuance documentation?
All provider nuance documentation is available in the Data providers section in the Data Recipient Hub.
Still stuck?
For all production issues, submit a support ticket through the Data Recipient Hub. Our support team is standing by 24/7. Questions and non-production issues will be answered during business hours.
Updated 8 months ago