Shell HTTP JavaScript Node.JS Ruby Python Java Go

Account Applications v0.33.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This API manages applications to create new accounts. An account application coordinates the following resources necessary to complete the application:

These individual resources will be nested within in the full representation inside the application resource, but are omitted in the summary application representations that are returned in the applications collection. Only the banking product is required to create a new account application. The application retains snapshots of these objects as they existed when the application was reviewed.

An application may be seeded with initial data. This allows "pre-approved" applications from external sources. All completed applications (whether approved or rejected) are retained indefinitely for auditing purposes. Incomplete applications expire after 30 days of inactivity or a period specified by the financial institution in the service configuration.

Each banking product (such as a checking account or money market account) has an association to an account application workflow definition which defines the business process for opening a new account for that product. This workflow is a set of tasks the user must perform in order to open a new account for that product. This service instantiates the workflow, sets the accountApplication, accountApplicant, product, fundingAccount, and organization properties of the workflow instance, and starts the workflow.

Note: A task in the workflow typically performs the actual account creation. A valid account is necessary for an initial funding operation to occur.

Each application maintains a state field which indicates the state of that application: pending, running, canceled, expired, rejected, approved. The pending state is reserved for future use. The default state when creating a new application is running'

Allowed state transitions are:

The service will also change an application's state from blocked to running once the condition that is blocking the application has changed (such as completion of workflow tasks or financial institution approvals.)

This API also manages enrollments, which represent a new user enrolling in on-line digital banking. Enrollments consist of collecting personal information (name, address, phone, email, tax ID) and other personal data. Enrollments also support Customer Identification Program regulatory requirements, also known as "Know Your Customer", by verifying the user's identity and ensuring they are not involved with fraud or other risk factors. Enrollments are used when new users register in response to invitations to become joint owners or authorized signers on existing accounts. State transitions for enrollments are similar to those for applications. Note: This API uses the base path /accountApplications to avoid confusion with software applications.

Error Types

Error responses in this API may have one of the type values described below. See Errors for more information on error responses and error types.

applicationNotFound

Description: No applications were found for the specified applicationId.
Remediation: Check to make sure that the supplied applicationId corresponds to an apiture application resource.

applicationRefNotFound

Description: No application found for the given application query parameter.
Remediation: Supply the _id of an existing application.

emptyRequestBody

Description: The supplied request body was empty.
Remediation: Check to make sure the body is included in your request.

enrollmentRefNotFound

Description: No enrollment found for the given enrollment query parameter.
Remediation: Supply the _id of an existing enrollment.

invalidApplicationApproval

Description: Application can only be approved when the workflow is completed and any approval records are approved.
Remediation: Check the state of the workflow and associated approval records.

The attributes object in the error may have the following properties:

Property Type Description
currentState string The current state of the the application.
Example: running
workflowState string The current state of the workflow associated with the application.
Example: running
approvalStates [string] The state of the approvals in an application
Example: approved,rejected

invalidApplicationState

Description: Actions on applications may only be performed if they are in one of the required states.
Remediation: Check the state of your application and the applicable allowed state transitions in the Applications API documentation.

The attributes object in the error may have the following properties:

Property Type Description
currentState string The current state of the the application.
Example: expired
requestedState string The requested new state value in the request.
Example: approved
requiredStates [string] The set of states the application must be in for the requested state change to be valid.
Example: running,blocked

invalidGroupName

Description: No configurationGroup was found for the specified groupName.
Remediation: Check to make sure that the supplied groupName corresponds to an apiture transfer configuration group resource.

invalidPromotionCode

Description: The code is not valid, not valid for for this product, or has expired.
Remediation: Use a promotion valid code for the bankng product associated with this application.

invalidUnmaskedQueryParam

Description: Only the values of false or true can be supplied with the unmasked query parameter.
Remediation: Resubmit the operation without the query parameter or check the documentation for valid query params.

invalidValueName

Description: No configurationName was found for the specified valueName.
Remediation: Check to make sure that the supplied valueName corresponds to an apiture transfer configuration value resource.

invalidWorkflowState

Description: The application workflow is not in a state where application approval is allowed.
Remediation: Wait until the workflow is in the application approval task.

malformedApplicationUri

Description: The supplied applicationUri was malformed.
Remediation: Check to make sure that the supplied applicationUri corresponds to an apiture application resource.

productNotSupplied

Description: A link to the product was not supplied for the account.
Remediation: Include a link to a valid apiture product in the _links object of your request.

requiredApprovalsPending

Description: Required approvals in the approvals array and the optional organizationApprovals array are not yet approved or waived or canceled..
Remediation: First either approve or waive each of the other open approvals in this application.

unverifiedApplications

Description: Initial application is either in process or under review.
Remediation: Retry the operation when there are no other in process applications.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Authentication

Scope Scope Description
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 contacts 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.

Account Applications

Application for a new banking account

getRunningApplications

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/runningApplications \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/runningApplications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/runningApplications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/runningApplications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/runningApplications',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/runningApplications', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/runningApplications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/runningApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of active, running account applications

GET /runningApplications

Return a paginated sortable filterable searchable collection of active running account applications. The links in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is running.

Parameters

Parameter Description
start
(query)		 integer(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
(query)		 integer(int32)
The maximum number of account application representations to return in this page.
Default: 100
sortBy
(query)		 string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
This collection may be sorted by the following properties:
• name
• state
• productTarget
• productName
• updatedAt.
filter
(query)		 string
Optional filter criteria. See filtering.
This collection may be filtered by the following properties and functions:
• Property name using functions eq, ne, lt, le, gt, ge, startsWith, endsWith, contains, search
• Property state using functions eq, ne, in.
q
(query)		 string
Optional search string. See searching.
state
(query)		 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.
array[string] values: pending, running, blocked, canceled, expired, rejected, approved
name
(query)		 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.
reviewedBy
(query)		 string
Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected.
maxLength: 48
enrollment
(query)		 string
Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected.
maxLength: 80

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "account applications",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "6 Month CD",
        "state": "approved"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: applications
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getBlockedApplications

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/blockedApplications \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/blockedApplications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/blockedApplications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/blockedApplications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/blockedApplications',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/blockedApplications', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/blockedApplications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/blockedApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of blocked account applications

GET /blockedApplications

Return a paginated sortable filterable searchable collection of active running account applications. The links in the response include pagination links. This is a virtual view of all applications, filtered to those whose state is blocked.

Parameters

Parameter Description
start
(query)		 integer(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
(query)		 integer(int32)
The maximum number of account application representations to return in this page.
Default: 100
sortBy
(query)		 string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter
(query)		 string
Optional filter criteria. See filtering.
q
(query)		 string
Optional search string. See searching.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "account applications",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "6 Month CD",
        "state": "approved"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: applications
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getApplications

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/applications \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/applications HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/applications',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/applications', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/applications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of account applications

GET /applications

Return a paginated sortable filterable searchable collection of account applications. The links in the response include pagination links.

Parameters

Parameter Description
start
(query)		 integer(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
(query)		 integer(int32)
The maximum number of account application representations to return in this page.
Default: 100
sortBy
(query)		 string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
This collection may be sorted by the following properties:
• applicantName
• productName
• organizationName
• state
• workflowState
• createdAt
• reviewedAt
• completedAt
• reviewerLastName.
applicant
(query)		 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. For non-administrator users, the collection is automatically filtered to applications which a user created.
reviewedBy
(query)		 string
Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected.
maxLength: 48
enrollment
(query)		 string
Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected.
maxLength: 80
filter
(query)		 string
Optional filter criteria. See filtering.
This collection may be filtered by the following properties and functions:
• Property createdAt using functions lt, le, gt, ge
• Property updatedAt using functions lt, le, gt, ge
• Property completedAt using functions lt, le, gt, ge
• Property state using functions lt, le, gt, ge, eq, ne, in
• Property workflowState using functions lt, le, gt, ge, eq, ne, in
• Property flaggedForReview using functions eq, ne
• Property productName using functions eq, in, startsWith, contains
• Property applicantName using functions eq, in, startsWith
• Property reviewerLastName using functions eq, in, startsWith
• Property user using functions eq, in.
q
(query)		 string
Optional search string. See searching.
user
(query)		 string
An operator or admin may use this to select a user in order to retrieve account applications owned by that user. The value is the _id of the User resource.
minLength: 16
maxLength: 48

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "account applications",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "6 Month CD",
        "state": "approved"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: applications
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createApplication

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/applications \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/applications HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/createApplication/v3.3.0/profile.json",
  "_links": {
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "accountName": "My checking account",
  "applicants": {
    "0": {
      "username": "Snowqueen123",
      "contact": {
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
          }
        }
      },
      "role": {
        "name": "primaryUser",
        "label": "Primary User",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
          }
        }
      }
    }
  },
  "products": {
    "0": {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/applications',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/applications', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/applications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new account application

POST /applications

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.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/createApplication/v3.3.0/profile.json",
  "_links": {
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "accountName": "My checking account",
  "applicants": {
    "0": {
      "username": "Snowqueen123",
      "contact": {
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
          }
        }
      },
      "role": {
        "name": "primaryUser",
        "label": "Primary User",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
          }
        }
      }
    }
  },
  "products": {
    "0": {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  }
}

Parameters

Parameter Description
body
(body)		 createApplication (required)
The data necessary to create a new account application.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
201 Created
Created.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity

Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
201 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
201 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.

getApplication

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this account application

GET /applications/{applicationId}

Return a HAL representation of this account application resource.

Parameters

Parameter Description
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.
unmasked
(query)		 boolean
When requesting an application, the full taxId of the applicant resource is not included in the response by default, for security reasons. Include this query parameter, with a value of true, to request that the response body includes the applicant's full tax Id number. Such requests are auditable.
If-None-Match
(header)		 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.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK.
Schema: application
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


PUT https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this account application

PUT /applications/{applicationId}

Perform a complete replacement of this account application.

Many properties of an application are effectively immutable by the user after the application has started and only an administrator or service application may update them. Users may use updateApplication or patchApplication to update the accountName, fundingAmount, fundingAccount, documents. Note: Updates to an application after the account has been created do not affect the account.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Parameters

Parameter Description
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)		 application (required)
Represents an application to open a banking account.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

patchApplication

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this account application

PATCH /applications/{applicationId}

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

Many properties of an application are effectively immutable by the user after the application has started and only an administrator or service application may update them. Users may use updateApplication or patchApplication to update the accountName, fundingAmount, fundingAccount, documents. Note: Updates to an application after the account has been created do not affect the account.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Parameters

Parameter Description
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)		 application (required)
Represents an application to open a banking account.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

deleteApplication

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/accountApplications/applications/{applicationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.devbank.apiture.com/accountApplications/applications/{applicationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete an unused or expired application

DELETE /applications/{applicationId}

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.

Parameters

Parameter Description
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.

Try It

Example responses

409 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": {}
    }
  }
}

Responses

StatusDescription
204 No Content
No Content. The resource was deleted successfully.
StatusDescription
409 Conflict
Conflict. An application not be deleted by the applicant if the state is anything other than pending, or by the financial institution if the state is expired.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Account Application Actions

Operations to update the state of an application

