Get Started

Warning The Apiture Open product line will reach end of life December, 2023. Consumers of the Apiture Open APIs should migrate to the Apiture Digital Banking APIs before that time.


Welcome to developer.apiture.com!

Apiture Digital Banking APIs are a set of RESTful APIs that you can use to:

  • Access accounts, balances, and transaction history
  • Schedule one-time or recurring transfers between local or external accounts
  • Orchestrate custom workflows for complex banking activities, such as opening new accounts or dispute resolution

To get started, you begin with understanding how to use Apiture Digital Banking APIs securely by acquiring and managing an API key and having users authenticate so that Apiture Digital Banking APIs can authorize their access to resources and operations. API Keys, authentication, and authorization are described in Secure Access.

  1. Apiture Digital Banking APIs use modern REST API design and resource-oriented architecture. The reader should be familiar with the basic concepts of RESTful HTTP JSON APIs.
  2. Our key API concepts page describes the structure and common design patterns in Apiture Digital Banking APIs that build upon REST over HTTP+JSON.
  3. Next, head over to our Apiture OpenAPI Reference to dive into our APIs.

You should also review and consent to the Apiture Apiture API License Agreement.

Try out the Apiture Digital Banking APIs

To see the Apiture Digital Banking APIs in action, you will execute a series of API calls to perform a simple yet common scenario:

  1. Use the Accounts API to list all accounts for the authenticated user.
  2. Next, we will select one account and fetch the details for that account.
  3. Finally, we will view recent transactions of that selected account.

The Apiture developer portal gives you an OAuth access token that represents a banking customer with several accounts. The operations require passing that access token in the Authentication request header. Both the access token for the sample banking customer and your API key are listed in your Account Settings, in case you wish to try the operation outside the developer portal, such as from your IDE or terminal.

Code snippets for all API operations (in various client programming languages) may be found in the API Reference.

List all accounts for a user

Our first call is the getAccounts operation in the Accounts API. It lists all the accounts for the authenticated user. (The calls below show a subset of each operation’s query parameters that are useful for this example. You can experiment with all the parameters on the API reference pages.)

Note: After calling the API, you can toggle between JSON and YAML view of the API result, in case you find YAML easier to read.

The response from the above getAccounts operation is a collection of accounts. The nested _embedded object in the response body contains an array of items, each representing a different account owned by the authenticated banking customer.

After the operation completes, this tutorial page automatically extracts the unique resource identifier for the first account in the array (response._embedded.items[0]._id) and sets the {accountId} path parameter on the second call below, and also sets the account query parameter on the third call. If you want to view the details from another account, copy the corresponding _id from that instance in the above response and paste it into the corresponding parameters below.

View the details for one of the user’s accounts

The next call is the getAccount operation in the Accounts API.

  GET https://api.devbank.apiture.com/accounts/accounts/{accountId}

This will fetch the details for the selected account, including the account balance.

If you have not yet tried the first getAccounts operation above, do that first; this will extract the unique ID of an account and assign it to the required {accountId} path parameter on this next operation.

Click the Try It button to run the second API call to view details for that account. To see the full account number, check the unmasked option (this will pass a ?unmasked=true query parameter to the operation) and rerun the operation.

View the transactions for the selected account

The Transactions API operation accepts an ?account= query parameter which identifies the account, such as b1c7a7036671. This is the unique ID of the selected account in this example.

If you have not yet tried the first getAccounts operation above, do that first; this will extract the unique ID of an account and assign it to the account query parameter on this next operation.

The API call below invokes the the getHistory operation in the Transactions API to list recent transactions on the selected account.

Click the Try It button to perform this API call.

The response above contains the account transaction history.

Summary

This tutorial shows how to make authenticated API calls against the Apiture Digital Banking APIs, using an OAuth access token for a banking customer.

  • The getAccounts operation in the Accounts API lists all the accounts that the user has access to, with links to each account.
  • The getAccount operation in the Accounts API lists the details of a selected account, including its balance and links to related resources, such as transaction history.
  • The getHistory operation in the Transactions API lists the recent transaction history on the selected account.

These and all the other API operations are documented in API Reference.