Account Applications

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API.


/

Usage and SDK Samples

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

const aPIApi = new APIApi(configuration);

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


var api = new AccountApplications.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:///accountApplications/apiDoc"
import { APIApi } from "@apiture/account_applications-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new AccountApplications.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


AccountApplication

createApplication

Create a new account application

Create a new account application. This also creates and starts the workflow that is associated with the primary banking product in the request body. The client should execute any interactive workflow tasks until the workflow reaches a terminal state and the system approves or rejects the application or the user cancels the application. Users can have only one running application at a time.


/applications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/applications"
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.createApplication()
var createApplication = ; // {CreateApplication} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApplicationApi.createApplication(createApplication, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Body parameters
Name Description
createApplication *

The data necessary to create a new account application.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must 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`


deleteApplication

Delete an unused or expired application

Delete this account application resource. An application may only be deleted by the user if its `state` is `pending`, or by a financial institution if its `state` is `expired`.


/applications/{applicationId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///accountApplications/applications/{applicationId}"
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.deleteApplication()
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
var applicationId = applicationId_example; // {String} The unique identifier of this application. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
accountApplicationApi.deleteApplication(ifMatch, applicationId, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

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

Responses


getApplication

Fetch a representation of this account application

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


/applications/{applicationId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/applications/{applicationId}"
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.getApplication()
var applicationId = applicationId_example; // {String} The unique identifier of this application. 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);
  }
};
accountApplicationApi.getApplication(applicationId, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
applicationId*
String
The unique identifier of this application. 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 must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this account application resource.


getApplications

Return a collection of account applications

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/searching) collection of account applications. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. Not all nested objects are supported for filtering or sorting applications. The following fields may be used: `accountName`, `applicantName`, `productName`, `organizationName', `state`, `createdAt`, `completedAt`


/applications

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/applications?start=&limit=&sortBy=&applicant=&filter=&q="
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.getApplications()
var opts = {
  'start': 789, // {Long} The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of account application 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`.
  'applicant': applicant_example, // {String} Filter applications by applicant. The value must be an applicant's _contact_ URI, not the URI of a user. (To find applications for a _user_, pass the `href` from the `apiture:contact` link on the user resource.) An application resource is included in the response if and only if the named  contact is among the application's `applicants`. This query parameter exists for administrator use. The collection is automatically filtered to applications which a user created for non-administrator users.
  '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);
  }
};
accountApplicationApi.getApplications(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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of account application 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`.
applicant
String
Filter applications by applicant. The value must be an applicant's _contact_ URI, not the URI of a user. (To find applications for a _user_, pass the `href` from the `apiture:contact` link on the user resource.) An application resource is included in the response if and only if the named contact is among the application's `applicants`. This query parameter exists for administrator use. The collection is automatically filtered to applications which a user created for non-administrator users.
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


getBlockedApplications

Return a collection of blocked account applications

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/searching) collection of active running account applications. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is `blocked`.


/blockedApplications

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/blockedApplications?start=&limit=&sortBy=&filter=&q="
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.getBlockedApplications()
var opts = {
  'start': 789, // {Long} The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of account application 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);
  }
};
accountApplicationApi.getBlockedApplications(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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of account application 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


getRunningApplications

Return a collection of active, running account applications

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/searching) collection of active running account applications. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is `running`.


/runningApplications

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/runningApplications?start=&limit=&sortBy=&filter=&q=&state=&name="
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.getRunningApplications()
var opts = {
  'start': 789, // {Long} The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of account application 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).
  'state': state_example, // {String} Subset the applications 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=running|canceled` matches items whose `state` is `running` or `canceled`. 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 applications collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match 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).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApplicationApi.getRunningApplications(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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first account application item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of account application 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).