expireApplication

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/expiredApplications',
  method: 'post',
  data: '?application=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/expiredApplications',
  params: {
  'application' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/expiredApplications', params={
  'application': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/expiredApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/expiredApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Expire an application

POST /expiredApplications

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.

Parameters

Parameter Description
application
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to expired.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/rejectedApplications',
  method: 'post',
  data: '?application=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/rejectedApplications',
  params: {
  'application' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/rejectedApplications', params={
  'application': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/rejectedApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/rejectedApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Reject an application

POST /rejectedApplications

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.

Parameters

Parameter Description
application
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to rejected.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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.

approveApplication

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/approvedApplications',
  method: 'post',
  data: '?application=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/approvedApplications',
  params: {
  'application' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/approvedApplications', params={
  'application': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/approvedApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/approvedApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Approve an application

POST /approvedApplications

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. Applications may be approved only if the associated workflow (if any) is on an application approval task, and all approvals in the application have been approved or waived.

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.

Parameters

Parameter Description
application
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to approved.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/canceledApplications',
  method: 'post',
  data: '?application=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/canceledApplications',
  params: {
  'application' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/canceledApplications', params={
  'application': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/canceledApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/canceledApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Cancel an application

POST /canceledApplications

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.

Parameters

Parameter Description
application
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to canceled.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/runningApplications?application=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/runningApplications?application=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/runningApplications',
  method: 'post',
  data: '?application=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/runningApplications?application=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/runningApplications',
  params: {
  'application' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/runningApplications', params={
  'application': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/runningApplications?application=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/runningApplications", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Start an application

POST /runningApplications

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.

Parameters

Parameter Description
application
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The application was updated and its state changed to running.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The application parameter was malformed or does not refer to an existing or accessible application.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to change the state of the application is not allowed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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.

Enrollments

Operations to update an enrollment

getEnrollments

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/enrollments \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/enrollments HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/enrollments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/enrollments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/enrollments', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/enrollments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of enrollments

GET /enrollments

Return a paginated sortable filterable searchable collection of enrollments. The links in the response include pagination links.

Parameters

Parameter Description
start
(query)		 integer(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
(query)		 integer(int32)
The maximum number of enrollment representations to return in this page.
Default: 100
sortBy
(query)		 string
Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
This collection may be sorted by the following properties:
• applicantName
• state
• workflowState
• createdAt
• updatedAtAt
• completedAt
• reviewerLastName.
reviewedBy
(query)		 string
Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected.
maxLength: 48
enrollment
(query)		 string
Filter the collection by the ID of the operator who reviewed and approved or rejected the application or enrollment. Use "<system>" to list applications or enrollments that the system automatically approved or rejected.
maxLength: 80
filter
(query)		 string
Optional filter criteria. See filtering.
This collection may be filtered by the following properties and functions:
• Property createdAt using functions lt, le, gt, ge
• Property updatedAt using functions lt, le, gt, ge
• Property completedAt using functions lt, le, gt, ge
• Property state using functions lt, le, gt, ge, eq, ne, in
• Property workflowState using functions lt, le, gt, ge, eq, ne, in
• Property flaggedForReview using functions eq, ne
• Property reviewerLastName using functions eq, in, startsWith
• Property user using functions eq, in.
q
(query)		 string
Optional search string. See searching.
user
(query)		 string
An operator or admin may use this to select a user in order to retrieve enrollments owned by that user. The value is the _id of the User resource.
minLength: 16
maxLength: 48

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/enrollments/v2.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryEnrollment/v1.8.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryEnrollment/v1.8.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "state": "approved"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollments
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

createEnrollment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/enrollments \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/enrollments HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/enrollments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/enrollments',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/enrollments', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/enrollments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new enrollment

POST /enrollments

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.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Parameters

Parameter Description
body
(body)		 createEnrollment (required)
The data necessary to create a new enrollment.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
201 Created
Created.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
201 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
201 ETag string
An entity tag which may be passed in the If-Match request header for PUT or PATCH operations which update the resource.

getEnrollment

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this enrollment

GET /enrollments/{enrollmentId}

Return a HAL representation of this enrollment resource.

Parameters

Parameter Description
enrollmentId
(path)		 string (required)
The unique identifier of this enrollment. This is an opaque string.
If-None-Match
(header)		 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.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollment
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found
Not Found. There is no such enrollment resource at the specified {enrollmentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


PUT https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this enrollment

PUT /enrollments/{enrollmentId}

Perform a complete replacement of this enrollment.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Parameters

Parameter Description
enrollmentId
(path)		 string (required)
The unique identifier of this enrollment. This is an opaque string.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)		 enrollment (required)
Represents a user's enrollment in digital banking.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found
Not Found. There is no such enrollment resource at the specified {enrollmentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

patchEnrollment

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


PATCH https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this enrollment

PATCH /enrollments/{enrollmentId}

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

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Parameters

Parameter Description
enrollmentId
(path)		 string (required)
The unique identifier of this enrollment. This is an opaque string.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)		 enrollment (required)
Represents a user's enrollment in digital banking.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found
Not Found. There is no such enrollment resource at the specified {enrollmentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

deleteEnrollment

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


DELETE https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId} HTTP/1.1
Host: api.devbank.apiture.com


var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this enrollment resource

DELETE /enrollments/{enrollmentId}

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

Parameters

Parameter Description
enrollmentId
(path)		 string (required)
The unique identifier of this enrollment. This is an opaque string.

Try It

Responses

StatusDescription
204 No Content
No Content. The resource was deleted successfully.

Enrollment Actions

Operations which act on enrollments

expireEnrollment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/expiredEnrollments?enrollment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/expiredEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/expiredEnrollments',
  method: 'post',
  data: '?enrollment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/expiredEnrollments?enrollment=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/expiredEnrollments',
  params: {
  'enrollment' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/expiredEnrollments', params={
  'enrollment': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/expiredEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/expiredEnrollments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Expire an enrollment

POST /expiredEnrollments

Update an enrollment by adding it to the set of expired enrollments. This changes the state property of the enrollment to expired. This operation is available via the apiture:expire link on the enrollment resource, if and only if the enrollment is eligible for the expire 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 expired. This is a terminal state: the enrollment state cannot be changed once it has expired.

Parameters

Parameter Description
enrollment
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to expired.
Schema: application
StatusDescription
400 Bad Request

Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict
Conflict. The request to expire the enrollment is not allowed. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/rejectedEnrollments',
  method: 'post',
  data: '?enrollment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/rejectedEnrollments',
  params: {
  'enrollment' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/rejectedEnrollments', params={
  'enrollment': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/rejectedEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/rejectedEnrollments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Reject an enrollment

POST /rejectedEnrollments

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.

Parameters

Parameter Description
enrollment
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to rejected.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict
Conflict. The request to reject the enrollment is not allowed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

approveEnrollment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/approvedEnrollments',
  method: 'post',
  data: '?enrollment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/approvedEnrollments',
  params: {
  'enrollment' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/approvedEnrollments', params={
  'enrollment': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/approvedEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/approvedEnrollments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Approve an enrollment

POST /approvedEnrollments

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.

Parameters

Parameter Description
enrollment
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to approved.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The request to approve the enrollment is not allowed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/canceledEnrollments',
  method: 'post',
  data: '?enrollment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/canceledEnrollments',
  params: {
  'enrollment' => 'string'
}, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/canceledEnrollments', params={
  'enrollment': 'string'
}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/canceledEnrollments?enrollment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/canceledEnrollments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Cancel an enrollment

POST /canceledEnrollments

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.

Parameters

Parameter Description
enrollment
(query)		 string (required)
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.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to canceled.
Schema: enrollment
StatusDescription
400 Bad Request

Bad Request. The enrollment parameter was malformed or does not refer to an existing or accessible enrollment.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
409 Conflict
Conflict. The request to cancel the enrollment is not allowed. The _error field in the response will contain details about the request error.
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

Promotions

Promotions and offers

addApplicationTrackingIds

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/createResourceTrackingIds/v1.1.0/profile.json",
  "_links": {},
  "trackingIds": {
    "0": "2dd86cdb-2a50-4079-a246-6486135a0ca2"
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Add tracking IDs to an application

POST /applications/{applicationId}/trackingIds

Add one or more tracking IDs to an application. Clients can add tracking IDs to associate an application with a promotion, campaign, or some other business process. Duplicate tracking IDs (within the input or already on this application) are ignored.

Tracking IDs added to this application are also automatically added to any new account resources opened by this application process.

If adding new IDs would exceed the maximum of 150 per application, this operation removes the oldest tracking ID(s) to make room for the new ones.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/createResourceTrackingIds/v1.1.0/profile.json",
  "_links": {},
  "trackingIds": {
    "0": "2dd86cdb-2a50-4079-a246-6486135a0ca2"
  }
}

Parameters

Parameter Description
body
(body)		 createResourceTrackingIds
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/resourceTrackingIds/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId/trackingIds"
    },
    "apiture:resource": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "trackingIds": {
    "0": {
      "id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
      "createdAt": "2021-06-07T09:11:02.375Z"
    },
    "1": {
      "id": "55c9141a-94d5-4ae8-b664-9ac4c9eaea2d",
      "createdAt": "2021-07-011T15:33:00.375Z"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: resourceTrackingIds
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which may be provided in an If-None-Match request header for future GET operations which update this application resource.

getApplicationTrackingIds

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/trackingIds", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the application's tracking IDs

GET /applications/{applicationId}/trackingIds

Return a HAL representation of the list of tracking IDs that have been added to this application via addApplicationTrackingIds. The response includes an empty array if there are no tracking IDs. The IDs in the response are sorted chronologically from earliest to latest.

Parameters

Parameter Description
If-None-Match
(header)		 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.
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/resourceTrackingIds/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId/trackingIds"
    },
    "apiture:resource": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "trackingIds": {
    "0": {
      "id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
      "createdAt": "2021-06-07T09:11:02.375Z"
    },
    "1": {
      "id": "55c9141a-94d5-4ae8-b664-9ac4c9eaea2d",
      "createdAt": "2021-07-011T15:33:00.375Z"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: resourceTrackingIds
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which may be provided in an If-None-Match request header for future GET operations which update this application resource.

validatePromotion

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


POST https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/promotionCode/v1.0.0/profile.json",
  "_links": {},
  "code": "SAVE2021"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/accountApplications/applications/{applicationId}/validatedPromotionCodes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Validate promotion codes for new accounts

POST /applications/{applicationId}/validatedPromotionCodes

Validate a customer-submitted code for an account offer or promotion.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/promotionCode/v1.0.0/profile.json",
  "_links": {},
  "code": "SAVE2021"
}

Parameters

Parameter Description
body
(body)		 promotionCode (required)
The promotion code to validate.
applicationId
(path)		 string (required)
The unique identifier of this application. This is an opaque string.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/validatedPromotionCode/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "code": "SAVE2021",
  "valid": true
}

Responses

StatusDescription
200 OK
OK.
Schema: validatedPromotionCode
StatusDescription
400 Bad Request
Bad Request.
Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such application resource at the specified {applicationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity

Unprocessable Entity.

This error response may have one of the following type values:

Schema: errorResponse

API

The Applications API

getLabels

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/labels \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'


GET https://api.devbank.apiture.com/accountApplications/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string


var headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/labels',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/accountApplications/labels',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'Accept-Language' => 'string',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/labels',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'Accept-Language': 'string',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/labels', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/labels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "Accept-Language": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/labels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Localized Labels

GET /labels

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

Parameters

Parameter Description
Accept-Language
(header)		 string
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "groups": {
    "fristGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: labelGroups

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'


GET https://api.devbank.apiture.com/accountApplications/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/accountApplications/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET /

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

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

StatusDescription
200 OK
OK.
Schema: root

getApiDoc

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'


GET https://api.devbank.apiture.com/accountApplications/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json


var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/accountApplications/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/apiDoc', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try It

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK.
Schema: Inline

Response Schema

Configuration

A set of endpoints that allows for the creation and retrieval of configuration options specific to this service

getConfigurationGroups

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/configurations/groups HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of configuration groups

GET /configurations/groups

Return a paginated sortable filterable searchable collection of configuration groups. The links in the response include pagination links.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: configurationGroups
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getConfigurationGroup

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this configuration group

GET /configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

Parameter Description
groupName
(path)		 string (required)
The unique name of this configuration group.
If-None-Match
(header)		 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.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: configurationGroup
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
200 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

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the schema for this configuration group

GET /configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

Parameter Description
groupName
(path)		 string (required)
The unique name of this configuration group.
If-None-Match
(header)		 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.

Try It

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: configurationSchema
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

getConfigurationGroupValues

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string


var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the values for the specified configuration group

GET /configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

Parameter Description
groupName
(path)		 string (required)
The unique name of this configuration group.
If-None-Match
(header)		 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.

Try It

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Responses

StatusDescription
200 OK
OK.
Schema: configurationValues
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
404 Not Found

Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

updateConfigurationGroupValues

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = '{
  "dailyLimit": 5,
  "cutoffTime": 63000
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update the values for the specified configuration group

PUT /configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Parameters

Parameter Description
groupName
(path)		 string (required)
The unique name of this configuration group.
If-Match
(header)		 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body
(body)		 configurationValues (required)

Try It

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: configurationSchema
StatusDescription
400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
404 Not Found

Not Found. There is no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT

getConfigurationGroupValue

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json


var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a single value associated with the specified configuration group

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

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

Examples:

To update a specific value, use PUT /accountApplications/configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

Parameter Description
groupName
(path)		 string (required)
The unique name of this configuration group.
valueName
(path)		 string (required)
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 | '-' | '_']*.

Try It

Example responses

200 Response

"string"

Responses

StatusDescription
200 OK
OK. The value of the named configuration value as a JSON string, number, boolean, array, or object.
Schema: string
StatusDescription
404 Not Found

Not Found. There is either no such configuration group resource at the specified {groupName} or no such value at the specified {valueName}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

Schema: errorResponse

Response Headers

StatusDescription
200 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.

updateConfigurationGroupValue

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'


PUT https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json


var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})


const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}',
  params: {
  }, headers: headers

p JSON.parse(result)


import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());


package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update a single value associated with the specified configuration group

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

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

Examples:

To fetch specific value, use GET /accountApplications/configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

Parameter Description
groupName
(path)		 string (required)
The unique name of this configuration group.
valueName
(path)		 string (required)
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 | '-' | '_']*.
body
(body)		 string (required)
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.

Try It

Example responses

200 Response

"string"

Responses

StatusDescription
200 OK
OK.
Schema: string
StatusDescription
403 Forbidden
Access denied. Only user allowed to update configurations is an admin.
Schema: errorResponse

Response Headers

StatusDescription
200 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.

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Abstract Resource (v2.0.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only

accountNumbers

{
  "masked": "*************3210",
  "full": "9876543210"
}

Account Numbers (v1.0.0)

Different representations of an account number.

This schema was resolved from common/accountNumbers.

Properties

NameDescription
masked string
A partial account number that does not contain all the digits of the full account number. This masked number appears in statements or in user experience presentation. It is sufficient for a user to differentiate this account from other accounts they hold, but is not sufficient for initiating transfers, etc. The first character is the mask character and is repeated; this does not indicate that the full account number is the same as the mask length. This value is derived and immutable.
read-only
minLength: 8
maxLength: 32
full string
The full account number. This value only appears when ?unmasked=true is passed on the GET request. Not included in the summary representation of the account that is included in account collection responses. This value is derived and immutable.
read-only
minLength: 4
maxLength: 17

accountPurpose

"unknown"

Account purpose (v1.0.0)

The purpose of the account.

Warning: the enum list will be removed in a future release and the values defined at runtime via the accountPurpose group in the response from the getLabels operation.

This schema was resolved from organizations/accountPurpose.

Type: string
Enumerated values:
unknown
creditCardProcessing
generalOperatingFunds
lottery
payroll
savings
other
notApplicable

accrualType

"compounding"

Accrual Type (v1.0.0)

Indicates how interest is accrued according to the compoundPeriod.

accrualType strings may have one of the following enumerated values:

ValueDescription
compoundingCompounding interest
simpleSimple interest

These enumeration values are further described by the label group named accrualType in the response from the getLabels operation.

This schema was resolved from products/accrualType.

Type: string
Enumerated values:
compounding
simple

address

{
  "label": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "st"
}

Address (v1.0.0)

A postal address.

This schema was resolved from businessVerifications/address.

Properties

NameDescription
label string
A text label, suitable for presentation to the user. This is also used if type is other.
addressLine1 string (required)
The first street address line of the address, normally a house number and street name.
addressLine2 string
The optional second street address line of the address.
city string (required)
The name of the city or municipality.
regionCode string (required)
The mailing address region code, such as state in the US, or a province in Canada.
postalCode string (required)
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
countryCode string
The ISO 3166-1 country code.
minLength: 2
maxLength: 2

addressType

"unknown"

Address Type (v1.0.0)

The type of a postal address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named addressType in the response from the getLabels operation.

This schema was resolved from contacts/addressType.

Type: string
Enumerated values:
unknown
home
prior
work
school
mailing
vacation
shipping
billing
headquarters
commercial
site
property
other
notApplicable

applicant

{
  "username": "string",
  "contact": {
    "firstName": "John",
    "middleName": "Daniel",
    "lastName": "Smith",
    "preferredName": "John",
    "suffix": "MD",
    "identification": {
      "0": {
        "type": "taxId",
        "value": "*****3333"
      }
    },
    "emailAddresses": {
      "0": {
        "_id": "ea1",
        "value": "api@apiture.com",
        "type": "personal",
        "id": "pe0"
      },
      "1": {
        "_id": "ek3",
        "value": "support@apiture.com",
        "type": "work",
        "id": "wp1"
      }
    },
    "preferredEmailAddressId": "ea1",
    "phones": {
      "0": {
        "_id": "pa1",
        "type": "home",
        "number": "+19105550155"
      },
      "1": {
        "_id": "da6",
        "type": "mobile",
        "number": "+19105550155"
      },
      "2": {
        "_id": "wp1",
        "type": "work",
        "number": "+19105550162",
        "extension": "4512"
      }
    },
    "preferredPhoneId": "pa1",
    "birthdate": "1974-10-27",
    "citizenship": {
      "0": {
        "countryCode": "US",
        "state": "citizen"
      }
    },
    "residencyStatus": "resident",
    "occupation": "officeAndAdministrativeSupport",
    "addresses": {
      "0": {
        "_id": "ha1",
        "type": "home",
        "addressLine1": "555 N Front Street",
        "addressLine2": "Suite 5555",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28401-5405",
        "countryCode": "US"
      },
      "1": {
        "_id": "wa1",
        "type": "work",
        "addressLine1": "123 S 3rd Street",
        "addressLine2": "Apt 42",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28411-5405",
        "countryCode": "US"
      }
    },
    "preferredMailingAddressId": "ha1",
    "yearsAtAddress": 3,
    "mailingDifferentAddress": false,
    "state": "active",
    "preferredContactMethod": "email",
    "_profile": "https://production.api.apiture.com/schemas/contacts/contact/v2.1.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
      },
      "apiture:deactivate": {
        "href": "https://api.devbank.apiture.com/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    },
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
    "createdAt": "2018-04-17T10:04:46.375Z",
    "updatedAt": "2018-04-17T10:12:58.375Z"
  },
  "user": {
    "_profile": "https://production.api.apiture.com/schemas/users/summaryUser/v1.8.0/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
      }
    },
    "firstName": "John",
    "middleName": "Daniel",
    "lastName": "Smith",
    "addresses": {
      "0": {
        "_id": "ha0",
        "type": "home",
        "addressLine1": "555 N Front Street",
        "addressLine2": "Suite 5555",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28401-5405",
        "countryCode": "US",
        "state": "approved",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha0"
          },
          "apiture:setAsPreferred": {
            "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredAddress?value=ha0"
          },
          "apiture:setAsTaxAddress": {
            "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/taxAddress?value=ha0"
          }
        }
      },
      "1": {
        "_id": "ha1",
        "type": "residential",
        "addressLine1": "123 S 3rd Street",
        "addressLine2": "Apt 42",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28411-5405",
        "countryCode": "US",
        "state": "approved",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
          },
          "apiture:setAsPreferred": {
            "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredAddress?value=ha1"
          },
          "apiture:setAsTaxAddress": {
            "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/taxAddress?value=ha1"
          }
        }
      }
    },
    "preferredMailingAddressId": "ha0",
    "emailAddresses": {
      "0": {
        "id": "pe0",
        "value": "johnny1733@example.com",
        "type": "personal",
        "_id": "pe0"
      },
      "1": {
        "id": "wp1",
        "value": "support@apiture.com",
        "type": "work",
        "_id": "we0"
      }
    },
    "preferredEmailAddressId": "pe0",
    "phones": {
      "0": {
        "_id": "hp0",
        "type": "home",
        "number": "+19105550155"
      },
      "1": {
        "_id": "mp0",
        "type": "mobile",
        "number": "+19105550159"
      },
      "2": {
        "_id": "wp1",
        "type": "work",
        "number": "+19105550162",
        "extension": "4512"
      }
    },
    "preferredPhoneId": "hp0",
    "preferredName": "John",
    "suffix": "MD",
    "identification": {
      "0": {
        "type": "taxId",
        "value": "111-11-1111",
        "emailAddresses": {
          "0": {
            "_id": "pe0",
            "type": "personal",
            "value": "johnny1733@example.com"
          },
          "1": {
            "_id": "we0",
            "type": "work",
            "value": "support@apiture.com"
          }
        }
      }
    },
    "preferredContactMethod": "email",
    "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
    "username": "Johnny1733",
    "residencyStatus": "resident",
    "customerId": "00047294723672",
    "birthdate": "1974-10-27",
    "citizenship": {
      "0": {
        "countryCode": "US",
        "state": "citizen"
      }
    },
    "occupation": "officeAndAdministrativeSupport",
    "taxAddressId": "ha1",
    "yearsAtAddress": "fourOrMore",
    "state": "active",
    "attributes": {}
  },
  "role": {
    "name": "primaryUser",
    "label": "Primary User",
    "description": "The account owner has full control across the account.\n\nThere may be only one primary user.",
    "_profile": "https://production.api.apiture.com/schemas/associations/role/v1.0.0/profile.json",
    "_links": {
      "self": {
        "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    },
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
    "createdAt": "2018-02-01T13:07:01.375Z"
  },
  "verification": {
    "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
      },
      "apiture:user": {
        "href": "https://api.devbank.apiture.com/users/users/6da5ccc7-727a-4256-bdd4-74023ae349c3"
      }
    },
    "verifications": {
      "0": {
        "type": "fraudRiskReport",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
          }
        },
        "state": "passed",
        "createdAt": "2018-01-12T10:15:17Z"
      },
      "1": {
        "type": "quiz",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
          }
        },
        "state": "passed",
        "createdAt": "2018-01-12T10:19:41Z"
      }
    }
  },
  "approvals": [
    {
      "_profile": "https://production.api.apiture.com/schemas/approvals/approval/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:approvalType": {
          "href": "https://production.api.apiture.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
        },
        "apiture:target": {
          "href": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
        }
      },
      "state": "approved",
      "done": true,
      "label": "Government Issued ID",
      "typeName": "governmentId",
      "description": "A document that identifies a user",
      "reviewedBy": "/users/users/0399abed-fd3d-4830-a88b-30f38b8a365c",
      "reviewedAt": "2018-04-17T10:12:58.375Z",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "reason": "Invalid U.S. Address",
      "createdAt": "2018-04-17T10:04:46.375Z",
      "updatedAt": "2018-04-17T10:12:58.375Z",
      "_embedded": {
        "approvalType": {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://production.api.apiture.com/schemas/approvals/approvalType/v1.1.0/profile.json",
          "_links": {
            "self": {
              "href": "https://production.api.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
            }
          },
          "name": "governmentId",
          "label": "Government Issued ID",
          "description": "A document that identifies a user"
        }
      }
    }
  ],
  "consents": [
    {
      "_profile": "https://production.api.apiture.com/schemas/consents/consent/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:revoke": {
          "href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:rescind": {
          "href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "document": {
        "uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
        "contentType": "application/pdf",
        "revisedAt": "2019-07-23T08:26:45.375Z",
        "revisionId": "2019:1.02.0"
      },
      "type": "productTermsAndConditions",
      "userId": "5a5e834c-a7bd-401c",
      "state": "given",
      "contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
      "givenAt": "2019-07-23T13:27:34.375Z"
    }
  ],
  "fraudReport": {
    "_profile": "https://production.api.apiture.com/schemas/identity/fraudRiskReport/v2.1.0/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
      },
      "apiture:user": {
        "href": "https://api.devbank.apiture.com/users/users/6da5ccc7-727a-4256-bdd4-74023ae349c3"
      }
    },
    "_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
    "type": "fraudRiskReport",
    "inputs": {
      "identity": {
        "taxId": "*****3333",
        "firstName": "John",
        "lastName": "Smith",
        "address1": "1741 Tiburon Dr",
        "city": "Wilmington",
        "region": "NC",
        "postalCode": "28403",
        "phone": "555-555-5555",
        "birthdate": "1940-10-15",
        "email": "api@apiture.com",
        "ipAddress": "127.0.0.1"
      }
    },
    "outputs": {
      "state": "passedWithRiskFactors",
      "fraudRiskCategories": {
        "0": {
          "type": "personalInfoDoesNotMatch",
          "description": "The retrieved identity does not match the provided PII."
        },
        "1": {
          "type": "addressIsHighRisk",
          "description": "The provided address is considered high-risk"
        },
        "2": {
          "type": "addressIsPOBoxOrNonApproved",
          "description": "The provided address is a PO Box or other non-approved address"
        },
        "3": {
          "type": "identityOnGovernmentWatchlist",
          "description": "The provided identity is located on one or more watchlists"
        },
        "4": {
          "type": "ipRestricted",
          "description": "The provided IP address is restricted"
        },
        "5": {
          "type": "emailRestricted",
          "description": "The provided email address is restricted"
        },
        "6": {
          "type": "nonStandardTaxId",
          "description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
        },
        "7": {
          "type": "ageRestricted",
          "description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
        }
      },
      "token": "m8JhbGciOiJIUzI1NiIsInRjWgQzWXcXNrz0ogtVhfEd2o"
    }
  },
  "verified": true,
  "verificationToken": "string"
}

