OpenAPI Reference

This page contains the detailed reference documentation for each of the Apiture 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.

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 YAML
JSON
Account Verifications Verifies access to linked external financial institution accounts YAML
JSON
Applications Manages the data and workflow for applications for new banking accounts YAML
JSON
Approvals Record the pending review, and approval or rejection of processes, documents or other resources which require manual intervention YAML
JSON
Associations Maintain associations and roles between related business objects YAML
JSON
Business Verifications Allows financial institutions to verify business identities and the identities of authorized representatives connected to the business YAML
JSON
Contacts Manage people and their personal contact information such as date of birth, addresses, phone numbers, and email addresses YAML
JSON
Dates Perform date calculations, such as processing dates YAML
JSON
Identity Verify the identity of individuals such as account owners and authorized signers YAML
JSON
Notifications Messages, message topics, and subscriptions for loosely-coupled message delivery YAML
JSON
Organizations Represents businesses, trusts, and other entities, primarily for business accounts ownership YAML
JSON
Products The financial institution’s list of banking products (savings, checking, certificates of deposit); each account is an instance of a product YAML
JSON
Transfers Transfer funds between a financial institution’s accounts or between an FI’s account and an external account YAML
JSON
Transactions Account transaction history YAML
JSON
Users People who are enrolled in digital banking, with a userid and credentials YAML
JSON
Vault Document storage in hierarchical folders, with document revision history YAML
JSON
Workflow Business processes, included automatic and manual human-driven tasks, such as filling in forms or approving activities YAML
JSON