Akoya APIs Overview
Introduction
Enable financial planning and budgeting tools, investment management, payment enablement, account opening, lending, credit enhancement, and more with consumer permissioned data obtained with Akoya's data APIs.
Authentication APIs
Akoya's authentication APIs include the two token APIs. The Token API allows you to generate ID and refresh tokens to retrieve end user data from the data APIs while the Service token API generates access tokens for use with the service APIs.
API | Endpoint(s) | Use |
|---|---|---|
Token | Obtain and refresh ID tokens for data APIs. | |
Revoke | Revoke tokens for the permissioned user. | |
Service Token | Generate access tokens for service APIs. |
Data APIs
The data APIs allow you to retrieve permissioned consumer data from financial institutions. Combine APIs to meet a variety of use cases.
API | Endpoint(s) | Use |
|---|---|---|
Account Information | Access basic account information including: * accountID * masked account number * type * description | |
Balances | Access balance information and interest rates for bank accounts. | |
Transactions | Get account transaction history. | |
Accounts | Get the data returned in Balances and Account Information plus contributions, holdings, vesting information, and more. | |
Taxlots | Retrieve tax lots of consumer-permissioned accounts. | |
Customer Information | Get customer data for the permissioned consumer. | |
Account Holder Information | Get customer data for ALL account holders. | |
Payments | Includes account payment information such as bankId, identifier, type, and identifierType. This cluster supports use cases such as payment enablement and account opening. | |
Statement List | Get a list of available account statement for the consumer’s consented accounts. | |
Statement | Get a specific statement file in PDF format. | |
Search Tax Forms | Get the full lists of tax document data and tax form images available for a specific year for the current authorized customer. | |
Retrieve Tax Forms | Get the Tax statement as JSON or PDF for a single tax document for the customer. Use HTTP Accept request-header to specify desired content types. |
Service APIs
Akoya provides three service APIs: Apps Management API, Notifications API, and Consent API.
Apps Management API allows you to create and manage applications on the Akoya network. Notifications API enables you to receive notifications about outages and other significant status changes on the network. Consent API allows you to receive notifications of an end user’s change in consent.
API | Endpoint(s) | Use |
|---|---|---|
Create App | Create new apps on the network (up to 50 per request). | |
Update App | Update your app details. | |
Get all Apps | Get a list of your created apps. | |
Get Purchased Products | Get a list of your subscribed Akoya products. | |
Get Valid Providers for Products | List all providers that support an Akoya product. | |
Get Subscriptions for App | Get details for a specific app’s data provider subscription. | |
Get Subscriptions for App - Filter by Status | Get details for a specific app’s data provider subscription. | |
Create Notification Subscription | Create a notification subscription to a specific category and type of notification. | |
List Notification Subscriptions | Get a list of your notification subscriptions. | |
Get Notification Subscription by Id | Get a specific notification subscription. | |
Delete Notification Subscription | Delete a notification subscription. | |
Update Notification Subscription | Update the callback URL, effective date, or callback email of a notification subscription. | |
Send Sandbox Test Event | Validate that your server can handle incoming webhook payloads from Akoya. | |
Get Consent Grant | Get the details of a consumer's change in consent. |