Introduction: Sandbox
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.
Mikomo Financial
Mikomo Financial, the Akoya mock data provider, is the only provider available in 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
Sandbox requires the following parameters for Akoya API v2:
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 |
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.
All supported data elements
The mikomo_7 user includes all account categories and data elements available through the Data Access Network.
(See details below)
Products
If you need to test Akoya products with Mikomo users, this chart is a quick way to determine which user might work for you. This chart also includes additional scenario information you might need for integration/testing use.
Product | User | Scenario |
---|---|---|
Balances | mikomo_10 Checking: g833202fb0866d0ad83472c429 | Non-zero balance |
mikomo_10 Checking: 5dbda8de96eeff05f23934523a1fc258 | Zero balance | |
Investments | mikomo_3 | Includes 38 generic investment accounts. Includes examples of holdings data. |
Transactions | mikomo_2023 | For pagination and date filtering. Includes recent checking account transactions. |
Payment networks | mikomo_10 Checking: g833202fb0866d0ad83472c429 Savings: 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d | User has two accounts with payment information |
Customer info | mikomo_10 | To view customer info. This data has no telephone number, for implementation when certain data is not included. |
Statements | mikomo_11 | To view account ID, statement list, statement image, and account description |
Account types
While there are a number of account types supported by our data providers, this chart includes a selection of account types for your reference. A sample of other account types are listed by Mikomo user below.
Account type | User | Scenario |
---|---|---|
Checking | mikomo_1 | No checking accounts For use in scenarios to understand when a user doesn’t have a specific account type. |
529 College Savings | mikomo_10 | Account 839502593 with 22 transactions |
Brokerage | mikomo_10 | Account 5426873 with 4 transactions |
CD | mikomo_10 | Account 11719ae5-2399-1278-e43c-43f24abb3058 |
Account details
mikomo_1
8 accounts
Account types | Transactions |
---|---|
accountType (Number of transactions): accountId | |
Investment: I, TODI | Individual (20): 1755209824 |
mikomo_2
8 accounts
Account types | Transactions |
---|---|
accountType (Number of transactions): accountId | |
Investment: HSA, I, TODI | HSA (20): 474362798 |
mikomo_3
38 accounts
Account types | Transactions |
---|---|
accountType (Number of transactions): accountId | |
Investment: I, IRRL, TIC, IRAB, IRA, TODJ, ROTH, TODI, 401K | Individual (20): 1377569312 |
mikomo_5
3 accounts
Account types | Transactions |
---|---|
accountType (Number of transactions): accountId | |
Investment: J, HSA, ROTH | HSA (8): 1221963501 |
mikomo_6
10 accounts
Account types | Transactions |
---|---|
accountType (Number of transactions): accountId | |
Investment: HSA, TODI, IRA, IRRL, NONP, NRMA, 401k | none |
mikomo_7
5 accounts
Includes:
customers
paymentNetworks
- account 1602364511
Account category | Account type | Account number |
---|---|---|
depositAccount | CHECKING | 1602364511 |
loanAccount | COMMERCIALLOAN | 1316072226 |
locAccount | CREDITCARD | 1417522980 |
investmentAccount | 401(k) PLAN | 1222577818 |
insuranceAccount | J | 1254778531 |
mikomo_9
1 account
Includes:
customers
paymentNetworks
- account 47320722f1e9340a8f8ead1e38bdbc215b0866d0ad83472c6777923499a74429
Account types | Transactions |
---|---|
accountType (Number of transactions): accountId | |
depositAccount: Checking | Checking (1360): 47320722f1e9340a8f8ead1e38bdbc215b0866d0ad83472c6777923499a74429 |
mikomo_10
6 accounts
Includes:
customers
paymentNetworks
- account g833202fb0866d0ad83472c429
- account 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
Account types/accountId | Scenario |
---|---|
depositAccount: Checking g833202fb0866d0ad83472c429 | [1360] transactions availableBalance: 106717.06 |
depositAccount: Checking 5dbda8de96eeff05f23934523a1fc258 | [0] transactions availableBalance: 0 |
investmentAccount: College Savings 839502593 | [22] transactions |
investmentAccount: BROKERAGE 5426873 | [4] transactions |
depositAccount: CD 11719ae5-2399-1278-e43c-43f24abb3058 | [0] transactions |
depositAccount: SAVINGS 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d | [4] transactions |
mikomo_11
1 account
Includes:
paymentNetworks
customers
statements
Account types/accountId | Scenario |
---|---|
depositAccount: Checking 513815781465 (x1465) | [0] transactions availableBalance: 7869.13 [1] statements |
mikomo_2023
6 accounts
This Mikomo user was created for testing the transactions endpoint. The g833202fb0866d0ad83472c429
checking account should always return recent transactions and has several months of history for testing pagination and date filtering. All of the mikomo_2023
accounts are generic (not provider-specific) and are detailed below.
customers
paymentNetworks
- account g833202fb0866d0ad83472c429
- account 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d
Account types/accountId | Scenario |
---|---|
depositAccount: Checking g833202fb0866d0ad83472c429 | Number of transactions vary by date. Should have a result using default 15-day call. availableBalance: 106717.06 |
depositAccount: Checking 5dbda8de96eeff05f23934523a1fc258 | [0] transactions availableBalance: 0 |
investmentAccount: College Savings 839502593 | [22] transactions. Oldest date: 2023-01-03T05:00:00ZZ |
investmentAccount: BROKERAGE 5426873 | [4] transactions. Oldest date: 2023-05-17T00:00:00Z |
depositAccount: CD 11719ae5-2399-1278-e43c-43f24abb3058 | [0] transactions |
depositAccount: SAVINGS 33fbd9e5-9cc3-3d7d-15b3-70d97d87ca1d | [4] transactions. Oldest date: 2023-01-27T00:00:00.000Z |
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 |
---|---|
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 |
Updated over 1 year ago