Applicant (v1.5.0)

An applicant for a new account.

Properties

NameDescription
username string
The unique username for the user. If omitted on a request, this field will be set for the primary applicant, based on the username of the authenticated user that creates the application. For co-owners and beneficial-owners this field is optional.
contact contact
A Contact object representing an individual contact.
user summaryUser
A User object representing an individual user.
role role
The role the user has on the account. This is a Role resource from the Associations API; it must be a bank account role. The default is determined by the number of applicants and the type of account (personal vs. business).
verification contactVerification
The verification status of the primary applicant.
approvals [approval]
Any approvals associated with this applicant.
consents [consent]
An array of documents (such as terms and conditions, electronic consent) and the user's consent or agreement of the terms of those documents. The service configuration determines which consents are required for enrollment or account applications and sets this array on construction.
fraudReport fraudRiskReport
The fraud risk report for the applicant.
verified boolean
true if and only if the primary applicant has been verified.
read-only
verificationToken string
A secure token that contains identity verification data about a given contact including their verified status. The verified property in this applicant schema is derived from the Boolean status embedded in this token. The data contained in this token is derived from the results of any identity verification service operations previously performed on the contact.
read-only

application

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.5.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    },
    "apiture:workflow": {
      "href": "https://api.devbank.apiture.com/workflow/workflows/6d3dddd0-15c5-48f5-a2a5-f6d0d5e10121"
    },
    "apiture:fundingAccount": {
      "href": "https://api.devbank.apiture.com/externalAccount/0f4994e0-8ecb-4904-a589-f081bde7b8c2"
    },
    "apiture:applicant": {
      "href": "https://api.devbank.apiture.com/users/users/4072ed8c-755d-4879-9c2e-8f32a37e2569"
    },
    "apiture:organization": {
      "href": "https://api.devbank.apiture.com/organization/organization/09c56c3e-ef8f-4cfa-8d15-9c0bd2dfcdd2"
    },
    "apiture:approval": {
      "href": "https://api.devbank.apiture.com/approvals/approval/77f7b41b-654b-4678-b316-c6ec8413f29a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "applicantName": "Elsa Snowqueen",
  "accountName": "My Premiere Savings",
  "productName": "Premiere Savings",
  "productTarget": "personal",
  "fundingAmount": {
    "value": "1500.00",
    "currency": "USD"
  },
  "state": "running",
  "workflowState": "running",
  "createdAt": "2018-12-13T11:01:41.375Z",
  "updatedAt": "2018-12-14T09:12:46.000Z",
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": {
    "0": {
      "title": "John Smith",
      "routingNumber": "021000021",
      "accountNumbers": {
        "masked": "*************0123"
      },
      "ifxType": "SDA",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
        }
      }
    }
  },
  "organization": {},
  "applicants": {},
  "products": {},
  "documents": {},
  "accountApproval": {
    "_id": "f3e5ba25-fd3e-47f2-895e-695eaa02fff6",
    "label": "Account Approval: Premiere Savings, Elsa Snowqueen",
    "state": "open",
    "done": false,
    "typeName": "accountApplication",
    "type": {
      "_id": "bd10a515-5da8-40ec-bd4a-f60e958a297b",
      "name": "accountApplication",
      "label": "Account Application",
      "domain": "https://production.api.apiture.com/approvals",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "createdAt": "2019-12-14T06:41:35.375Z",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/approvals/approvals/39be8d61-4570-4d2d-85e3-2f9d5e14e1a4"
      }
    }
  },
  "consents": {}
}

Account Application (v2.5.0)

An application for a new account. The resource contains summary fields that identify the account applicant, the primary product, and the state of the applications. The nested arrays and objects contains related resources which support the application: applicants and their identity verification, related products, documents, the organization (for business accounts), etc.

Many properties of an application are effectively immutable by the user after the application has started and only an administrator or service application may update them. Users may use updateApplication or patchApplication to update the accountName, fundingAmount, fundingAccount, documents. Note: Updates to an application after the account has been created do not affect the account.

Response and request bodies using this application schema may contain the following links:

