Postman collection

Please visit the Postman Akoya workspace for our collections and environment (default values for use in Sandbox). Parameters are defined below.

🚧

Registering with Akoya

In order to use Akoya Postman collections, you must first receive a client id and client secret from Akoya.

Installing and configuring the Postman app

The Postman app is available for the Mac, Windows, and Linux operating systems. For more information, please see Installing and updating Postman.

You may need to change some app defaults depending on your personal preferences or company network environment. Please refer to Setting up Postman for a detailed explanation of Postman settings.

Working with Akoya's Postman collection

Edit access to the collection is restricted. You may:

• Export the collection to JSON
• Create a fork in your own personal workspace

Environment

Once you’ve imported/forked your own local copy of the collection, fork a local copy of the Environments from the collection. You can find some of the variable values for your account on the My apps page of the Akoya - Data Recipient Hub. Click the “Environments” tab to update the variables to your specific values.

Environment parameters

Definitions

More information on other parameters used in the collection

Tips & tricks

1. You may also test against Postman mock servers by following the instructions provided here.
2. To view the documentation of the endpoint, click on the documentation icon on the right.

To see all documentation in a new tab, select “View complete collection documentation” at the bottom of the documentation tab.

3. By default, the Postman app uses your operating system's configured proxy to send API requests or access the internet. If needed, you can enter authentication details for the default proxy in the Postman app. You can also configure Postman to use the system proxy or a custom proxy when sending requests. See Postman's "Getting Started" guide for more info.

Testing our endpoints with Postman

These instructions are compatible with Postman v8.2.1+

📌

After installing the Akoya collection, please ensure the parameters in your environment file are correct.

Akoya provides secure (TLS v1.2) access to RESTful APIs that are based on the API/Data Structures as defined by the Financial Data Exchange. All data requests use standard GET and POST methods and must include a bearer token in the authorization header. All responses are returned in JSON format.

End-user authentication

End-users must authenticate with their data providers before you can get their data.

1. Your application sends users to their provider’s login page via the Akoya platform.

2. After successful authentication, the provider presents users with an authorization page requesting permission to share their data with your app.

3. If permission is granted, your application is issued two tokens (id and refresh) from Akoya which give you permissioned access to end-user data.

4. If end users do not grant permission to share data, Akoya will send them back to your application (to the page of your choosing).

📘

For your convenience, Akoya has made available Mikomo Bank, a mock financial institution, with test users and data. To see the collection of users, visit Mikomo users.

See the “Getting Started” page in the API docs for instructions on setting up a Hub account and getting ready to test our APIs.

See the Mikomo test users document for information on available test accounts. In our sandbox environment, the providerId will always be mikomo.

Below is a brief overview of our endpoints. More thorough documentation is available in our API docs.

Products

📌

Note

The output below is sample output for instructional purposes, and is not specific to any of the data providers on our network.

Akoya product endpoints return JSON objects with a set of account details for one or more accounts at a provider. The path parameter providerId is required. The results will vary by product.

Transactions

The Transactions endpoint returns a JSON object containing transaction histories of consumer-permissioned accounts. When testing this endpoint, you must ensure the Mikomo test account you choose has permissioned transactions associated with it.

This endpoint requires accountId and providerId. You can specify start and end times and a max number of transactions to return.

Payment networks

The Payment networks endpoint returns JSON data necessary for facilitating use cases such as payment enablement or account opening. accountId and providerId are required for the payments endpoint.

Customers

The Customers endpoint returns a JSON response with customer data, supporting use cases such as payment enablement, account opening, or lending/credit enhancements. providerId is required for the Customers endpoint.

Troubleshooting in Postman

If you're having trouble using the Postman app, it may be due to network firewalls, proxy server settings, or other issues you may be able to debug through the Postman Console. Use the Postman Troubleshooting page for tips on debugging and troubleshooting.

Change log