Sandbox Data Overview
The sandbox is a production like environment for you to learn Akoya's platform and test the APIs. We created the mikomo, test data, test consumers, and a set of test API servers for your use. You can make calls in a production like setting with test API servers and retrieve tokens and data. All of the API product are available on the servers. For a list of test servers, see “API Servers” .
Sandbox Set Up
If you haven’t already, log into the Data Recipient Hub, go to the My apps tab and create a sandbox app.
The Data Recipient Hub is a web-based application used for registering and managing apps, getting service API credentials, and submitting support tickets.
When you create a sandbox app, you are registering a redirect URI with us and generating your API credentials. Don’t worry if you don’t have your actual redirect URI yet. Akoya provides a placeholder redirect URI (https://recipient.ddp.akoya.com/login/flow/callback) that you can use for testing. It becomes available when you create the sandbox app. Use the appropriate sandbox server base URL along with the endpoints, for example https://sandbox-idp.ddp.akoya.com/token.
Every data request 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.
Sandbox Parameters
Sandbox is a service provided by Akoya for testing Akoya endpoints. The only provider available using sandbox is mikomo, a mock data provider. It includes a test library with representative data samples. The following catalog details the data available from these users.
Consider using Postman for testing. For more information on using Postman, see the Akoya Postman collection
Requirements for sandbox:
An app registered in the Data Recipient Hub
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 | <> |
idp_url | https://sandbox-idp.ddp.akoya.com |
products_url | https://sandbox-products.ddp.akoya.com |
providerId | mikomo |
mikomo Catalog
We create mikomo users with static response payloads that are examples of production data. These payloads are representative and are useful for understanding the response data types. Sandbox accounts are useful for integration and testing needs. For testing support, we’ve included a variety of Akoya product, provider accounts types, account statuses, transaction loads, and error states.
Note: Username and password are the same for all test users.
Payments Use Case
User | accountId | Account Type | Number of Transactions |
|---|---|---|---|
GenericUser_Payments_ACH (ACH only) | g833202fb0866d0ad83472c429 | CHECKING | 0 |
GenericUser_Payments_BOTH (ACH & RTP) | g833202fb0866d0ad83472c429 | CHECKING | 0 |
GenericUser_Payments_BOTH_TAN (ACH & RTP - TAN) | g833202fb0866d0ad83472c429 | CHECKING | 0 |
Personal Financial Management Use Case
User | accountId | Account Type | Number of Transactions |
|---|---|---|---|
GenericUser_Pfm | 3625947435 5532879 | CHECKING CREDITCARD | 300 |
7266620396 | SAVINGS | 47 | |
2642618982 | MORTGAGE | 1 | |
5532879 | CREDITCARD | 47 | |
2044231936 | IRA | 3 | |
1859112729 | 401K | 0 | |
7638022448 | BROKERAGE | 4 |
Wealth Management
User | accountId | Account Type | Number of Transactions |
|---|---|---|---|
GenericUser_WealthManagement | 2044231936 | IRA | 3 |
1859112729 | 401K | 0 | |
7638022448 | BROKERAGE | 4 |
Lending and Credit
User | accountId | Account Type | Number of Transactions |
|---|---|---|---|
GenericUser_LendingAndCredit | ccs1r56l9cy8q19xvdu98aur6hhjl8obpz3sp2vlu1vhv3bbkvtiwq59z93zr77t | MORTGAGE | 103 |
y1wyj5dwqvlgli3o638arl99ngu863uqc76pekcyx7q08wfk0dt9jozd0u94ph45 | CREDITCARD | 300 |
Provider Data
Note: We create representative test users with real data from Akoya. Sample data does not include all possible responses.
Error Testing
Some errors are difficult to replicate. For instance, there is no way for you to revoke a consumer’s consent via their bank’s app or website to test the errors that would result in your app. When you request data 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. Data calls result in the errors listed in the table.
User/Pwd | Error Code | 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 |