state
String
Subset the applications 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=running|canceled` matches items whose `state` is `running` or `canceled`. 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 applications collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match 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).

Responses


patchApplication

Update this account application

Perform a partial update of this account application. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/applications/{applicationId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accountApplications/applications/{applicationId}"
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.patchApplication()
var applicationId = applicationId_example; // {String} The unique identifier of this application. This is an opaque string.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
var application = ; // {Application} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApplicationApi.patchApplication(applicationId, ifMatch, application, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

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

Responses

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


updateApplication

Update this account application

Perform a complete replacement of this account application.


/applications/{applicationId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accountApplications/applications/{applicationId}"
import { AccountApplicationApi } from "@apiture/account_applications-client-sdk";

const accountApplicationApi = new AccountApplicationApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationApi.updateApplication()
var applicationId = applicationId_example; // {String} The unique identifier of this application. This is an opaque string.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
var application = ; // {Application} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
accountApplicationApi.updateApplication(applicationId, ifMatch, application, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

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

Responses

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


AccountApplicationActions

approveApplication

Approve an application

Approve an account application. This changes the `state` property of the application to `approved`. This operation is available via the `apiture:approve` link on the application resource, if and only if the application is eligible for the approve operation. The response is the updated representation of the application. The `If-Match` request header value, if passed, must match the current entity tag value of the application. This operation is valid if the current state of the application is `running`, or `blocked`. This operation does nothing if the state is already `approved`. This is a _terminal_ state: the application state cannot be changed once it has been approved.


/approvedApplications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/approvedApplications?application="
import { AccountApplicationActionsApi } from "@apiture/account_applications-client-sdk";

const accountApplicationActionsApi = new AccountApplicationActionsApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationActionsApi.approveApplication()
var application = application_example; // {String} A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the  URI of the application.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
accountApplicationActionsApi.approveApplication(application, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
application*
String
A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application.
Required

Responses

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


cancelApplication

Cancel an application

Cancel an account application. This changes the `state` property of the application to `canceled`. This also cancels the application workflow. This operation is available via the `apiture:cancel` link on the application resource, if and only if the application is eligible for the cancel operation. The response is the updated representation of the application. The `If-Match` request header value, if passed, must match the current entity tag value of the application. This operation is valid if the current state of the application is `running`, or `blocked`. This operation does nothing if the state is already `canceled`. This is a _terminal_ state: the application state cannot be changed once it has been canceled.


/canceledApplications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/canceledApplications?application="
import { AccountApplicationActionsApi } from "@apiture/account_applications-client-sdk";

const accountApplicationActionsApi = new AccountApplicationActionsApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationActionsApi.cancelApplication()
var application = application_example; // {String} A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the  URI of the application.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
accountApplicationActionsApi.cancelApplication(application, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
application*
String
A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application.
Required

Responses

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


expireApplication

Expire an application

Update an application by adding it to the set of expired applications. This changes the `state` property of the application to `expired`. This operation is available via the `apiture:expire` link on the application resource, if and only if the application is eligible for the expire operation. The response is the updated representation of the application. The `If-Match` request header value, if passed, must match the current entity tag value of the application. This operation is valid if the current state of the application is `running`, or `blocked`. This operation does nothing if the state is already `expired`. This is a _terminal_ state: the application state cannot be changed once it has expired.


/expiredApplications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/expiredApplications?application="
import { AccountApplicationActionsApi } from "@apiture/account_applications-client-sdk";

const accountApplicationActionsApi = new AccountApplicationActionsApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationActionsApi.expireApplication()
var application = application_example; // {String} A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the  URI of the application.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
accountApplicationActionsApi.expireApplication(application, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
application*
String
A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application.
Required

Responses

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


rejectApplication

Reject an application

Reject an account application. This changes the `state` property of the application to `rejected`. This operation is available via the `apiture:reject` link on the application resource, if and only if the application is eligible for the reject operation. The response is the updated representation of the application. The `If-Match` request header value, if passed, must match the current entity tag value of the application. This operation is valid if the current state of the application is `running`, or `blocked`. This operation does nothing if the state is already `rejected`. This is a _terminal_ state: the application state cannot be changed once it has been rejected.


/rejectedApplications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/rejectedApplications?application="
import { AccountApplicationActionsApi } from "@apiture/account_applications-client-sdk";

const accountApplicationActionsApi = new AccountApplicationActionsApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationActionsApi.rejectApplication()
var application = application_example; // {String} A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the  URI of the application.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
accountApplicationActionsApi.rejectApplication(application, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
application*
String
A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application.
Required

Responses

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


startApplication

Start an application

Start an application by adding it to the set of running applications. This changes the `state` property of the application to `running`. This operation is available via the `apiture:start` link on the application resource, if and only if the application is eligible for the start operation. The response is the updated representation of the application. The `If-Match` request header value, if passed, must match the current entity tag value of the application. This operation is only valid if the current state of the application is `blocked`. This operation does nothing if the state is already `running`.


/runningApplications

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/runningApplications?application="
import { AccountApplicationActionsApi } from "@apiture/account_applications-client-sdk";

const accountApplicationActionsApi = new AccountApplicationActionsApi(configuration);

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

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


var api = new AccountApplications.AccountApplicationActionsApi.startApplication()
var application = application_example; // {String} A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the  URI of the application.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
accountApplicationActionsApi.startApplication(application, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
application*
String
A string which uniquely identifies an application which is to added to the running applications resource set. This may be the unique applicationId or the URI of the application.
Required

Responses

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


Configuration

getConfiguration

Configuration definition for this API

Returns the configuration for this API


/configurations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/configurations"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.ConfigurationApi.getConfiguration()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfiguration(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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Responses


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:///accountApplications/configurations/groups/{groupName}"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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:///accountApplications/configurations/groups/{groupName}/schema"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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 must 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 /accountApplications/configurations/groups/{groupName}/values/{valueName}` (operation `updateConfigurationGroupValue`).


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

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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 must 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:///accountApplications/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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 must 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:///accountApplications/configurations/groups?start=&limit=&sortBy=&filter=&q="
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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 /accountApplications/configurations/groups/{groupName}/values/{valueName}` (operation `getConfigurationGroupValue`).


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

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accountApplications/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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 must 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:///accountApplications/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/account_applications-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 AccountApplications.ConfigurationApi.updateConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
var requestBody = ; // {map[String, configurationValue]} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValues(groupName, ifMatch, requestBody, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

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. This must match the current entity tag of the resource.
Required
Body parameters
Name Description
requestBody *

Responses

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


Enrollment

createEnrollment

Create a new enrollment

Create a new enrollment. Creating an enrollment will create and start the workflow that is defined for enrollment in digital banking. The client should execute any interactive workflow tasks until the workflow reaches a terminal state and the system approves or rejects the application or the user cancels the application. A user may have only one active enrollment at a time.


/enrollments

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/enrollments"
import { EnrollmentApi } from "@apiture/account_applications-client-sdk";

const enrollmentApi = new EnrollmentApi(configuration);

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

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


var api = new AccountApplications.EnrollmentApi.createEnrollment()
var createEnrollment = ; // {CreateEnrollment} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
enrollmentApi.createEnrollment(createEnrollment, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Body parameters
Name Description
createEnrollment *

The data necessary to create a new enrollment.

Responses

Name Type Format Description
ETag String An entity tag which may be passed in the `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`


deleteEnrollment

Delete this enrollment resource

Delete this enrollment resource and any resources that are owned by it.


/enrollments/{enrollmentId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///accountApplications/enrollments/{enrollmentId}"
import { EnrollmentApi } from "@apiture/account_applications-client-sdk";

const enrollmentApi = new EnrollmentApi(configuration);

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

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


var api = new AccountApplications.EnrollmentApi.deleteEnrollment()
var enrollmentId = enrollmentId_example; // {String} The unique identifier of this enrollment. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
enrollmentApi.deleteEnrollment(enrollmentId, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
enrollmentId*
String
The unique identifier of this enrollment. This is an opaque string.
Required

Responses


getEnrollment

Fetch a representation of this enrollment

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


/enrollments/{enrollmentId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/enrollments/{enrollmentId}"
import { EnrollmentApi } from "@apiture/account_applications-client-sdk";

const enrollmentApi = new EnrollmentApi(configuration);

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

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


var api = new AccountApplications.EnrollmentApi.getEnrollment()
var enrollmentId = enrollmentId_example; // {String} The unique identifier of this enrollment. 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);
  }
};
enrollmentApi.getEnrollment(enrollmentId, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
enrollmentId*
String
The unique identifier of this enrollment. 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 must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this enrollment resource.


getEnrollments

Return a collection of enrollments

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


/enrollments

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///accountApplications/enrollments?start=&limit=&sortBy=&filter=&q="
import { EnrollmentApi } from "@apiture/account_applications-client-sdk";

const enrollmentApi = new EnrollmentApi(configuration);

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

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


var api = new AccountApplications.EnrollmentApi.getEnrollments()
var opts = {
  'start': 789, // {Long} The zero-based index of the first enrollment item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of enrollment representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](http://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);
  }
};
enrollmentApi.getEnrollments(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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first enrollment item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of enrollment representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](http://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


patchEnrollment

Update this enrollment

Perform a partial update of this enrollment. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/enrollments/{enrollmentId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///accountApplications/enrollments/{enrollmentId}"
import { EnrollmentApi } from "@apiture/account_applications-client-sdk";

const enrollmentApi = new EnrollmentApi(configuration);

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

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


var api = new AccountApplications.EnrollmentApi.patchEnrollment()
var enrollmentId = enrollmentId_example; // {String} The unique identifier of this enrollment. This is an opaque string.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
var enrollment = ; // {Enrollment} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
enrollmentApi.patchEnrollment(enrollmentId, ifMatch, enrollment, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

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

Responses

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


updateEnrollment

Update this enrollment

Perform a complete replacement of this enrollment.


/enrollments/{enrollmentId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///accountApplications/enrollments/{enrollmentId}"
import { EnrollmentApi } from "@apiture/account_applications-client-sdk";

const enrollmentApi = new EnrollmentApi(configuration);

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

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


var api = new AccountApplications.EnrollmentApi.updateEnrollment()
var enrollmentId = enrollmentId_example; // {String} The unique identifier of this enrollment. This is an opaque string.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
var enrollment = ; // {Enrollment} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
enrollmentApi.updateEnrollment(enrollmentId, ifMatch, enrollment, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

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

Responses

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


EnrollmentActions

approveEnrollment

Approve an enrollment

Approve an enrollment. This changes the `state` property of the enrollment to `approved`. This operation is available via the `apiture:approve` link on the enrollment resource, if and only if the enrollment is eligible for the approve operation, if the user has completed all enrollment requirements such as passing identity verification and accepting digital banking terms of use and the financial institution's privacy policy. The response is the updated representation of the enrollment. The `If-Match` request header value, if passed, must match the current entity tag value of the enrollment. This operation is valid if the current state of the enrollment is `running`, or `blocked`. This operation does nothing if the state is already `approved`. This is a _terminal_ state: the enrollment state cannot be changed once it has been approved. This operation can be called by services or administrators only, not end users.


/approvedEnrollments

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/approvedEnrollments?enrollment="
import { EnrollmentActionsApi } from "@apiture/account_applications-client-sdk";

const enrollmentActionsApi = new EnrollmentActionsApi(configuration);

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

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


var api = new AccountApplications.EnrollmentActionsApi.approveEnrollment()
var enrollment = enrollment_example; // {String} A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
enrollmentActionsApi.approveEnrollment(enrollment, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
enrollment*
String
A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
Required

Responses

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


cancelEnrollment

Cancel an enrollment

Cancel an enrollment. This changes the `state` property of the enrollment to `canceled`. This operation is available via the `apiture:cancel` link on the enrollment resource, if and only if the enrollment is eligible for the cancel operation. The response is the updated representation of the enrollment. The `If-Match` request header value, if passed, must match the current entity tag value of the enrollment. This operation is valid if the current state of the enrollment is `running`, or `blocked`. This operation does nothing if the state is already `canceled`. This is a _terminal_ state: the enrollment state cannot be changed once it has been canceled.


/canceledEnrollments

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/canceledEnrollments?enrollment="
import { EnrollmentActionsApi } from "@apiture/account_applications-client-sdk";

const enrollmentActionsApi = new EnrollmentActionsApi(configuration);

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

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


var api = new AccountApplications.EnrollmentActionsApi.cancelEnrollment()
var enrollment = enrollment_example; // {String} A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
enrollmentActionsApi.cancelEnrollment(enrollment, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
enrollment*
String
A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
Required

Responses

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


rejectEnrollment

Reject an enrollment

Reject an enrollment. This changes the `state` property of the enrollment to `rejected`. This operation is available via the `apiture:reject` link on the enrollment resource, if and only if the enrollment is eligible for the reject operation. The response is the updated representation of the enrollment. The `If-Match` request header value, if passed, must match the current entity tag value of the enrollment. This operation is valid if the current state of the enrollment is `running`, or `blocked`. This operation does nothing if the state is already `rejected`. This is a _terminal_ state: the enrollment state cannot be changed once it has been rejected. Only service or administrator can call this operation, not end users.


/rejectedEnrollments

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///accountApplications/rejectedEnrollments?enrollment="
import { EnrollmentActionsApi } from "@apiture/account_applications-client-sdk";

const enrollmentActionsApi = new EnrollmentActionsApi(configuration);

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

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


var api = new AccountApplications.EnrollmentActionsApi.rejectEnrollment()
var enrollment = enrollment_example; // {String} A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
var ifMatch = ifMatch_example; // {String} The entity tag that was returned in the `ETag` response. This 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);
  }
};
enrollmentActionsApi.rejectEnrollment(enrollment, ifMatch, 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 editable accounts and account-related resources such as transfers.
banking/readBalance Read access to account balances. This must be granted in addition to the `banking/read` 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.
profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.
admin/read Read access to system configuration.
admin/write Write (update) access to system configuration.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match*
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Required
Query parameters
Name Description
enrollment*
String
A string which uniquely identifies an enrollment which is to added to the running enrollments resource set. This may be the unique enrollmentId or the URI of the enrollment.
Required

Responses

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