API Documentation

Skip to main content

Documentation

Requirements and Best Practices
Creating a Test App
Preparing to Integrate
Guide for Production Access
Account Verification
Account Linking and Consent
Account Ownership Validation
PFM Account Aggregation
Token Overview
ID Token Details
Unique Token Keys and Values
Advanced Token Scenarios
Troubleshooting
Sandbox Data Overview
Mikomo Model Response
Payments Test User (ACH only)
Payments Test User (ACH & RTP)
Payments Test User (ACH & RTP - TAN)
Personal Finance Management Test User
Wealth Management Test User
Lending and Credit Test User
Testing Authentication
Token Management
Testing Endpoint Responses
API Servers
OAuth 2
Redirect URIs Explained
CORS
Curl
API Error Reference
Consent Flow Cancellation Error Handling
FDX
Headers
Native App Integrations
Pagination
Timestamp Formatting
Tokenized Account Numbers (TAN)
Glossary
Akoya Token API 2.2
Akoya Service token API v1.0.1
Akoya Apps Management 2.0
Akoya Notifications API 1.0.2
Akoya Notifications API 1.1.0
Akoya Consent API 1.0.2
Akoya API v2 Archive
Change log
Akoya APIs overview
Get authorization code
Token
POST
Revoke
POST
Service token
POST
Account info guide
Account information
GET
Balances guide
Balances
GET
Transactions guide
Transactions
GET
Investments guide
Accounts
GET
Taxlots
GET
Customers guide
Customer info
GET
Account holder information
GET
Payments guide
Payments
GET
Statements guide
Statement list
GET
Statement
GET
Akoya Apps Management API v2 Guide
Create App
POST
Update App
PATCH
Get All Apps
GET
Get Purchased Products
GET
Get Valid Providers For Products
GET
Get Subscriptions For App
GET
Get Subscriptions For App - Filter By Status
GET
List notification subscriptions
GET
Create notification subscription
POST
Get notification subscription by Id
GET
Update notification subscription
PATCH
Delete notification subscription
DELETE
Maintenance notification details
GET
Send sandbox test event
GET
Get Consent Grant
GET

© 2025 Akoya. All rights reserved.

Documentation