OpenAPI Reference

This page contains the detailed reference documentation for each of the Apiture Open Banking APIs: the API resources, operations, parameters, and data schemas for each API. Use the OpenAPI links to download the OpenAPI 2.0 document for the APIs in YAML or JSON format.

You may download the Typescript SDK.

In case you missed it, please see our Get Started guide and Concepts.

API Description OpenAPI
Accounts Access internal accounts and account details (balances, etc.) at a financial institution, as well as linked external accounts
Account Verifications Verifies access to linked external financial institution accounts
Applications Manages the data and workflow for applications for new banking accounts
Approvals Record the pending review, and approval or rejection of processes, documents or other resources which require manual intervention
Associations Maintain associations and roles between related business objects
Audit Administrative access to user authentication and other banking activity audit records
Authentication Authentication
Business Verifications Allows financial institutions to verify business identities and the identities of authorized representatives connected to the business
Cards Manage banking and debit cards
Check Deposits Deposit checks by submitting pictures from a mobile device
Check Orders Order checkbooks for checking accounts
Contacts Manage people and their personal contact information such as date of birth, addresses, phone numbers, and email addresses
Consents Tracks a user’s consent of financial institution policies and documents such as account terms and conditions, electronic consent, and privacy policy
Configurations Platform configuration
Dates Perform date calculations, such as processing dates
Documents List and download banking documents such as statements, tax forms, and notices
Identity Verify the identity of individuals such as account owners and authorized signers
Invitations Invite others to become joint owners of personal accounts or authorized signers of business accounts
Notifications Messages, message topics, and subscriptions for loosely-coupled message delivery
Organizations Represents businesses, trusts, and other entities, primarily for business accounts ownership
Payments Request payments to a payee, using various payment methods
Products The financial institution’s list of banking products (savings, checking, certificates of deposit); each account is an instance of a product
Text Manage customizable text for client applications
Transfers Transfer funds between a financial institution’s accounts or between an FI’s account and an external account
Transactions Account transaction history
Users People who are enrolled in digital banking, with a user ID and credentials
Vault Document storage in hierarchical folders, with document revision history
Workflow Business processes, included automatic and manual human-driven tasks, such as filling in forms or approving activities