Accounts

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. This API returns the following links: * **`apiture:accounts`** : links to the collection of accounts held at this financial institution. * **`apiture:externalAccounts`** : links to the collection of external accounts held at other financial institutions.


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/"
import { APIApi } from "@apiture/accounts-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Accounts.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/apiDoc"
import { APIApi } from "@apiture/accounts-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Accounts.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


getLabels

Localized Labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (`en-us`).


/labels

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/labels"
import { APIApi } from "@apiture/accounts-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Accounts.APIApi.getLabels()
var opts = {
  'acceptLanguage': acceptLanguage_example // {String} The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getLabels(opts, callback);

Scopes

Parameters

Header parameters
Name Description
Accept-Language
String
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).

Responses


Account

activateAccount

Activate an account

Activate an account that is eligible to be activated. Only internal accounts which are `pending` or `inactive` or `frozen` may be activated. External accounts which are `pending`, `verifying`, `inactive`, `frozen`, `underReview`, or `closed` may be activated. Activating `frozen` accounts or `underReview` external accounts is only allowed for administrators. This operation is invoked from the `apiture:activate` link on an account, which only exists if the action is allowed. This changes the `state` to `active`.


/activeAccounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/activeAccounts?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.activateAccount()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.activateAccount(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


bumpApyRate

Bump the account's APY rate

On some banking products (CD or time-deposit accounts), the financial institution (Financial Institution) may offer a new rate in the `rates.bumpToApy` property. The user can either accept that offer or defer accepting the offer in anticipation of a better APY offer in the future. **Note**: The FI may restrict the user to only one rate increase per term. The client should call this operation when the user elects to accept the APY offer. There is no additional confirmation of this action; the new rate becomes effective and future rate bumps may not be allowed during the remainder of this account's term. The APY rate that was in effect before bump becomes the `rates.originalApy`, the `rates.bumpToApy` becomes the new `apy`, and `rates.bumpToApy` is dropped from the `rates`. The account's `cd.apyBumpedAt` records when the user accepted the bumped rate. If and only if a new APY offer is available, this operation is listed in the accounts `_links` with the link relation `apiture:bumpApyRate`.


/bumpedApyAccounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/bumpedApyAccounts?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.bumpApyRate()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.bumpApyRate(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


closeAccount

Close an account

Close an account that is eligible to be closed. Only accounts which are `active` or `inactive` or `frozen` may be closed. This operation is invoked from the `apiture:close` link on an account; the link only exists if the action is allowed. This changes the `state` to `closed`. Closing an account will append the text "` (Closed YYYY-MM-DDThh:mm:ssZ)`" to the name, so that the previous name may be used for other accounts.


/closedAccounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/closedAccounts?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.closeAccount()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.closeAccount(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


createAccount

Create a new account.

Create a new banking account. The request body must contain a link to an active product, user, organization (for a business account), and may contain an approved application. The required resource links are detailed in the `createAccount` schema used for the request body. The application will be linked to the account and can be identifiable with the account. The product provides specific banking information like the type of product and it's subtype; the new account will adopt the terms and attributes of that banking product. If a name is not included in the request, the product name will be used to provide a unique name for this user. The account will be created in the `pending` state (which allows deletion of the account). A successful operation returns the full account number.


/accounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/accounts"
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.createAccount()
var createAccount = ; // {CreateAccount} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.createAccount(createAccount, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Body parameters
Name Description
createAccount *

The data necessary to create a new account.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deactivateAccount

Deactivate an account

Deactivate an account that is eligible to be deactivated. Only accounts which are `pending` or `active` may be deactivated. This operation is invoked from the `apiture:deactivate` link on an account; the link only exists if the action is allowed. This changes the `state` to `inactive`. Financial Institution administrators can activate an inactive account with the [`activateAccount`](#op-activateAccount) operation.


/inactiveAccounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/inactiveAccounts?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.deactivateAccount()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.deactivateAccount(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


deleteAccount

Delete this account resource

Delete this account resource and any resources that are owned by it. Note that only `pending` accounts may be deleted. Once an account has been activated, it cannot be deleted, only inactivated or closed.


/accounts/{accountId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}"
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.deleteAccount()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
accountApi.deleteAccount(accountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.

Responses


freezeAccount

Freeze an account

Freeze an account that is eligible to be frozen. Only accounts which are `active` or `inactive` may be frozen. This operation is invoked from the `apiture:freeze` link on an account; the link only exists if the action is allowed. This changes the `state` to `frozen`. Financial Institution administrators can unfreeze accounts with the [`activateAccount`](#op-activateAccount) operation.


/frozenAccounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/frozenAccounts?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.freezeAccount()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.freezeAccount(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


generateVerificationLetter

Generate the account verification letter

Generate the account verification letter for this internal account. If the letter has not been generated, this returns 202 Accepted and no response body. The response will include a `Retry-After` response header with a recommended retry interval in seconds. If the letter has been generated for this account, the operations returns 200 OK and the response body is the PDF formatted account verification letter. For personal accounts, only the primary and joint owners may invoke this operation. For business accounts, only the authorized signers associated with the owning business organization may invoke this operation.


/accounts/{accountId}/verificationLetter

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/verificationLetter"
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.generateVerificationLetter()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var opts = {
  'accept': accept_example // {String} Optional. Only `application/pdf` is currently supported.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
accountApi.generateVerificationLetter(accountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
Accept
String
Optional. Only `application/pdf` is currently supported.

Responses

Name Type Format Description
ContentMinusType String When the letter is available, the response body will be the PDF formatted account verification letter for this account.

Name Type Format Description
RetryMinusAfter String Indicates a suggested delay in seconds after which the client should retry the operation. Example: `Retry-After: 10`


getAccount

Fetch a representation of this account

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this account resource.


/accounts/{accountId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}?unmasked=&embed="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.getAccount()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example, // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
  'unmasked': true, // {Boolean} When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
  'embed':  // {array[String]} The `embed` query parameter specifies which related resources to include in the `_embedded` object in the response. `embed` supports the following comma-separated values: 
  • `owners` : for `personal` accounts, include the account owners in the `_embedded.owners` object; for business accounts, include authorized signers in the `_embedded.owners` object and the owning business in the `_embedded.owningBusiness` object. (See the `embeddedAccountObjects` schema.)
  • `beneficiaries` : include the account beneficiaries (for `personal` accounts).
  • `authorizedSigners` : include the account authorized signers of the owning business (for `business` accounts).
  • `product` : include the banking product for this account. This is the default for `embed` if omitted, but if `embed` is specified explicitly, include `products` if you want it embedded.
For example, to embed both the `owners` and `beneficiaries` for personal accounts use `GET .../accounts/{accountId}?embed=owners,beneficiaries`. To embed the banking product, the owning business, authorized signers for business accounts, use `GET .../accounts/{accountId}?embed=product,owners,authorizedSigners`. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; accountApi.getAccount(accountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
unmasked
Boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
embed
array[String]
The `embed` query parameter specifies which related resources to include in the `_embedded` object in the response. `embed` supports the following comma-separated values: <ul> <li>`owners` : for `personal` accounts, include the account owners in the `_embedded.owners` object; for business accounts, include authorized signers in the `_embedded.owners` object and the owning business in the `_embedded.owningBusiness` object. (See the `embeddedAccountObjects` schema.)</li> <li>`beneficiaries` : include the account beneficiaries (for `personal` accounts).</li> <li>`authorizedSigners` : include the account authorized signers of the owning business (for `business` accounts).</li> <li>`product` : include the banking product for this account. This is the default for `embed` if omitted, but if `embed` is specified explicitly, include `products` if you want it embedded.</li> </ul> For example, to embed both the `owners` and `beneficiaries` for personal accounts use `GET .../accounts/{accountId}?embed=owners,beneficiaries`. To embed the banking product, the owning business, authorized signers for business accounts, use `GET .../accounts/{accountId}?embed=product,owners,authorizedSigners`.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


getAccounts

Return a collection of accounts

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of accounts. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. By default, the items in the collection return a subset of the accounts fields, as described in the `summaryAccount` schema. To include all fields in an account, use the `?fields=*` query parameter. If `?embed=owners` is used, each summary account representation in the `_embedded.items` array will embed the account owners or the authorized signers and owning organization.


/accounts

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/accounts?start=&limit=&sortBy=&state=&type=&subtype=&name=&productName=&filter=&q=&unmasked=&fields=&activeBetween=&embed="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.getAccounts()
var opts = {
  'start': 789, // {Long} The zero-based index of the first account item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of account representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'state': state_example, // {String} Subset the accounts or external accounts collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the accounts or external accounts collection to those with this exact `type` value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose `type` is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose `type` is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'subtype': subtype_example, // {String} Subset the accounts or external accounts collection to those with this exact `subtype` value. For example, `?subtype=true` will limit the response to only product types which are subtypes. Use `|` to separate multiple values. For example, `?subtype=Basic%20Personal%20Savings` matches only items whose `subtype` is `Basic Personal Savings`; `?subtype=Basic%20Personal%20Savings|Basic%20Investment%20Account` matches items whose `subtype` is `Basic Personal Savings` or `Basic Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the accounts or external accounts collection to those with this `name` value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose `name` is `Bartell`; `?name=Bartell|kirsten` matches items whose `name` is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'productName': productName_example, // {String} Subset the accounts collection to those with this `productName` value. Use `|` to separate multiple values. For example, `?productName=Basic%20Personal%20Savings` matches only items whose `productName` is `Basic Personal Savings`; `?productName=Basic%20Personal%20Savings|Basic%20Investment%20Account` matches items whose `productName` is `Basic Personal Savings` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'unmasked': true, // {Boolean} When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
  'fields': fields_example, // {String} Select which fields to include in each account in the collection's `_embedded.items` array. By default, a subset of all the fields in the account are returned (detailed in the `summaryAccount` schema). Use the value `*` to request all the fields in the account. Note that there is a performance impact of requesting this, since the account balance and interest (year to date) may require additional computation.
  'activeBetween': activeBetween_example, // {String} Limit the response to only accounts that are (or were) active between two dates, inclusive. The format of the query parameter is `start-date,end-date` where each date is in [RFC 3339](https://tools.ietf.org/html/rfc3339) date format, `YYYY-MM-DD`. The response includes accounts which became active on or before the end date and which were not closed before the start date. 
Example: `?activeBetween=2019-03-01,2019-03-31`.
This option may be combined with `?embed=owners`. **Note**: _This option is limited to administrative use._ 'embed': // {array[String]} If set, each account in the `_embedded.items` array will include additional embedded objects. The `embed` query parameter specifies which related resources to include in the `_embedded` object in each account in response. `embed` supports the following values:
  • `owners` : for `personal` accounts, include the account owners in the `_embedded.owners` object; for business accounts, include authorized signers in the `_embedded.owners` object and the owning business in the `_embedded.owningBusiness` object. (See the `embeddedAccountObjects` schema.)
This option may be combined with `?activeBetween`. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; accountApi.getAccounts(opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first account item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of account representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
state
String
Subset the accounts or external accounts collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the accounts or external accounts collection to those with this exact `type` value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose `type` is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose `type` is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
subtype
String
Subset the accounts or external accounts collection to those with this exact `subtype` value. For example, `?subtype=true` will limit the response to only product types which are subtypes. Use `|` to separate multiple values. For example, `?subtype=Basic%20Personal%20Savings` matches only items whose `subtype` is `Basic Personal Savings`; `?subtype=Basic%20Personal%20Savings|Basic%20Investment%20Account` matches items whose `subtype` is `Basic Personal Savings` or `Basic Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the accounts or external accounts collection to those with this `name` value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose `name` is `Bartell`; `?name=Bartell|kirsten` matches items whose `name` is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
productName
String
Subset the accounts collection to those with this `productName` value. Use `|` to separate multiple values. For example, `?productName=Basic%20Personal%20Savings` matches only items whose `productName` is `Basic Personal Savings`; `?productName=Basic%20Personal%20Savings|Basic%20Investment%20Account` matches items whose `productName` is `Basic Personal Savings` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
unmasked
Boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
fields
String
Select which fields to include in each account in the collection's `_embedded.items` array. By default, a subset of all the fields in the account are returned (detailed in the `summaryAccount` schema). Use the value `*` to request all the fields in the account. Note that there is a performance impact of requesting this, since the account balance and interest (year to date) may require additional computation.
activeBetween
String
Limit the response to only accounts that are (or were) active between two dates, inclusive. The format of the query parameter is `start-date,end-date` where each date is in [RFC 3339](https://tools.ietf.org/html/rfc3339) date format, `YYYY-MM-DD`. The response includes accounts which became active on or before the end date and which were not closed before the start date. <br> Example: `?activeBetween=2019-03-01,2019-03-31`. <br> This option may be combined with `?embed=owners`. **Note**: _This option is limited to administrative use._
embed
array[String]
If set, each account in the `_embedded.items` array will include additional embedded objects. The `embed` query parameter specifies which related resources to include in the `_embedded` object in each account in response. `embed` supports the following values: <ul> <li>`owners` : for `personal` accounts, include the account owners in the `_embedded.owners` object; for business accounts, include authorized signers in the `_embedded.owners` object and the owning business in the `_embedded.owningBusiness` object. (See the `embeddedAccountObjects` schema.) </li> </ul> This option may be combined with `?activeBetween`.

Responses


patchAccount

Update this account

Perform a partial update of this account. Fields which are omitted from the request are not updated. Nested `_embedded` objects are ignored if included. This operation does not change the `state` property. To change the `state` of the account, use the `POST` operations [`activateAccount`](#op-activateAccount), [`deactivateAccount`](#op-deactivateAccount), [`freezeAccount`](#op-freezeAccount), or [`closeAccount`](#op-closeAccount) which are available in the `_links` on an account instance.


/accounts/{accountId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}"
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.patchAccount()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var account = ; // {Account} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.patchAccount(accountId, account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Body parameters
Name Description
account *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


requestMicroDepositVerification

Request micro-deposit verification

Start micro-deposit verification for an external account. This operation moves an account with `state` of `failed` or `inactive` to the state of `microDepositsRequested`. This lets the user reuse an external account when instant account verification fails. The micro-deposit verification flow must be completed as described in the Account Verification API. This operation is available via the `apiture:requestMicroDepositVerification` link on an external account if this operation is valid. Only administrative or service applications may call this operation, not bank customers.


/externalAccountsNeedingMicroDepositVerification

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/externalAccountsNeedingMicroDepositVerification?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.requestMicroDepositVerification()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.requestMicroDepositVerification(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


reviewAccount

The account is under review

Begin review of an account, if its state allows review. This changes the state to `underReview`. When an external account is under review, the financial institution reviews the account details and may approve or reject the account; this will set the state to `active` or `frozen`, respectively. Only accounts which are `verifying` may make this state transition, and review is normally triggered automatically if external account verification was successful and customer data does not match with the account's holders' information. This operation is invoked from the `apiture:review` link on an account, which only exists if the action is allowed to update an account state to under review. Only administrative or service applications may call this operation, not bank customers.


/externalAccountsUnderReview

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/externalAccountsUnderReview?account="
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.reviewAccount()
var account = account_example; // {String} A server-supplied value which identifies the account instance.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.reviewAccount(account, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Query parameters
Name Description
account*
String
A server-supplied value which identifies the account instance.
Required

Responses


updateAccountProduct

Change the account's product

Change the account’s banking product. This applies only to personal and business CD accounts that are in their grace period (immediately following maturity). The new product must also be a CD product, and the account must satisfy the minimum and maximum balance and other constraints of the new product.


/accounts/{accountId}/product

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/product"
import { AccountApi } from "@apiture/accounts-client-sdk";

const accountApi = new AccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountApi.setApiKey(apiKey);


var api = new Accounts.AccountApi.updateAccountProduct()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var updateAccountProduct = ; // {UpdateAccountProduct} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApi.updateAccountProduct(accountId, updateAccountProduct, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Body parameters
Name Description
updateAccountProduct *

The data necessary to update a product on an account.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


AccountBeneficiaries

getBeneficiaries

Fetch the account's beneficiaries

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of the array of the account beneficiaries.


/accounts/{accountId}/beneficiaries

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/beneficiaries"
import { AccountBeneficiariesApi } from "@apiture/accounts-client-sdk";

const accountBeneficiariesApi = new AccountBeneficiariesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountBeneficiariesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountBeneficiariesApi.setApiKey(apiKey);


var api = new Accounts.AccountBeneficiariesApi.getBeneficiaries()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountBeneficiariesApi.getBeneficiaries(accountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


patchBeneficiaries

Create or Update the account's beneficiaries

Create or update the array of the beneficiaries for this account. Beneficiaries may be individuals, or a trust or charity. If the array contains only one item, it's percentage is automatically set to 100%. When updating an existing set of beneficiaries, `null` values in the `items` array or omitted objects (such as `individual` or `organization`) inside the items are ignored: the beneficiary corresponding to a `null` item is not changed. For example, the client may omit the `type`, `individual`, and `organization` properties in the `items` array in order to adjust just the percentages: ```json [ { 'percentage': 20 }, { 'percentage': 30 }, { 'percentage' : 20 }, null, null ] ``` will change just the percentages of the first three beneficiaries and not update their other data for any of the five beneficiaries; The beneficiaries list is truncated to the size of the `items` array. For example: if there were five beneficiaries, and the request body contains only three items, the last two are removed from the accounts beneficiaries array (The new total must still total 100%.) This operation applies only to `personal` accounts.


/accounts/{accountId}/beneficiaries

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/beneficiaries"
import { AccountBeneficiariesApi } from "@apiture/accounts-client-sdk";

const accountBeneficiariesApi = new AccountBeneficiariesApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountBeneficiariesApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountBeneficiariesApi.setApiKey(apiKey);


var api = new Accounts.AccountBeneficiariesApi.patchBeneficiaries()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var beneficiaries = ; // {Beneficiaries} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountBeneficiariesApi.patchBeneficiaries(accountId, beneficiaries, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Body parameters
Name Description
beneficiaries *

The array of account beneficiaries.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


AccountOwners

getExternalAccountOwners

Return a list of external account owners

Return a list of the external account's account owners (holders). The result may be empty if the data was not available when user created the external account or the account aggregator provider does not provide this information.


/externalAccounts/{externalAccountId}/accountOwners

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/externalAccounts/{externalAccountId}/accountOwners"
import { AccountOwnersApi } from "@apiture/accounts-client-sdk";

const accountOwnersApi = new AccountOwnersApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountOwnersApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountOwnersApi.setApiKey(apiKey);


var api = new Accounts.AccountOwnersApi.getExternalAccountOwners()
var externalAccountId = externalAccountId_example; // {String} The unique identifier of this external account. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountOwnersApi.getExternalAccountOwners(externalAccountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
externalAccountId*
String
The unique identifier of this external account. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be be provided with the `If-None-Match` on subsequent requests.


getOwners

Fetch the primary and joint owners of an account

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of the array of the account owners for personal accounts. There is one `primary` owner and zero or more `joint` owners. Bank customers cannot directly change this set; only the bank system or admins can change owners. Existing primary or joint owners may invite other joint owners via the Invitations API. For business accounts, refer to the `owningBusiness` in the account resource's embedded objects.


/accounts/{accountId}/owners

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/owners?unmasked="
import { AccountOwnersApi } from "@apiture/accounts-client-sdk";

const accountOwnersApi = new AccountOwnersApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountOwnersApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountOwnersApi.setApiKey(apiKey);


var api = new Accounts.AccountOwnersApi.getOwners()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example, // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
  'unmasked': true // {Boolean} When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountOwnersApi.getOwners(accountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
unmasked
Boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


updateOwners

Update the owners of this account

Update the array of the primary and joint owners on a personal account. Each owner in the request must be a verified user. This operation completely replaces the set of owners. This operation applies only to personal accounts. The new owners must have exactly one primary owner and may have additional joint owners. Only financial institutions may update owners; this occurs after an existing owner or the person who created the personal account has invited other users and those verified users have accepted the invitation.


/accounts/{accountId}/owners

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/owners"
import { AccountOwnersApi } from "@apiture/accounts-client-sdk";

const accountOwnersApi = new AccountOwnersApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
accountOwnersApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
accountOwnersApi.setApiKey(apiKey);


var api = new Accounts.AccountOwnersApi.updateOwners()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var owners = ; // {Owners} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountOwnersApi.updateOwners(accountId, owners, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Body parameters
Name Description
owners *

The array of owners.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


AuthorizedSigners

getAuthorizedSigners

Fetch the business account's authorized signers

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of the array of the account's authorized signers. This operation applies only to business accounts.


/accounts/{accountId}/authorizedSigners

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/authorizedSigners"
import { AuthorizedSignersApi } from "@apiture/accounts-client-sdk";

const authorizedSignersApi = new AuthorizedSignersApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
authorizedSignersApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
authorizedSignersApi.setApiKey(apiKey);


var api = new Accounts.AuthorizedSignersApi.getAuthorizedSigners()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
authorizedSignersApi.getAuthorizedSigners(accountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


updateAuthorizedSigners

Update the authorized signers of an account

Update the array of the authorized signers. Each signer must be a verified user. This operation completely replaces the set of signers. Only financial institutions may update authorized signers; this occurs after an existing authorized signer or the person who created the business account has invited other users and those verified users have accepted the invitation. This operation applies only to business accounts.


/accounts/{accountId}/authorizedSigners

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accounts/accounts/{accountId}/authorizedSigners"
import { AuthorizedSignersApi } from "@apiture/accounts-client-sdk";

const authorizedSignersApi = new AuthorizedSignersApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
authorizedSignersApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
authorizedSignersApi.setApiKey(apiKey);


var api = new Accounts.AuthorizedSignersApi.updateAuthorizedSigners()
var accountId = accountId_example; // {String} The unique identifier of this account. This is an opaque string.
var authorizedSigners = ; // {AuthorizedSigners} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
authorizedSignersApi.updateAuthorizedSigners(accountId, authorizedSigners, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
accountId*
String
The unique identifier of this account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Body parameters
Name Description
authorizedSigners *

The array of authorized signers.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account resource.


Configuration

getConfigurationGroup

Fetch a representation of this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group resource.


/configurations/groups/{groupName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups/{groupName}"
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.getConfigurationGroup()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroup(groupName, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-None-Match` request header for *`GET`* operations for this configuration group resource.


getConfigurationGroupSchema

Fetch the schema for this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group schema resource.


/configurations/groups/{groupName}/schema

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups/{groupName}/schema"
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.getConfigurationGroupSchema()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupSchema(groupName, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroupValue

Fetch a single value associated with the specified configuration group

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To update a specific value, use `PUT /accounts/configurations/groups/{groupName}/values/{valueName}` (operation `updateConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.getConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValue(groupName, valueName, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


getConfigurationGroupValues

Fetch the values for the specified configuration group

Return a representation of this configuration group values resource.


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.getConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValues(groupName, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroups

Return a collection of configuration groups

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of configuration groups. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/configurations/groups

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups?start=&limit=&sortBy=&filter=&q="
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.getConfigurationGroups()
var opts = {
  'start': 789, // {Long} The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of configuration group representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroups(opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of configuration group representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


updateConfigurationGroupValue

Update a single value associated with the specified configuration group

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's `schema`. The request body must conform to the configuration group's schema for the named `{valueName}`. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To fetch specific value, use `GET /accounts/configurations/groups/{groupName}/values/{valueName}` (operation `getConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.updateConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
var body = body_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValue(groupName, valueName, body, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required
Body parameters
Name Description
body *

The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


updateConfigurationGroupValues

Update the values for the specified configuration group

Perform a complete replacement of this set of values


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accounts/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/accounts-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Accounts.ConfigurationApi.updateConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var requestBody = ; // {map[String, configurationValue]} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValues(groupName, requestBody, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`*


ExternalAccount

createExternalAccount

Create a new external account

Create a new external account. A successful operation returns the full accountNumber.


/externalAccounts

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accounts/externalAccounts"
import { ExternalAccountApi } from "@apiture/accounts-client-sdk";

const externalAccountApi = new ExternalAccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
externalAccountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
externalAccountApi.setApiKey(apiKey);


var api = new Accounts.ExternalAccountApi.createExternalAccount()
var createExternalAccount = ; // {CreateExternalAccount} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
externalAccountApi.createExternalAccount(createExternalAccount, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Body parameters
Name Description
createExternalAccount *

The data necessary to create a new external account.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteExternalAccount

Delete this external account resource

Delete this external account resource and any resources that are owned by it. Note that only `pending` accounts may be deleted. Once an account has been activated, it cannot be deleted, only inactivated or removed from use.


/externalAccounts/{externalAccountId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///accounts/externalAccounts/{externalAccountId}"
import { ExternalAccountApi } from "@apiture/accounts-client-sdk";

const externalAccountApi = new ExternalAccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
externalAccountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
externalAccountApi.setApiKey(apiKey);


var api = new Accounts.ExternalAccountApi.deleteExternalAccount()
var externalAccountId = externalAccountId_example; // {String} The unique identifier of this external account. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
externalAccountApi.deleteExternalAccount(externalAccountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
externalAccountId*
String
The unique identifier of this external account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.

Responses


getExternalAccount

Fetch a representation of this external account

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this external account resource.


/externalAccounts/{externalAccountId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/externalAccounts/{externalAccountId}?unmasked=&embed="
import { ExternalAccountApi } from "@apiture/accounts-client-sdk";

const externalAccountApi = new ExternalAccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
externalAccountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
externalAccountApi.setApiKey(apiKey);


var api = new Accounts.ExternalAccountApi.getExternalAccount()
var externalAccountId = externalAccountId_example; // {String} The unique identifier of this external account. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example, // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
  'unmasked': true, // {Boolean} When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
  'embed':  // {array[String]} The `embed` query parameter specifies which related resources to include in the `_embedded` object in the response. `embed` supports the following comma-separated values: 
  • `owners` : for external accounts, include the external account owners in the `_embedded.accountOwners` object;
}; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; externalAccountApi.getExternalAccount(externalAccountId, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
externalAccountId*
String
The unique identifier of this external account. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
Query parameters
Name Description
unmasked
Boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
embed
array[String]
The `embed` query parameter specifies which related resources to include in the `_embedded` object in the response. `embed` supports the following comma-separated values: <ul> <li>`owners` : for external accounts, include the external account owners in the `_embedded.accountOwners` object;</li> </ul>

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this external account resource.


getExternalAccounts

Return a collection of external accounts

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of external accounts. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/externalAccounts

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accounts/externalAccounts?start=&limit=&sortBy=&state=&type=&name=&filter=&q=&unmasked=&embed="
import { ExternalAccountApi } from "@apiture/accounts-client-sdk";

const externalAccountApi = new ExternalAccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
externalAccountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
externalAccountApi.setApiKey(apiKey);


var api = new Accounts.ExternalAccountApi.getExternalAccounts()
var opts = {
  'start': 789, // {Long} The zero-based index of the first external account item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of external account representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'state': state_example, // {String} Subset the accounts or external accounts collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the accounts or external accounts collection to those with this exact `type` value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose `type` is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose `type` is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'name': name_example, // {String} Subset the accounts or external accounts collection to those with this `name` value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose `name` is `Bartell`; `?name=Bartell|kirsten` matches items whose `name` is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'unmasked': true, // {Boolean} When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
  'embed':  // {array[String]} If set, each external account in the `_embedded.items` array will include additional embedded objects. The `embed` query parameter specifies which related resources to include in the `_embedded` object in each account in response. `embed` supports the following values: 
  • `owners`: for external accounts, include the account owners in the `_embedded.accountOwners` object. (See the `externalAccountEmbeddedObjects` schema.)
}; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; externalAccountApi.getExternalAccounts(opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first external account item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of external account representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
state
String
Subset the accounts or external accounts collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the accounts or external accounts collection to those with this exact `type` value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose `type` is `Personal Savings`; `?type=Personal%20Savings|Investment%20Account` matches items whose `type` is `Personal Savings` or `Investment Account`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
name
String
Subset the accounts or external accounts collection to those with this `name` value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose `name` is `Bartell`; `?name=Bartell|kirsten` matches items whose `name` is `Bartell` or `kirsten`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
unmasked
Boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of `true`, to request that the response body includes the full account number. Such requests are auditable.
embed
array[String]
If set, each external account in the `_embedded.items` array will include additional embedded objects. The `embed` query parameter specifies which related resources to include in the `_embedded` object in each account in response. `embed` supports the following values: <ul> <li>`owners`: for external accounts, include the account owners in the `_embedded.accountOwners` object. (See the `externalAccountEmbeddedObjects` schema.) </li> </ul>

Responses


patchExternalAccount

Update this external account

Perform a partial update of this external account. Fields which are omitted from the request are not updated. Nested `_embedded` and `_links` are ignored if included. Bank users may only update the `routingNumber` and `accountNumbers.full` and `institutionName` and `type` if the external account is still `pending`. If `accountNumbers.full` is patched, then the full account number is included in the response. This operation does not change the `state` property. To change the `state` of the account, use the `POST` operations [`activateAccount`](#op-activateAccount), [`deactivateAccount`](#op-deactivateAccount), [`freezeAccount`](#op-freezeAccount), [`closeAccount`](#op-closeAccount), [`reviewExternalAccount`](#op-reviewExternalAccount) which are available in the `_links` on an account instance.


/externalAccounts/{externalAccountId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accounts/externalAccounts/{externalAccountId}"
import { ExternalAccountApi } from "@apiture/accounts-client-sdk";

const externalAccountApi = new ExternalAccountApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
externalAccountApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
externalAccountApi.setApiKey(apiKey);


var api = new Accounts.ExternalAccountApi.patchExternalAccount()
var externalAccountId = externalAccountId_example; // {String} The unique identifier of this external account. This is an opaque string.
var externalAccount = ; // {ExternalAccount} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
externalAccountApi.patchExternalAccount(externalAccountId, externalAccount, opts, callback);

Scopes

banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/write Write (update) access to accounts and account-related resources such as transfers and transactions.
banking/delete Delete access to deletable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `apiture/readBanking` scope in order to view balances, but is included in the `banking/full` scope.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Parameters

Path parameters
Name Description
externalAccountId*
String
The unique identifier of this external account. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If supplied, the value must match the current entity tag of the resource.
Body parameters
Name Description
externalAccount *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this external account resource.