RelSummaryMethod
apiture:expireExpire an applicationPOST
apiture:rejectReject an applicationPOST
apiture:approveApprove an applicationPOST
apiture:cancelCancel an applicationPOST
apiture:startStart an applicationPOST
apiture:product ProductGET
apiture:applicant ApplicantGET
apiture:organization OrganizationGET
apiture:fundingAccount Funding AccountGET
apiture:workflow WorkflowGET
apiture:approval Application ApprovalGET

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
applicantName string
The name of the person who started this application or enrollment. This is derived from the applicant resource passed via the first applicant if present, or the current user.
read-only
minLength: 1
maxLength: 128
workflowState string
The state of the embedded application workflow. This is derived and immutable.
read-only
minLength: 1
maxLength: 16
state applicationState
The state of the enrollment or application. The value is updated by the various enrollment or application action operations.
read-only
flaggedForReview boolean
true if the application is blocked awaiting review from the financial institution. This will be derived from the state and approvals of the application, and is immutable.
read-only
createdAt string(date-time)
The date-time when this application was opened/created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
updatedAt string(date-time)
The date-time when this application was updated. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
completedAt string(date-time)
The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
reviewedBy string
The id of the operator that reviewed the approval. This is the string <system> if the application was automatically approved or rejected without operator intervention.
read-only
maxLength: 40
reviewerFirstName string
The first name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by reviewedBy. This is the string <system> if the application was automatically approved or rejected without operator intervention.
read-only
maxLength: 80
reviewerLastName string
The last name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by reviewedBy. This is the string <system> if the application was automatically approved or rejected without operator intervention.
read-only
maxLength: 80
accountName string
The name of new account. If initially blank, this will be initialized from the name of the first product.
maxLength: 128
fundingAmount money
How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. This is optional and omitted in responses if not set when the application is created or updated.
attributes attributes
An optional map of name/value pairs which provide additional metadata about the application. If this object contain an accountAttributes object, the properties in that object are placed in the attributes of the new account that this application creates.
_id string
The unique identifier for this application. This is an immutable opaque string.
read-only
productName string
The name of the banking product associated with this new account application. This is derived from the first product in the products array and is immutable.
read-only
minLength: 1
maxLength: 128
productTarget productTarget
The target of the banking product associated with this new account application. This is derived from the first product in the products array and is immutable.
organizationName string
The name of the organization, if this is an application for a business account. This will be derived from the organization resource, if present.
read-only
minLength: 1
maxLength: 128
applicants [applicant]
The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. The first item in the array is the primary applicant.
minItems: 1
requiredDocuments [requiredDocument]
An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
documents [document]
An array of metadata listing zero or more documents which the FI reviewer must review and approve. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
approvals [approval]
All of the Approval objects which are associated with this enrollment or application. The apiture:approve, apiture:reject, apiture:waive, and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
products [summaryProduct]
The bank product(s) for this account. The first item in the array is the primary product for the new account. The remaining optional items in the array are secondary associated products.
minItems: 1
organization organization
The optional organization for a non-personal (business) account. This is omitted if the application is for a personal account and required for a business account.
organizationVerification businessVerifications
The optional results of verifying a business or other organization. This is omitted if the application is for a personal account and required for a business account.
organizationApprovals [approval]
Optional Approvals for administrator verification of the organization. This is omitted if the application is for a personal account and required for a business account.
accountApproval approval
An optional Approval object which the reviewer can use to approve or reject the entire account application. The apiture:approve and apiture:reject links in the resource may be used to reject or approve the applications via POST operations (no request body). If omitted from the createApplication request, that operation creates a new account Approval resource.
fundingAccount verifiedTransferAccount
Optional funding account, present only if funding is requested when creating or updating the account application. The customer may change or remove this (and fundingAmount) in updateApplication.
promotionCode string
An optional offer or promotion code from the financial institution, used to receive a promotional rate or other improved account terms. See the validatePromotion operation to validate such codes before using them.

Note: If create, update, or patch requests contains a promotionCode, it is validated. An invalid promotion code does not cause a failure in these operations, but the _error object in the response contains an error with the invalidPromotionCode error type.

newAccounts [applicationAccount]
New accounts opened via this application. This array has a one-to-one mapping to the products array. Use the self link in each item's _links to access each account. The usageAnswers in newAccounts[0] applies to all accounts if they do not each have their own usageAnswers.
completedTaskCount integer(int32)
The number of visible workflow tasks which have been completed.
read-only
runningTaskCount integer(int32)
The number of visible workflow tasks which are currently running.
read-only
runningTaskNames [string]
The names of the tasks which are currently running in the application's workflow. This array may be empty but is never omitted.
read-only
pendingTaskCount integer(int32)
The number of visible workflow tasks which are still pending.
read-only
blockedTaskCount integer(int32)
The number of visible workflow tasks which are blocked.
read-only
canceledTaskCount integer(int32)
The number of visible workflow tasks which have been canceled.
read-only
expiresAt string(date-time)
The date-time when the application expires. This is in [RFC 3339] (https://tools.ietf.org/html/rfc3339) UTC date-time format (YYYY-MM-DDThh:mm:ss.sssZ).
read-only
accountVerificationMethod string
Optional account verification method that was used for linking a new external account.

accountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification: Instant Account Verification method for linking external accounts.
microDepositsMicroDeposits Account Verification: MicroDeposits Account Verification method for linking external accounts.

These enumeration values are further described by the label group named accountVerificationMethod in the response from the getLabels operation.
read-only


Enumerated values:
instant
microDeposits

applicationAccount

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/bb7541e1-9d6d-4e24-aa09-ff4d1663ad8d"
    }
  },
  "title": "John Smith",
  "routingNumber": "021000021",
  "accountNumbers": {
    "masked": "*************0123"
  },
  "ifxType": "SDA",
  "usageAnswers": {
    "primaryAccount": true,
    "accountPurpose": "college savings",
    "primarySourceOfDeposits": "transfers from savings"
  }
}

Application Account (v1.0.0)

Descriptive information about a new account being opened via this application.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
accountTitle string
The title of the account. Traditionally, this is the name of the account holder.
Warning: The property accountTitle was deprecated on version v1.1.0 of the schema. Use title property instead. accountTitle will be removed on version v2.0.0 of the schema.
deprecated
maxLength: 512
title string
The title of the account. Traditionally, this is the name of the account holder.
maxLength: 512
institutionName string
The name of the financial institution.
read-only
minLength: 2
maxLength: 128
routingNumber string
The account routing number which identifies the financial institution. The full routing number and full account number are required to fully identify the account.
read-only
minLength: 9
maxLength: 9
accountNumbers accountNumbers
The account numbers for this account
read-only
ifxType ifxType
A code which identifies the product type. This is one of the IFX AcctType values.
read-only
usageAnswers usageAnswers
Answers to financial institution questions on how the account is to be used.

applicationState

"approved"

Application State (v1.0.0)

The state of the enrollment or application.

applicationState strings may have one of the following enumerated values:

ValueDescription
pendingPending: Available to be started (POST to the apiture:start link to start it). This state is reserved for future use.
runningRunning: Started and has not completed or been canceled.
blockedBlocked: Started but is blocked; there are no available workflow tasks.
canceledCanceled: Canceled prior to completion.
expiredExpired: Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired.
rejectedRejected: Completed but was rejected after review.
approvedApproved: Completed and approved.

These enumeration values are further described by the label group named applicationState in the response from the getLabels operation.

Type: string
Enumerated values:
pending
running
blocked
canceled
expired
rejected
approved

applications

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/applications"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "account applications",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryApplication/v1.5.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "6 Month CD",
        "state": "approved"
      }
    }
  }
}

Account Application Collection (v2.6.0)

Collection of account applications. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links: self, next, prev, first, last, collection.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
Embedded resources.
» items [summaryApplication]
An array containing a page of account application items.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

approval

{
  "_profile": "https://production.api.apiture.com/schemas/approvals/approval/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://production.api.apiture.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:approvalType": {
      "href": "https://production.api.apiture.com/approvals/approvalTypes/e4f09b4d-eba6-46da-86d3-ba28595067cd"
    },
    "apiture:target": {
      "href": "https://production.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe"
    }
  },
  "state": "approved",
  "done": true,
  "label": "Government Issued ID",
  "typeName": "governmentId",
  "description": "A document that identifies a user",
  "reviewedBy": "/users/users/0399abed-fd3d-4830-a88b-30f38b8a365c",
  "reviewedAt": "2018-04-17T10:12:58.375Z",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "reason": "Invalid U.S. Address",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_embedded": {
    "approvalType": {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://production.api.apiture.com/schemas/approvals/approvalType/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://production.api.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      },
      "name": "governmentId",
      "label": "Government Issued ID",
      "description": "A document that identifies a user"
    }
  }
}

Approval (v1.1.0)

An approval represents the review of some process, activity or resource, such as a document or an application. The state of the approval is recorded in its state property. The target of the approval is in the link named apiture:target; see the Create Approval schema and createApproval operation.

Links on an approval convey which state transitions are available. The client should use POST to invoke these operations, using the href on the named link object. No request body is used on these operations.

The absence of a link indicates that the particular state transition is not available at that time or that the caller is not authorized to make the change. For example, a bank customer may lack permissions to approve a wire transfer they submitted.

Response and request bodies using this approval schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this approvalGET
apiture:approveApprove an approvalPOST
apiture:rejectReject an approvalPOST
apiture:waiveWaive an approvalPOST
apiture:returnReturn an approvalPOST
apiture:submitSubmit an approvalPOST
apiture:cancelCancel an approvalPOST

This schema was resolved from approvals/approval.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded approvalEmbeddedObjects
Embedded objects.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
label string
The approval's common name. If omitted on create request, this will default to the label of the Approval Type.
description string
The approval's description. If omitted on create request, this will default to the description of the Approval Type.
state approvalState
The state of this approval. This property is derived and immutable. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval, if the corresponding links exist on the approval resource, as determined by the existing state of the approval and the allowed states determined by the approval type.
read-only
done boolean
If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable.
read-only
typeName string
The name of the Approval Type. This field is immutable and derived from the name of the Approval Type.
reviewedBy string
The id of the User that reviewed the approval.
read-only
reviewedAt string(date-time)
The date-time when the approval was reviewed.
read-only
_id string
The unique identifier for this approval resource. This is an immutable opaque string.
read-only
reason string
The reason given for the last state change, such as why the approval was approved, rejected, waived, canceled, or returned.
maxLength: 512
createdAt string(date-time)
The approval's creation date-time, in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format.
read-only
updatedAt string(date-time)
The date-time of the approval's most recent update, in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format.
read-only
attributes attributes
An optional map of name/value pairs which provide additional metadata about the approval.

approvalEmbeddedObjects

{
  "approvalType": {
    "_profile": "https://production.api.apiture.com/schemas/approvals/summaryApprovalType/v1.0.1/profile.json",
    "_links": {
      "self": {
        "href": "https://production.api.apiture.com/approvals/approvalTypes/0399abed-fd3d-4830-a88b-30f38b8a365c"
      }
    },
    "name": "governmentId",
    "label": "Government Issued ID",
    "description": "A document that identifies a user. `governmentId` approvals may not be waived or canceled.",
    "disallowedStates": {
      "0": "waived",
      "1": "canceled"
    },
    "domain": "https://production.api.apiture.com/domains/approvals/documentRequirement",
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
  },
  "target": {}
}

Approval Embedded Objects (v1.0.0)

The objects which participate in this approval.

This schema was resolved from approvals/approvalEmbeddedObjects.

Properties

NameDescription
approvalType summaryApprovalType
The type of this approval.
target object
The target of this approval.

approvalFields

{
  "state": "approved",
  "done": true,
  "label": "Government Issued ID",
  "typeName": "governmentId",
  "description": "A document that identifies a user",
  "reviewedBy": "/users/users/0399abed-fd3d-4830-a88b-30f38b8a365c",
  "reviewedAt": "2018-04-17T10:12:58.375Z"
}

Approval Fields (v1.0.0)

Common fields of the approval resource, used to define other model schemas.

This schema was resolved from approvals/approvalFields.

Properties

NameDescription
label string
The approval's common name. If omitted on create request, this will default to the label of the Approval Type.
description string
The approval's description. If omitted on create request, this will default to the description of the Approval Type.
state approvalState
The state of this approval. This property is derived and immutable. Its value can only be changed by using the corresponding POST operations, submitApproval, approveApproval, rejectApproval, waiveApproval, returnApproval, and cancelApproval, if the corresponding links exist on the approval resource, as determined by the existing state of the approval and the allowed states determined by the approval type.
read-only
done boolean
If done is true, the approval is in a terminal state and may no longer be acted upon. Done states include canceled, approved, waived or rejected. This property is derived from the state field and is immutable.
read-only
typeName string
The name of the Approval Type. This field is immutable and derived from the name of the Approval Type.
reviewedBy string
The id of the User that reviewed the approval.
read-only
reviewedAt string(date-time)
The date-time when the approval was reviewed.
read-only

approvalState

"open"

Approval State (v1.0.0)

The state of this approval.

approvalState strings may have one of the following enumerated values:

ValueDescription
openOpen: An approval that has been created but not submitted for review.
submittedSubmitted: An approval that has been submitted for review but not yet reviewed.
approvedApproved: An approval which has been approved by the financial institution.
rejectedRejected: An approval which has been rejected by the financial institution.
waivedWaived: An approval which has been waived by the financial institution.
returnedReturned: An approval which has been returned by the financial institution. The user should update the data that is the target of the review.
canceledCanceled: An approval which has been canceled by the user or the financial institution.

These enumeration values are further described by the label group named approvalState in the response from the getLabels operation.

This schema was resolved from approvals/approvalState.

Type: string
Enumerated values:
open
submitted
approved
rejected
waived
returned
canceled

approvalTypeFields

