API Reference
This page contains the detailed reference documentation for each of the Apiture Digital Banking APIs: the API resources, operations, parameters, and data schemas for each API. Use the Download API Definition links to download the API definition document for the APIs in YAML or JSON format. APIs are in OpenAPI.
Please see the Release Notes to view recent API changes and a list any API feature deprecations.
In case you missed it, please see our Get Started guide and Concepts.
| API | Description | Download API Definition |
|---|---|---|
| Accounts | View and manage banking accounts and balances | |
| Accounts Administration | Administrative access to Financial Institution banking accounts | |
| Banking | All customer banking APIs (merged) | |
| Banking Account Applications Administration | Administrative access to account applications | |
| Banking Events Administration | Administrative access to banking activity and event history | |
| Business Transfers Administration | Administrative access to Business Transfers | |
| Challenges | Challenge banking users to verify their identity when performing other API operations | |
| Credit Cards | View and manage credit cards | |
| Customer Actions Administration | Invoke administrative actions on banking customers/members | |
| Customer Organization Administration | Administrative access to managing the banking relationship between customers and organizations | |
| Customers | Manage customer profile and preferences | |
| Customers Administration | Administrative access to Financial Institution customers/members | |
| Debit Cards | View and manage debit cards | |
| Institutions | Data and operations related to the financial institution | |
| Products | Banking account products offered by the financial institution | |
| Transaction Disputes | Manage transaction disputes | |
| Transactions | View banking accounts transaction history | |
| Transfers | Schedule and manage account to account transfers |