{
  "name": "governmentId",
  "label": "Government Issued ID",
  "description": "A document that identifies a user. `governmentId` approvals may not be waived or canceled.",
  "disallowedStates": [
    "waived",
    "canceled"
  ],
  "domain": "https://production.api.apiture.com/domains/approvals/documentRequirement"
}

Approval Type Fields (v1.0.0)

Common fields of the approval resource used to build other model schemas.

This schema was resolved from approvals/approvalTypeFields.

Properties

NameDescription
name string
The approval's name.
label string
The approval's common name.
description string
The approval's description.
domain string
A namespace for grouping related resources, to keep them separate from other resources. For example, a department or bank branch may define a domain, and all Approval Type instances they define will use that domain, so that they can avoid conflicting with Approval Type names in other domains. An API or service may define a domain for new Approval Types that it defines. The combination of domain and name must be unique within the set of all approval types. It is a best practice to define domain with a URI or a URN.
disallowedStates [disallowedState]
An optional array of states that are not allowed for this approval type. If omitted, all state transitions are allowed. The states open and approved are always allowed, so this enumeration set is a subset of the approvalState enumeration on an approval.

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

This schema was resolved from common/attributeValue.

Properties

attributes

{
  "property1": {},
  "property2": {}
}

Attributes (v2.0.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

NameDescription
additionalProperties attributeValue
The data associated with this attribute.

This schema was resolved from common/attributeValue.

authorization

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}

Authorization (v1.1.0)

Represents a person authorized for account access. This object contains key identification information for the person and the type of access or role that the person has in relation to the banking account or organization.

This schema was resolved from contacts/authorization.

Properties

NameDescription
firstName string (required)
The person's first name (or given name).
maxLength: 80
middleName string
The person's middle name.
maxLength: 80
lastName string (required)
The person's last name (or surname).
maxLength: 80
addresses [address] (required)
An array of postal/mailing addresses.
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
taxId string (required)
Official government identification (tax ID) for this person. This will return a masked tax ID, where only the last 4 digits are visible. If the ?unmasked=true query parameter is passed, the full, unmasked tax ID is returned.
citizen boolean (required)
Indicates if the person is a (US) citizen.
emailAddress string(email)
Optional email address.
userId string (required)
The unique ID of the user. This is the _id value of the user resource from the Users API.
customerId string (required)
The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the user in the banking core. The customerId differs from the _id (which is the ID of the resource in the Users API).
read-only
minLength: 1
maxLength: 100
type authorizationType (required)

The type of this account access authorization.

  • primary the contact is the primary owner of a personal account. There may be only one primary owner. The target of the authorization is a single personal account.
  • joint the contact is a non-primary joint owner of a personal account. The target of the authorization is a single personal account.
  • authorizedSigner the contact is an authorized signer for a business account. The target of the authorization is an all business accounts owned by the organization.
role string
The person's role at the organization. This attribute is required when the authorization type is authorizedSigner.

authorizationType

"primary"

Account Authorization type (v1.0.0)

The type of this account access authorization.

authorizationType strings may have one of the following enumerated values:

ValueDescription
primaryPrimary Account Holder: The primary account holder of a personal account. There may be only one primary owner.
jointJoint Account Holder: A non-primary joint account holder of a personal account.
authorizedSignerAuthorized Signer: Authorized Signer of a business account.

These enumeration values are further described by the label group named authorizationType in the response from the getLabels operation.

This schema was resolved from contacts/authorizationType.

Type: string
Enumerated values:
primary
joint
authorizedSigner

authorizedSigner

{
  "firstName": "Jane",
  "lastName": "Doe",
  "identification": [
    {
      "type": "taxId",
      "value": "121-34-5431"
    }
  ],
  "birthdat>": "1980-12-01",
  "email": "email@email.com"
}

Authorized Signer (v1.0.0)

Authorized Signers are primary bank users and co-owners of a business, optionally passed when creating verification reports.

This schema was resolved from businessVerifications/authorizedSigner.

Properties

NameDescription
firstName string (required)
The authorized signer's first name
minLength: 1
maxLength: 512
lastName string (required)
The authorized signer's last name
minLength: 1
maxLength: 512
identification identificationModel
A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.

birthdate string(date)
The authorized signer's birth date in yyyy-mm-dd format.
minLength: 10
maxLength: 10
pattern: ^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))$
email string
The authorized signer's email address
minLength: 1
maxLength: 512

authorizedSigners

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/authorizedSigners/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "items": {
    "0": {
      "_id": "as001",
      "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
      "customerId": "10047294723672",
      "type": "authorizedSigner",
      "role": "Chief Financial Officer",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "taxId": "*****3333",
      "citizen": true,
      "addresses": {
        "0": {
          "_id": "ha5",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Apt 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        }
      },
      "preferredMailingAddressId": "ha5",
      "emailAddress": "JohnDanielSmith@example.com"
    }
  }
}

Authorized Signers (v1.2.0)

The list of users who are authorized to access the organization and its bank accounts.

This schema was resolved from organizations/authorizedSigners.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items [authorizedSigner]
The array of authorized signers for this business and their role within the organization. These people have account access for all business accounts owned by the business. The items in this array must all have the type of authorizedSigner.
minLength: 1

beneficialOwner

{
  "firstName": "William",
  "middleName": "Daniel",
  "lastName": "Wellphunded",
  "addresses": {
    "0": {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "1234 S Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "preferredMailingAddressId": "ha1",
  "emailAddresses": {
    "0": {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    "1": {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  },
  "preferredEmailAddressId": "pe0",
  "phones": {
    "0": {
      "_id": "hp1",
      "type": "home",
      "number": "+19105550155"
    },
    "1": {
      "_id": "mp1",
      "type": "mobile",
      "number": "+19105550159"
    },
    "2": {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  },
  "preferredPhoneId": "hp1",
  "preferredName": "John",
  "suffix": "MD",
  "identification": {
    "0": {
      "type": "taxId",
      "value": "111-11-1111"
    }
  },
  "preferredContactMethod": "email",
  "_id": "b003",
  "role": "Chief Financial Officer",
  "birthdate": "1982-10-19",
  "percentage": 35,
  "contactId": "8bf04d7d-c1bd-4945-b0ac-40ef02bb3953"
}

Beneficial Owner (v1.4.0)

A person who owns 25% or more of a business organization.

This schema was resolved from organizations/beneficialOwner.

Properties

NameDescription
firstName string (required)
The person's first name (or given name).
maxLength: 80
middleName string
The person's middle name.
maxLength: 80
lastName string (required)
The person's last name (or surname).
maxLength: 80
addresses [address]
An array of postal/mailing addresses.
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
emailAddresses [typedEmailAddress]
An array of email addresses.
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
phones [phoneNumber]
An array of phone numbers.
preferredPhoneId string
The ID of preferred phone number. This string is the _id of a phone number in the phones array.
minLength: 1
maxLength: 4
prefix string
A title or honorific prefix such as Dr. or Fr.
maxLength: 20
suffix string
A title or honorific suffix such as PhD or DDS.
maxLength: 20
preferredName string
The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName.
identification [identification] (required)
A collection of official identifying information associated with the contact.
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
_id string
The unique identifier for this beneficial owner resource. This is an immutable opaque string.
read-only
role string
The person's role at the organization.
percentage integer (required)
The percent of the business that this person owns.
maximum: 100
birthdate string(date)
The beneficial owner's birth date in YYYY-MM-DD format.
contactId string (required)
The _id of an existing contact resource associated with the beneficial owner. Create the beneficial owner contact resource using the Contacts API.

beneficialOwners

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": {
    "0": {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": {
        "0": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": "1982-10-19",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "111-11-1111"
        }
      },
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  }
}

Beneficial Owners (v1.4.0)

A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future.

This schema was resolved from organizations/beneficialOwners.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items [beneficialOwner] (required)
A list of people who own at least 25% of the business, and the percentage owned.
maxLength: 10

businessVerification

{
  "state": "passed",
  "completedAt": "2019-08-24T14:15:22Z",
  "type": "verificationReport",
  "_id": "string",
  "_links": {
    "property1": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    },
    "property2": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Application"
    }
  }
}

Business Verification Report (v1.0.0)

The verification report contains analsys of the business data and includes the state of the verification.

This schema was resolved from businessVerifications/businessVerification.

Properties

NameDescription
state string
The state of a verification report. passed indicates that the Business was successfully verified based upon the supplied information, failed indicates it was not.


Enumerated values:
passed
failed

completedAt string(date-time)
An ISO 8601 UTC time stamp indicating when the verification report was created.
type string
The identity method type. Possible values are verificationReport or administratorApproval.


Enumerated values:
verificationReport
administratorApproval

_id string
This business verification's unique id
read-only
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

businessVerificationScore

{
  "value": "string",
  "description": "string"
}

Business Verification Score (v1.0.0)

An score that summarizes the verification of the input information. This objects contains a score value and accompanying description.

This schema was resolved from businessVerifications/businessVerificationScore.

Properties

NameDescription
value string
The business verification score value
description string
The business verification score description

businessVerifications

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "businessVerifications": {
    "0": {
      "state": "failed",
      "completedAt": "2018-04-17T10:04:46.375Z",
      "type": "verificationReport",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_links": {
        "apiture:verificationReport": {
          "href": "https://api.example.com/businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    },
    "1": {
      "state": "passed",
      "completedAt": "2018-04-17T10:04:46.375Z",
      "type": "administratorApproval",
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_links": {
        "apiture:approval": {
          "href": "https://api.example.com/approvals/approvals/0399abed-fd3d-4830-a88b-30f38b8a365c"
        }
      }
    }
  }
}

Business Verifications (v2.0.0)

Representation of the verification results that were previously generated by this service via the POST /businessVerifications. The result contains a link to apiture:organization if an apiture:organization link was passed on the request to create the report.

This schema was resolved from businessVerifications/businessVerifications.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
businessVerifications [businessVerification]
An array of business verification resources

citizenship

{
  "countryCode": "US",
  "state": "citizen"
}

Citizenship (v1.0.0)

Citizenship or nationality status.

This schema was resolved from contacts/citizenship.

Properties

NameDescription
countryCode string (required)
The ISO 3166-1 country code for the individual's citizenship.
minLength: 2
maxLength: 2
state string (required)
The individual's citizenship status.


Enumerated values:
citizen
other

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Collection (v2.1.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

This schema was resolved from common/collection.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

comprehensiveVerificationScore

{
  "inputRepNumber": "string",
  "score": 0,
  "description": "string"
}

Authorized Representative Comprehensive Verification Score (v1.0.0)

The comprehensive verification score is a risk verification score for the authorized representative.

This schema was resolved from businessVerifications/comprehensiveVerificationScore.

Properties

NameDescription
inputRepNumber string
the rep number for the authorized representative
score integer
The comprehensive verification score is a risk verification score of the authorized representative
description string
The description for the CVI value

configurationGroup

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Configuration Group (v2.1.0)

Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
name string
The name of this configuration group, must be unique within the set of all resources of this type.
minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
label string
The text label for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 128
description string
The full description for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 4096
schema configurationSchema
The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*.

This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

This schema was resolved from configurations/configurationSchema.

values configurationValues
The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values.

For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

This schema was resolved from configurations/configurationValues.

configurationGroupSummary

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API"
}

Configuration Group Summary (v2.1.0)

A summary of the data contained within a configuration group resource.

This schema was resolved from configurations/configurationGroupSummary.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
name string
The name of this configuration group, must be unique within the set of all resources of this type.
minLength: 1
maxLength: 48
pattern: [a-zA-Z][-\w_]*
label string
The text label for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 128
description string
The full description for this resource, suitable for presentation to the client.
minLength: 1
maxLength: 4096

configurationGroups

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    }
  }
}

Configuration Group Collection (v2.1.0)

Collection of configuration groups. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

This schema was resolved from configurations/configurationGroups.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded configurationGroupsEmbedded
Embedded objects.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

configurationGroupsEmbedded

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/configurations/groups/basic"
        }
      },
      "name": "basic",
      "label": "Basic Settings",
      "description": "The basic settings for the Transfers API"
    }
  ]
}

Configuration Groups Embedded Objects (v1.1.0)

Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

Properties

NameDescription
items [configurationGroupSummary]
An array containing a page of configuration group items.

configurationSchema

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Configuration Schema (v2.1.0)

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*.

This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

This schema was resolved from configurations/configurationSchema.

Properties

NameDescription
additionalProperties configurationSchemaValue
The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

Properties

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Configuration Values (v2.0.0)

The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values.

For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

This schema was resolved from configurations/configurationValues.

Properties

NameDescription
additionalProperties configurationValue
The data associated with this configuration.

This schema was resolved from configurations/configurationValue. 

{
  "_profile": "https://production.api.apiture.com/schemas/consents/consent/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/consents/consents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:revoke": {
      "href": "/consents/revokedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:rescind": {
      "href": "/consents/rescindedConsents?consent=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "document": {
    "uri": "/vault/files/fd44d565-0086-4caf-8d9f-3b7681809251/content",
    "contentType": "application/pdf",
    "revisedAt": "2019-07-23T08:26:45.375Z",
    "revisionId": "2019:1.02.0"
  },
  "type": "productTermsAndConditions",
  "userId": "5a5e834c-a7bd-401c",
  "state": "given",
  "contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a",
  "givenAt": "2019-07-23T13:27:34.375Z"
}

Consent (v1.1.0)

Representation of a consent resource. Users consent or acceptance of a policy or other document.

Response and request bodies using this consent schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this consentGET
apiture:revokeRevoke a consentPOST
apiture:giveGive a consentPOST

This schema was resolved from consents/consent.

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
document document
Properties of the target document.
type string
Describe what kind of consent this is. This value must be one of the type names in the /consentTypeNames resource.
contextUri string(uri)
The URI of a resource that establishes the context in which the financial institution asks for the user's consent. For example, for consent of an account's terms and conditions, the context might be the banking product for that account.
maxLength: 2048
secondaryContextUri string(uri)
The URI of a secondary resource associated with this user's consent and the contextUri. For example, for consent of an account's terms and conditions, the secondary context might be the account.
maxLength: 2048
userId string
The user ID of the user who is requested to consent to a document. This is the _id of the User resource.
_id string
The unique identifier for this consent resource. This is an immutable opaque string.
read-only
state consentStates
The state of this consent.
read-only
givenAt string(date-time)
The time stamp when the user last consented to the document, in RFC 3339 UTC date-time format (YYYY-MM-DDThh:mm:ss.sssZ). This property is not set if state is pending.
read-only
requestRevokedAt string(date-time)
The time stamp when the user revoked consent, in RFC 3339 UTC date-time format (YYYY-MM-DDThh:mm:ss.sssZ). A revoked consent reflects a consent request that the user has previously given but has reversed. Revoking a consent sets the state back to pending and clears consentedAt.
read-only
requestRescindedAt string(date-time)
The time stamp when the consent request was rescinded by the requester, in RFC 3339 UTC date-time format (YYYY-MM-DDThh:mm:ss.sssZ). A rescinded consent reflects a consent request that the system or application has issued in the past but no longer requires. For example, if a user is removed as an authorized signer from an account and a consent is pending for that account's terms and conditions, the Accounts service may rescind that consent request. This property is set only if state is rescinded.
read-only

consentFields

{
  "document": {
    "uri": "http://example.com",
    "contentType": "application/pdf",
    "revisionId": "2019:1.2.0",
    "revisedAt": "2019-08-24T14:15:22Z"
  },
  "type": "string",
  "contextUri": "http://example.com",
  "secondaryContextUri": "http://example.com",
  "userId": "string"
}

Consent Fields (v1.1.0)

Common fields of the consent resource used to build other model schemas.

This schema was resolved from consents/consentFields.

Properties

NameDescription
document document
Properties of the target document.
type string
Describe what kind of consent this is. This value must be one of the type names in the /consentTypeNames resource.
contextUri string(uri)
The URI of a resource that establishes the context in which the financial institution asks for the user's consent. For example, for consent of an account's terms and conditions, the context might be the banking product for that account.
maxLength: 2048
secondaryContextUri string(uri)
The URI of a secondary resource associated with this user's consent and the contextUri. For example, for consent of an account's terms and conditions, the secondary context might be the account.
maxLength: 2048
userId string
The user ID of the user who is requested to consent to a document. This is the _id of the User resource.

consentStates

"pending"

Consent States (v1.0.0)

The state of a consent resource.

This schema was resolved from consents/consentStates.

Type: string
Enumerated values:
pending
given
stale
rescinded
revoked

constraints

{
  "transactionTypes": [
    "debit"
  ],
  "minimumBalance": "500.00",
  "minimumFundingAmount": "500.00",
  "maximumFundingAmount": "2500.00",
  "minimumTransferAmount": "25.00",
  "maximumTransferAmount": "10000.00",
  "maximumWithdrawalCount": 6,
  "fundingTerm": "P30D",
  "depositsRestrictedAfterGracePeriod": true,
  "depositsRestrictedAfterFunding": true,
  "gracePeriod": "P14D"
}

Product Constraints (v1.0.0)

Product constraints, such as minimum and maximum balances.

This schema was resolved from products/constraints.

Properties

NameDescription
transactionTypes transactionTypes
The types of transactions permitted for this account. Values which appear in this array are permitted.
minimumBalance string
The minimum balance for accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
minimumFundingAmount string
The minimum monetary value when funding a new account of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumFundingAmount string
The maximum monetary value when funding a new account of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
minimumTransferAmount string
The minimum monetary value for new transfers from accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumTransferAmount string
The maximum monetary value for new transfers from accounts of this product. The numeric value is represented as a string so that it can be exact with no loss of precision. This balance is in the currency for the product.
maximumWithdrawalCount integer
The maximum number of withdrawals allowed per cycle. If not present, there is no hard limit.
fundingTerm string(period)
The time limit within which account opening funding must occur after account creation. This is expressed as an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.
depositsRestrictedAfterGracePeriod boolean
If true, deposits are not allowed after the rollover grace period (see gracePeriod). This applies to time deposit products only.
Default: true
depositsRestrictedAfterFunding boolean
If true, deposits are not allowed after the initial account funding has completed. This typically applies to time deposit products.
Default: true
gracePeriod string(period)
A period of time after account rollover when additional deposits are allowed. This is an ISO 8601 duration duration; only day and month periods are allowed, and the only allowed fractional value for months is 0.5, as in P5D or P14D or P1M or P0.5M.

contact

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": {
    "0": {
      "type": "taxId",
      "value": "*****3333"
    }
  },
  "emailAddresses": {
    "0": {
      "_id": "ea1",
      "value": "api@apiture.com",
      "type": "personal",
      "id": "pe0"
    },
    "1": {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work",
      "id": "wp1"
    }
  },
  "preferredEmailAddressId": "ea1",
  "phones": {
    "0": {
      "_id": "pa1",
      "type": "home",
      "number": "+19105550155"
    },
    "1": {
      "_id": "da6",
      "type": "mobile",
      "number": "+19105550155"
    },
    "2": {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  },
  "preferredPhoneId": "pa1",
  "birthdate": "1974-10-27",
  "citizenship": {
    "0": {
      "countryCode": "US",
      "state": "citizen"
    }
  },
  "residencyStatus": "resident",
  "occupation": "officeAndAdministrativeSupport",
  "addresses": {
    "0": {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "preferredMailingAddressId": "ha1",
  "yearsAtAddress": 3,
  "mailingDifferentAddress": false,
  "state": "active",
  "preferredContactMethod": "email",
  "_profile": "https://production.api.apiture.com/schemas/contacts/contact/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/contacts/inactiveContacts?contact=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z"
}

Contact (v2.1.1)

Representation of a contact resource. Contact data (mailing addresses, phone numbers, email addresses) for an individual.

This schema was resolved from contacts/contact.

Properties

NameDescription
kycAnswers kycAnswers
An object that contains the answers to Know Your Customer (KYC) questions.
Warning: The property kycAnswers was deprecated on version v1.0.0 of the schema. Use kycAnswers on the user schema in Users API instead. kycAnswers will be removed on version v2.0.0 of the schema.
deprecated
identityVerificationStatus string
Use the state of identityVerification. The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record.
Warning: The property identityVerificationStatus was deprecated on version v1.0.0 of the schema. Use identity verification of the user in the Identity service instead. identityVerificationStatus will be removed on version v2.0.0 of the schema.
read-only
deprecated


Enumerated values:
verified
unverified

identityVerification identityVerification
The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record.
Warning: The property identityVerification was deprecated on version v1.0.0 of the schema. Use identity verification of the user in the Identity service instead. identityVerification will be removed on version v2.0.0 of the schema.
deprecated
firstName string
The person's first name (or given name).
maxLength: 80
middleName string
The person's middle name.
maxLength: 80
lastName string
The person's last name (or surname).
maxLength: 80
addresses [address]
An array of postal/mailing addresses.
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
emailAddresses [typedEmailAddress]
An array of email addresses.
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
phones [phoneNumber]
An array of phone numbers.
preferredPhoneId string
The ID of preferred phone number. This string is the _id of a phone number in the phones array.
minLength: 1
maxLength: 4
prefix string
A title or honorific prefix such as Dr. or Fr.
maxLength: 20
suffix string
A title or honorific suffix such as PhD or DDS.
maxLength: 20
preferredName string
The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName.
identification [identification]
A collection of official identifying information associated with the contact.
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
birthdate string(date)
The contact's birth date in YYYY-MM-DD format.
citizenship [citizenship]
This individual's citizenship or nationality status.
residencyStatus residencyStatus
This individual's residency status.
occupation occupation
The occupation of this individual.
otherOccupation string
The actual occupation of this individual if their occupation is other. This is ignored if occupation is not other.
minLength: 4
maxLength: 100
yearsAtAddress yearsAtAddress
The number of years the person has been at their present home address.
Warning: The property yearsAtAddress was deprecated on version v1.1.0 of the schema. Use user.yearsAtAddress (via Users API) instead. yearsAtAddress will be removed on version v2.0.0 of the schema.
deprecated
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
state contactState
The state of this person's record.
read-only
_id string
The unique identifier for this contact resource. This is an immutable opaque string.
read-only
attributes object
An optional map of name/value pairs which provide additional metadata about the contact.
createdAt string(date-time)
The date-time when the contact was created.
updatedAt string(date-time)
The date-time when the contact was updated

contactState

"inactive"

Contact State (v1.0.0)

The state of this person. The values are described in the contactState text via the getLabels operation.

contactState strings may have one of the following enumerated values:

ValueDescription
inactiveInactive: A new contact, not yet activated.
activeActive: An activated contact record.
mergedMerged: A contact record resulting from merging other contacts.
removedRemoved: A removed, no longer available contact.

These enumeration values are further described by the label group named contactState in the response from the getLabels operation.

This schema was resolved from contacts/contactState.

Type: string
Enumerated values:
inactive
active
merged
removed

contactVerification

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/6da5ccc7-727a-4256-bdd4-74023ae349c3"
    }
  },
  "verifications": {
    "0": {
      "type": "fraudRiskReport",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
        }
      },
      "state": "passed",
      "createdAt": "2018-01-12T10:15:17Z"
    },
    "1": {
      "type": "quiz",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/identity/quizzes/73be83af-9e64-4214-8e90-76da43610b31"
        }
      },
      "state": "passed",
      "createdAt": "2018-01-12T10:19:41Z"
    }
  }
}

Verification (v2.1.0)

The contact's verification history and status.
Warning: The schema contactVerification was deprecated on version v0.12.0 of the API. Use identityVerification schema instead. contactVerification will be removed on version v0.13.0 of the API.

This schema was resolved from identity/contactVerification.
deprecated

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
verifications [identityHistoryItem]
The history of this contact's identity verifications.

contactVerificationFields

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "*****3333"
    }
  ],
  "emailAddresses": [
    {
      "_id": "ea1",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "ea1",
  "phones": [
    {
      "_id": "pa1",
      "type": "home",
      "number": "+19105550155"
    },
    {
      "_id": "da6",
      "type": "mobile",
      "number": "+19105550159"
    }
  ],
  "preferredPhoneId": "pa1",
  "birthdate": "1974-10-27",
  "citizenship": [
    {
      "countryCode": "US",
      "state": "citizen"
    }
  ],
  "residencyStatus": "resident",
  "occupation": "officeAndAdministrativeSupport",
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha1",
  "yearsAtAddress": 3,
  "mailingDifferentAddress": false,
  "state": "active"
}

Contact Fields (v1.1.2)

Common fields of the contact resource used to build other model schemas for people who hold bank accounts.
Warning: The schema contactVerificationFields was deprecated on version v0.19.0 of the API. Use corresponding properties on the user schema in Users API instead. contactVerificationFields will be removed on version v0.25.0 of the API.

This schema was resolved from contacts/contactVerificationFields.
deprecated

Properties

NameDescription
kycAnswers kycAnswers
An object that contains the answers to Know Your Customer (KYC) questions.
Warning: The property kycAnswers was deprecated on version v1.0.0 of the schema. Use kycAnswers on the user schema in Users API instead. kycAnswers will be removed on version v2.0.0 of the schema.
deprecated
identityVerificationStatus string
Use the state of identityVerification. The identity verification status for this person. This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record.
Warning: The property identityVerificationStatus was deprecated on version v1.0.0 of the schema. Use identity verification of the user in the Identity service instead. identityVerificationStatus will be removed on version v2.0.0 of the schema.
read-only
deprecated


Enumerated values:
verified
unverified

identityVerification identityVerification
The identity verification data for this person. These fields are derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record.
Warning: The property identityVerification was deprecated on version v1.0.0 of the schema. Use identity verification of the user in the Identity service instead. identityVerification will be removed on version v2.0.0 of the schema.
deprecated

createApplication

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/createApplication/v3.3.0/profile.json",
  "_links": {
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "accountName": "My checking account",
  "applicants": {
    "0": {
      "username": "Snowqueen123",
      "contact": {
        "firstName": "Elsa",
        "lastName": "Snowqueen",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/users/user/3017d005-9910-4a8b-874b-397749353e7a"
          }
        }
      },
      "role": {
        "name": "primaryUser",
        "label": "Primary User",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/associations/roles/3ad50a2a-3129-491f-9bd9-d4cccf54b228"
          }
        }
      }
    }
  },
  "products": {
    "0": {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  }
}

Create Account Application (v3.3.0)

Representation of the request used to create a new account application. This does not create an account, just an application. When the application is completed and approved, the account will be created.

The request must contain the following contents:

These objects passed in the request may be complete object representations, or they may be "thin" objects with only HAL _links with a self link containing the object URL; the application service will fetch these objects.

Creating an application will instantiate a workflow instance, based on a workflow definition that is associated with the primary banking product in the application. The client application should process that workflow instance and present any interactive tasks which are available to run, and continue until the workflow is done.

If the request contains a promotionCode, it is validated (see also validatePromotion). Invalid codes are ignored and do not cause a failure in this operation, although the response's _error object contains an error with the invalidPromotionCode error type.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
accountName string
The name of new account. If initially blank, this will be initialized from the name of the first product.
maxLength: 128
fundingAmount money
How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. This is optional and omitted in responses if not set when the application is created or updated.
attributes attributes
An optional map of name/value pairs which provide additional metadata about the application. If this object contain an accountAttributes object, the properties in that object are placed in the attributes of the new account that this application creates.
applicants [applicant]
The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. The first item in the array is the primary applicant.
minItems: 1
requiredDocuments [requiredDocument]
An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
documents [document]
An array of metadata listing zero or more documents which the FI reviewer must review and approve. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
approvals [approval]
All of the Approval objects which are associated with this enrollment or application. The apiture:approve, apiture:reject, apiture:waive, and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
products [summaryProduct] (required)
The bank product(s) for this account. The first item in the array is the primary product for the new account. The remaining optional items in the array are secondary associated products.
minItems: 1
organization organization
The optional organization for a non-personal (business) account. This is omitted if the application is for a personal account and required for a business account.
organizationVerification businessVerifications
The optional results of verifying a business or other organization. This is omitted if the application is for a personal account and required for a business account.
organizationApprovals [approval]
Optional Approvals for administrator verification of the organization. This is omitted if the application is for a personal account and required for a business account.
accountApproval approval
An optional Approval object which the reviewer can use to approve or reject the entire account application. The apiture:approve and apiture:reject links in the resource may be used to reject or approve the applications via POST operations (no request body). If omitted from the createApplication request, that operation creates a new account Approval resource.
fundingAccount verifiedTransferAccount
Optional funding account, present only if funding is requested when creating or updating the account application. The customer may change or remove this (and fundingAmount) in updateApplication.
promotionCode string
An optional offer or promotion code from the financial institution, used to receive a promotional rate or other improved account terms. See the validatePromotion operation to validate such codes before using them.

Note: If create, update, or patch requests contains a promotionCode, it is validated. An invalid promotion code does not cause a failure in these operations, but the _error object in the response contains an error with the invalidPromotionCode error type.

createEnrollment

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Create an Enrollment (v1.6.0)

Representation of the request to enroll a user in digital banking. Creating an enrollment will instantiate a workflow instance, based on a workflow definition that is configured for new user enrollment. This will typically apply the financial institution's Customer Identification Program (CIP) process, a.k.a. their Know Your Customer process. The client application should monitor that workflow instance and present any interactive tasks which are available to run, and continue until the workflow is done.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
applicant applicant
The applicant seeking to enroll in digital banking. If omitted, the service will create the applicant, based on the current user.
Warning: The property applicant was deprecated on version v1.0.0 of the schema. Use applicants array instead. applicant will be removed on version v2.0.0 of the schema.
deprecated
applicants [applicant]
The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. The first item in the array is the primary applicant.
minItems: 1
requiredDocuments [requiredDocument]
An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
documents [document]
An array of metadata listing zero or more documents which the FI reviewer must review and approve. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
approvals [approval]
All of the Approval objects which are associated with this enrollment or application. The apiture:approve, apiture:reject, apiture:waive, and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only

createResourceTrackingIds

{
  "_profile": "https://production.api.apiture.com/schemas/common/createResourceTrackingIds/v1.1.0/profile.json",
  "_links": {},
  "trackingIds": {
    "0": "2dd86cdb-2a50-4079-a246-6486135a0ca2"
  }
}

Create Resource Tracking IDs (v1.1.0)

A tracking ID to add to a resource.

This schema was resolved from common/createResourceTrackingIds.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
trackingIds [string]
An array of trackings ID to add to the resource.
minItems: 1
maxItems: 16
uniqueItems: true

createVerificationReport

{
  "businessName": "ABC EXAMPLE CO.",
  "phone": "555-555-1234",
  "identification": {
    "0": {
      "type": "taxId",
      "value": "12-347894309"
    }
  },
  "attributes": {},
  "addresses": {
    "0": {
      "addressLine1": "3212 N. 2nd Ave.",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28412"
    }
  },
  "authorizedSigners": {
    "0": {
      "firstName": "Jane",
      "lastName": "Doe",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "121-34-5431"
        }
      },
      "birthdate": "1980-12-01",
      "email": "email@email.com"
    }
  },
  "_profile": "https://production.api.apiture.com/schemas/businessVerifications/createVerificationReport/v2.0.0/profile.json",
  "_links": {}
}

Create Verification Report (v2.0.0)

Representation used to create a new verification report.

This schema was resolved from businessVerifications/createVerificationReport.

Properties

NameDescription
businessName string
The business's name
minLength: 1
maxLength: 512
alternateBusinessName string
An alternate name for the business
minLength: 1
maxLength: 512
phone string
The business's phone
minLength: 1
maxLength: 32
identification identificationModel
A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.

authorizedSigners [authorizedSigner]
An optional array of authorized signer entities
addresses [address]
An array of postal mailing addresses for this contact.
attributes attributes
An optional map of name/value pairs which provide additional metadata about the verification report.
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only

disallowedState

"rejected"

Disallowed State (v1.0.0)

A disallowed state for an approval. Approvals of this type may not be set to any of the states defined by this.

disallowedState strings may have one of the following enumerated values:

ValueDescription
returnedReturned: The returned state is not allowed for approvals of this type.
rejectedWaived: The rejected state is not allowed for approvals of this type.
waivedWaived: The waived state is not allowed for approvals of this type.
canceledCanceled: The canceled state is not allowed for approvals of this type.

These enumeration values are further described by the label group named disallowedState in the response from the getLabels operation.

This schema was resolved from approvals/disallowedState.

Type: string
Enumerated values:
rejected
waived
returned
canceled

document

{
  "uri": "http://example.com",
  "contentType": "application/pdf",
  "revisionId": "2019:1.2.0",
  "revisedAt": "2019-08-24T14:15:22Z"
}

Document (v1.0.0)

Properties of a target document.

This schema was resolved from consents/document.

Properties

NameDescription
uri string(uri) (required)
The URI of the target document that the user is consenting to. If the document is revised, this consent is marked as stale. (Note: This need not be a document in the Apiture vault.)
maxLength: 2048
contentType any (required)
The media type for the document. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
revisionId string
The revision identifier of the document revision the user consented to. If the content management system in which the document is stored does not define revision identifiers or tags, this may be omitted and defaults to the revision time stamp.
revisedAt string(date-time) (required)
The time stamp when the target document was last revised (modified), in RFC 3339 UTC date-time format (YYYY-MM-DDThh:mm:ss.sssZ).

emailType

"unknown"

Email Type (v1.0.0)

The kind of email address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named emailType in the response from the getLabels operation.

This schema was resolved from contacts/emailType.

Type: string
Enumerated values:
unknown
personal
work
school
other
notApplicable

employmentStatus

"string"

Employment Status (v1.0.0)

The employment status of the user.

The allowed values for this property are defined at runtime in the label group named employmentStatus in the response from the getLabels operation.

This schema was resolved from users/employmentStatus.

Properties

enrollment

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Digital Banking User Enrollment (v1.8.0)

Representation of the request to enroll a user in digital banking.

Response and request bodies using this enrollment schema may contain the following links:

RelSummaryMethod
apiture:expireExpire an enrollmentPOST
apiture:rejectReject an enrollmentPOST
apiture:approveApprove an enrollmentPOST
apiture:cancelCancel an enrollmentPOST
apiture:workflow WorkflowGET
apiture:approval Enrollment ApprovalGET

Properties

NameDescription
applicants [applicant]
The applicant or co-applicants seeking to enroll in digital banking and optionally open the account. If omitted, the service will create an array with one applicant, based on the current user. The first item in the array is the primary applicant.
minItems: 1
requiredDocuments [requiredDocument]
An array of metadata describing one or more required documents which the applicant may need to provide during the enrollment or application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
documents [document]
An array of metadata listing zero or more documents which the FI reviewer must review and approve. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts) etc.
approvals [approval]
All of the Approval objects which are associated with this enrollment or application. The apiture:approve, apiture:reject, apiture:waive, and apiture:return links in each Approval resource may be used to approve, reject, waive, or return the approval via POST operations (no request body).
read-only
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
applicantName string
The name of the person who started this application or enrollment. This is derived from the applicant resource passed via the first applicant if present, or the current user.
read-only
minLength: 1
maxLength: 128
workflowState string
The state of the embedded application workflow. This is derived and immutable.
read-only
minLength: 1
maxLength: 16
state applicationState
The state of the enrollment or application. The value is updated by the various enrollment or application action operations.
read-only
flaggedForReview boolean
true if the application is blocked awaiting review from the financial institution. This will be derived from the state and approvals of the application, and is immutable.
read-only
createdAt string(date-time)
The date-time when this application was opened/created. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
updatedAt string(date-time)
The date-time when this application was updated. This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
completedAt string(date-time)
The date-time when this application was completed and its final resolution was set (approved, rejected, canceled, or expired). This is in RFC 3339 format: YYYY-MM-DDThh:mm:ss.sssZ
read-only
reviewedBy string
The id of the operator that reviewed the approval. This is the string <system> if the application was automatically approved or rejected without operator intervention.
read-only
maxLength: 40
reviewerFirstName string
The first name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by reviewedBy. This is the string <system> if the application was automatically approved or rejected without operator intervention.
read-only
maxLength: 80
reviewerLastName string
The last name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by reviewedBy. This is the string <system> if the application was automatically approved or rejected without operator intervention.
read-only
maxLength: 80
applicant applicant
The applicant seeking to enroll in digital banking. If omitted, the service will create the applicant, based on the current user.
Warning: The property applicant was deprecated on version v1.0.0 of the schema. Use applicants array instead. applicant will be removed on version v2.0.0 of the schema.
deprecated
_id string
The unique identifier for this application. This is an immutable opaque string.
read-only

enrollments

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/enrollments/v2.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/accountApplications/enrollments"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryEnrollment/v1.8.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/accountApplication/summaryEnrollment/v1.8.0/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "state": "approved"
      }
    }
  }
}

Enrollment Collection (v2.7.0)

Collection digital banking enrollments. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links: self, next, prev, first, last, collection.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
Embedded resources.
» items [summaryEnrollment]
An array containing a page of account application items.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
count integer
The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start integer
The start index of this page of items.
limit integer
The maximum number of items per page.
name string
The name of the collection.

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.0.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

NameDescription
message string (required)
A localized message string describing the error condition.
_id string
A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string.
read-only
statusCode integer
The HTTP status code associate with this error.
minimum: 100
maximum: 599
type string
An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt string(date-time)
An RFC 3339 UTC time stamp indicating when the error occurred.
attributes attributes
Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type.
remediation string
An optional localized string which provides hints for how the user or client can resolve the error.
errors [error]
An optional array of nested error objects. This property is not always present.
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": {}
    }
  }
}

Error Response (v2.1.0)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

This schema was resolved from common/errorResponse.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only

estimatedAnnualRevenue

"unknown"

Estimated Annual Revenue (v1.0.0)

The estimated annual revenue in USD.

Warning: the enum list will be removed in a future release and the values defined at runtime via the estimatedAnnualRevenue group in the response from the getLabels operation.

This schema was resolved from organizations/estimatedAnnualRevenue.

Type: string
Enumerated values:
unknown
under1Million
from1to10Million
from10to100Million
over100Million
other
notApplicable

estimatedMonthlyAmounts

{
  "percentGrossRevenue": "string",
  "sentAch": "upToOneHundredThousand",
  "receivedAch": "oneHundredThousandToOneMillion",
  "achTransactions": "oneHundredThousandToOneMillion",
  "mobileCheckDeposit": "oneHundredThousandToOneMillion",
  "remoteCheckDeposit": "oneHundredThousandToOneMillion",
  "sentWire": "oneHundredThousandToOneMillion",
  "receivedWire": "moreThanOneMillion",
  "wireTransfers": "oneHundredThousandToOneMillion"
}

Estimated Monthly Amounts (v1.1.0)

Estimated monthly amounts for banking services.

This schema was resolved from organizations/estimatedMonthlyAmounts.

Properties

NameDescription
percentGrossRevenue string
The percentage of gross revenue the organization derives from money services per month. Use this or achTransactions.

The allowed values for this property are defined at runtime in the label group named percentGrossRevenue in the response from the getLabels operation.

sentAch string
The estimated total amount sent by ACH per month.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlySentAchAmounts in the response from the getLabels operation.

receivedAch string
The estimated total amount received by ACH per month.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyReceivedAchAmounts in the response from the getLabels operation.

achTransactions string
The estimated total amount sent or received by ACH per month. Use this or sentAch/receivedAch.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyAchTransactionAmounts in the response from the getLabels operation.

mobileCheckDeposit string
The estimated amount deposited by mobile app per month.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyMobileCheckDepositAmounts in the response from the getLabels operation.

remoteCheckDeposit string
The estimated amount deposited remotely, via scanned images, per month.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyRemoteCheckDepositAmounts in the response from the getLabels operation.

sentWire string
The estimated wire transfer amount sent per month. Use this or wireTransfers.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlySentWireAmounts in the response from the getLabels operation.

receivedWire string
The estimated wire transfers amount received per month. Use this or wireTransfers.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyReceivedWireAmounts in the response from the getLabels operation.

wireTransfers string
The estimated wire transfer amount sent or received per month. Use this or sentWire/receivedWire.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyWireTransferAmounts in the response from the getLabels operation.

estimatedMonthlyCounts

{
  "sentAch": "oneHunredOneToOneThousand",
  "receivedAch": "oneHunredOneToOneThousand",
  "achTransactions": "oneHunredOneToOneThousand",
  "mobileCheckDeposit": "oneHunredOneToOneThousand",
  "remoteCheckDeposit": "oneHunredOneToOneThousand",
  "sentWire": "oneToOneHundred",
  "receivedWire": "oneToOneHundred",
  "wireTransfers": "oneToOneHundred"
}

Estimated Monthly Counts (v1.0.0)

Estimated monthly activity for banking services.

This schema was resolved from organizations/estimatedMonthlyCounts.

Properties

NameDescription
sentAch string
The estimated number of ACH transactions sent per month. Use this or achTransaction.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlySentAchCount in the response from the getLabels operation.

receivedAch string
The estimated number of ACH transactions sent per month. Use this or achTransaction.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyReceivedAchCount in the response from the getLabels operation.

achTransactions string
The estimated total number of ACH transactions per month. Use this or sendAch/`receivedAch.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyAchTransactionCount in the response from the getLabels operation.

mobileCheckDeposit string
The estimated number of mobile app deposits per month.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyMobileCheckDepositCount in the response from the getLabels operation.

remoteCheckDeposit string
The estimated number of remote deposits (via scanned images) per month.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyRemoteCheckDepositCount in the response from the getLabels operation.

sentWire string
The estimated number of wires sent per month. Use this or wireTransfers.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlySentWireCount in the response from the getLabels operation.

receivedWire string
The estimated number of wires received per month. Use this or wireTransfers.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyReceivedWireCount in the response from the getLabels operation.

wireTransfers string
The estimated number of wire transfers sent or received per month. Use this or sentWire/receivedWire.

The allowed values for this property are defined at runtime in the label group named estimatedMonthlyWireTransferCount in the response from the getLabels operation.

externalAccountState

"active"

External Account State (v1.1.0)

The state of an external (linked) banking account. This field is immutable and derived.

To change the state of an account, POST the account ID to the corresponding resource endpoints, using the corresponding link on the external account resource:

externalAccountState strings may have one of the following enumerated values:

ValueDescription
pendingPending: A new external account that has not been verified.
verifyingVerifying: A new account that is being verified. This state only applies to external accounts.
failedFailed: A external account which has failed account verification.
activeActive: An account which is active and available for use and for making new transactions.
inactiveInactive: An account which is marked inactive and not available for new transactions. Inactive accounts may be changed back to active.
frozenFrozen: An account which is frozen and not eligible for new transactions. This is typically the result of suspicious activity or fraud detection. The user must contact their financial institution to unfreeze the account (by changing the state back to active) or the financial institution may opt to close the account.
closedClosed: An account that is closed and removed from use. Closed accounts are not eligble for transactions or to become active. Such accounts are retained for historical purposes because some transactions may refer to it. Users do not see closed accounts when they view their accounts.
underReviewUnder Review: A new external account that under is review.
microDepositsRequestedMicro-deposits Requested: A new external account that is starting micro deposits verification. This state only applies to external accounts.

These enumeration values are further described by the label group named externalAccountState in the response from the getLabels operation.

This schema was resolved from accounts/externalAccountState.

Type: string
Enumerated values:
pending
verifying
failed
active
inactive
frozen
closed
underReview
microDepositsRequested

foreignPoliticalFigureAssociation

"unknown"

foreign Political Figure Association (v1.0.0)

The type of association to a foreign political figure. This enumeration is described by the foreignPoliticalFigureAssociation value from the getLabels operation.

foreignPoliticalFigureAssociation strings may have one of the following enumerated values:

ValueDescription
unknownUnknown: The association status of this individual is unknown.
closeAssociateClose Associate: This individual is a close associate of a foreign political figure.
familyMemberFamily Member: This individual is a family member of a foreign political figure.
noneNone: This individual has no association to a foreign political figure.
otherOther
notApplicableNot Applicable

These enumeration values are further described by the label group named foreignPoliticalFigureAssociation in the response from the getLabels operation.

This schema was resolved from users/foreignPoliticalFigureAssociation.

Type: string
Enumerated values:
unknown
closeAssociate
familyMember
none
other
notApplicable

fraudRiskCategory

{
  "type": "personalInfoDoesNotMatch",
  "description": "The retrieved identity does not match the provided PII.",
  "message": "ZIP code located does not match the ZIP code submitted."
}

Fraud-risk Category (v1.0.0)

Representation of a fraud-risk category.

This schema was resolved from identity/fraudRiskCategory.

Properties

NameDescription
type fraudRiskCategoryType
Represents the possible types of fraud-risk.

fraudRiskCategoryType strings may have one of the following enumerated values:

ValueDescription
ipRestrictedIP Restricted: The user's IP address is restricted.
identityOnGovernmentWatchlistOn Government Watch list: The identity is on a government watch list.
identityOnAlertListOn Alert List: The identity is on an alert list.
addressIsPOBoxOrNonApprovedAddress is PO Box or non-approved
addressIsHighRiskAddress is high risk
ageRestrictedAge Restricted: The person's age is restricted
nonStandardTaxIdNon-standard Tax ID
personalInfoDoesNotMatchPersonal information does not match
emailRestrictedEmail Restricted: The person's email address is restricted.

These enumeration values are further described by the label group named fraudRiskCategoryType in the response from the getLabels operation.

This schema was resolved from identity/fraudRiskCategoryType.

description string
The description of the fraud.
message string
The original result message that was received from the identity verification provider.

fraudRiskCategoryType

"ipRestricted"

Fraud Risk Category Type (v1.0.0)

Represents the possible types of fraud-risk.

fraudRiskCategoryType strings may have one of the following enumerated values:

ValueDescription
ipRestrictedIP Restricted: The user's IP address is restricted.
identityOnGovernmentWatchlistOn Government Watch list: The identity is on a government watch list.
identityOnAlertListOn Alert List: The identity is on an alert list.
addressIsPOBoxOrNonApprovedAddress is PO Box or non-approved
addressIsHighRiskAddress is high risk
ageRestrictedAge Restricted: The person's age is restricted
nonStandardTaxIdNon-standard Tax ID
personalInfoDoesNotMatchPersonal information does not match
emailRestrictedEmail Restricted: The person's email address is restricted.

These enumeration values are further described by the label group named fraudRiskCategoryType in the response from the getLabels operation.

This schema was resolved from identity/fraudRiskCategoryType.

Type: string
Enumerated values:
ipRestricted
identityOnGovernmentWatchlist
identityOnAlertList
addressIsPOBoxOrNonApproved
addressIsHighRisk
ageRestricted
nonStandardTaxId
personalInfoDoesNotMatch
emailRestricted

fraudRiskReport

{
  "_profile": "https://production.api.apiture.com/schemas/identity/fraudRiskReport/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/identity/fraudRiskReports/c6dbc32f-e0eb-4947-9819-c691bb9164a5"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/6da5ccc7-727a-4256-bdd4-74023ae349c3"
    }
  },
  "_id": "c6dbc32f-e0eb-4947-9819-c691bb9164a5",
  "type": "fraudRiskReport",
  "inputs": {
    "identity": {
      "taxId": "*****3333",
      "firstName": "John",
      "lastName": "Smith",
      "address1": "1741 Tiburon Dr",
      "city": "Wilmington",
      "region": "NC",
      "postalCode": "28403",
      "phone": "555-555-5555",
      "birthdate": "1940-10-15",
      "email": "api@apiture.com",
      "ipAddress": "127.0.0.1"
    }
  },
  "outputs": {
    "state": "passedWithRiskFactors",
    "fraudRiskCategories": {
      "0": {
        "type": "personalInfoDoesNotMatch",
        "description": "The retrieved identity does not match the provided PII."
      },
      "1": {
        "type": "addressIsHighRisk",
        "description": "The provided address is considered high-risk"
      },
      "2": {
        "type": "addressIsPOBoxOrNonApproved",
        "description": "The provided address is a PO Box or other non-approved address"
      },
      "3": {
        "type": "identityOnGovernmentWatchlist",
        "description": "The provided identity is located on one or more watchlists"
      },
      "4": {
        "type": "ipRestricted",
        "description": "The provided IP address is restricted"
      },
      "5": {
        "type": "emailRestricted",
        "description": "The provided email address is restricted"
      },
      "6": {
        "type": "nonStandardTaxId",
        "description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
      },
      "7": {
        "type": "ageRestricted",
        "description": "The provided identity does not meet the required age. Example: US COPPA laws forbid conducting e-commerce with people under 14 years of age."
      }
    },
    "token": "m8JhbGciOiJIUzI1NiIsInRjWgQzWXcXNrz0ogtVhfEd2o"
  }
}

Fraud-risk Report (v2.1.0)

The result of running a fraud-risk analysys.

Response and request bodies using this fraudRiskReport schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this fraud-risk reportGET
apiture:user The userGET
apiture:contact The contactGET

This schema was resolved from identity/fraudRiskReport.

Properties

NameDescription
_links links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
A unique identifier for this resource instance. This is is an opaque string.
read-only
createdAt string(date-time)
The date-time when the resource was created. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.
expiresAt string(date-time)
The date-time when the resource expires. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.
type identityVerificationType
The type of identity verification report. A fraud-risk report uses type of fraudRiskReport.
read-only
inputs fraudRiskReportInputs
The inputs of a fraud-risk report.

This schema was resolved from identity/fraudRiskReportInputs.

outputs fraudRiskReportOutputs
The outputs of a fraud-risk report.

This schema was resolved from identity/fraudRiskReportOutputs.

fraudRiskReportInputs

{
  "identity": {
    "taxId": "112-22-3333",
    "firstName": "John",
    "lastName": "Smith",
    "address1": "1741 Tiburon Dr",
    "city": "Wilmington",
    "region": "NC",
    "postalCode": "28403",
    "phone": "+15555555555",
    "birthdate": "1940-10-15",
    "email": "api@apiture.com",
    "ipAddress": "127.0.0.1"
  }
}

Fraud-risk Report Inputs (v1.0.0)

The inputs of a fraud-risk report.

This schema was resolved from identity/fraudRiskReportInputs.

Properties

NameDescription
identity identity
Information that describes the identity.

This schema was resolved from identity/identity.

fraudRiskReportOutputs

{
  "token": "string",
  "providerReportId": "string",
  "state": "passed",
  "fraudRiskCategories": [
    {
      "type": "personalInfoDoesNotMatch",
      "description": "The retrieved identity does not match the provided PII.",
      "message": "ZIP code located does not match the ZIP code submitted."
    }
  ]
}

Fraud-risk Report Outputs (v1.0.0)

The outputs of a fraud-risk report.

This schema was resolved from identity/fraudRiskReportOutputs.

Properties

NameDescription
token string
An opaque string that conveys the state of the contact's identity verification.
providerReportId string
External identity provider report Id.
state fraudRiskReportState
The state of a fraud report. passed indicates that the provided personally identifiable information (PII) was located and contains no risk factors. passedWithRiskFactors means that the provided PII matches an identity but contains risk factors. failed means that the provided PII does not match any identity records.

fraudRiskReportState strings may have one of the following enumerated values:

ValueDescription
passedPassed: Identity verification passed.
failedFailed: Identity verification failed.
passedWithRiskFactorsPassed with Risk Factors: Identity verification passed with risk factors.

These enumeration values are further described by the label group named fraudRiskReportState in the response from the getLabels operation.

This schema was resolved from identity/fraudRiskReportState.

fraudRiskCategories [fraudRiskCategory]
A list of categories in this report.

fraudRiskReportState

"passed"

Fraud Risk Report State (v1.0.0)

The state of a fraud report. passed indicates that the provided personally identifiable information (PII) was located and contains no risk factors. passedWithRiskFactors means that the provided PII matches an identity but contains risk factors. failed means that the provided PII does not match any identity records.

fraudRiskReportState strings may have one of the following enumerated values:

ValueDescription
passedPassed: Identity verification passed.
failedFailed: Identity verification failed.
passedWithRiskFactorsPassed with Risk Factors: Identity verification passed with risk factors.

These enumeration values are further described by the label group named fraudRiskReportState in the response from the getLabels operation.

This schema was resolved from identity/fraudRiskReportState.

Type: string
Enumerated values:
passed
passedWithRiskFactors
failed

identification

{
  "type": "taxId",
  "value": "112-22-3333",
  "expiration": "2024-12-01"
}

Identification (v1.0.1)

Official identifying information associated with the contact.

This schema was resolved from contacts/identification.

Properties

NameDescription
value string (required)
The value of this form of identification, such as tax ID as a string. The caller should pass the full value (for example "112-22-3333") when creating a contact or user. The input value may include '-' formatting characters. This is a masked value in API responses, with one or more leading '*' characters and only the last four characters unmasked, such as "*****3333".
type identificationType (required)
The type of this form of identification.
expiration string(date)
The date when the form of identification expires, in RFC 3339 YYYY-MM-DD format.

identificationModel

[
  {
    "value": "string",
    "type": "taxId"
  }
]

Identification Model (v1.0.0)

A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.

identificationModel is an array schema.

Array Elements

NameDescription
Identification Model (v1.0.0) [object]
A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.

value string (required)
The value of this form of identification (the tax ID as a string, for example)
type string (required)
The type of this form of identification. For a person, taxId is their federal tax ID (such as social security number). For a business, taxId is the Federal Employer Identification Number or FEIN (also known as Tax Identification Number or TIN), and dunsNumber is the business' Dun & Bradstreet Number.


Enumerated values:
taxId
dunsNumber

identificationType

"taxId"

Identification Type (v1.0.0)

The type of this form of identification.

identificationType strings may have one of the following enumerated values:

ValueDescription
taxIdTax ID: The government tax ID, such as a Social Security Number
passportNumberPassport Number

These enumeration values are further described by the label group named identificationType in the response from the getLabels operation.

This schema was resolved from contacts/identificationType.

Type: string
Enumerated values:
taxId
passportNumber

identity

{
  "taxId": "112-22-3333",
  "firstName": "John",
  "lastName": "Smith",
  "address1": "1741 Tiburon Dr",
  "city": "Wilmington",
  "region": "NC",
  "postalCode": "28403",
  "phone": "+15555555555",
  "birthdate": "1940-10-15",
  "email": "api@apiture.com",
  "ipAddress": "127.0.0.1"
}

Identity (v1.0.0)

Information that describes the identity.

This schema was resolved from identity/identity.

Properties

NameDescription
taxId string (required)
The identity's masked tax or government ID. In requests, the full tax ID is required. In responses, the tax ID is masked; only the last four digits are shown. The mask consists of one ore more '*' characters.
minLength: 1
maxLength: 128
firstName string (required)
The identity's first name.
minLength: 1
maxLength: 128
lastName string (required)
The identity's last name.
minLength: 1
maxLength: 128
address1 string (required)
Line 1 of the identity's street address.
minLength: 1
maxLength: 512
address2 string
Line 2 of the identity's street address.
minLength: 1
maxLength: 512
city string