Shell HTTP Node.JS JavaScript Ruby Python Java Go

Account Applications v0.38.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:

  • account applicant(s) and their identity verification status
  • banking product for the new account
  • documents (required documents, uploaded instances, approvals)
  • consents the applicant has given (such as terms and conditions for the banking product, electronic consent)
  • external funding account and amount (Transfer)
  • business verifications (for business accounts)
  • workflow/business process used to perform the application process
  • application approval

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:

  • running → canceled | expired | approved | rejected
  • blocked → running | canceled | expired | approved | rejected

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.

groupNotFound

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.

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

invalidApprovalState

Description: The approval state corresponding to this document does not allow document replacement.
Remediation: Document replacement is allowed only if the approval state is pending or submitted or if there is no corresponding approval yet.

invalidDocumentType

Description: The type of the document does not match the document requirement.
Remediation: Use a type that matches the corresponding document requirement.

invalidDocumentUri

Description: The document named by the uri cannot be fetched.
Remediation: Use the URI of the document's content.

invalidProcessState

Description: The state of the application or enrollment process does not allow replacing documents.
Remediation: Document replacement is only allowed for running or blocked processes.

invalidPromotionCode

Description: The code is not valid, not valid for for this product, or has expired.
Remediation: Use a promotion valid code for the banking 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.

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.

malformedRequestBody

Description: The supplied request body was malformed.
Remediation: Ensure that your request body exists and that it does not contain syntax errors.

noSuchApplicationOrEnrollment

Description: The processId does not correspond to an account application or enrollment resource.
Remediation: use the _id of an account application or enrollment resource.

noSuchDocument

Description: The document index is greater than the index of the last required document.
Remediation: Use a document index in the range [0, requiredDocuments.length).

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.

valueNotFound

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.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Authentication

  • API Key (apiKey)
    • header parameter: API-Key
    • API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

  • OAuth2 authentication (accessToken)
    • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
    • Flow: authorizationCode
    • Authorization URL = https://auth.devbank.apiture.com/auth/oauth2/authorize
    • Token URL = https://api.devbank.apiture.com/auth/oauth2/token
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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

ParameterDescription
start
in: 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.
format: int64
default: 0
limit
in: query
 integer(int32)
The maximum number of account application representations to return in this page.
format: int32
default: 100
sortBy
in: 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
in: 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
in: query
 string
Optional search string. See searching.
state
in: 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.
enum values: pending, running, blocked, canceled, expired, rejected, approved
name
in: 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
in: 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
in: 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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/applications

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

Parameters

ParameterDescription
start
in: 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.
format: int64
default: 0
limit
in: query
 integer(int32)
The maximum number of account application representations to return in this page.
format: int32
default: 100
sortBy
in: 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
in: 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
in: 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
in: 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
in: 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
in: query
 string
Optional search string. See searching.
user
in: 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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/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


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/createApplication/v3.6.0/profile.json",
  "_links": {
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "accountName": "My checking account",
  "applicants": [
    {
      "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": [
    {
      "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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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.6.0/profile.json",
  "_links": {
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "accountName": "My checking account",
  "applicants": [
    {
      "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": [
    {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  ]
}

Parameters

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

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderLocation
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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/applications/{applicationId}

Return a HAL representation of this account application resource.

Parameters

ParameterDescription
applicationId
in: path
 string (required)
The unique identifier of this application. This is an opaque string.
unmasked
in: 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.
default: false
If-None-Match
in: 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.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

409 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/enrollments

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

Parameters

ParameterDescription
start
in: 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.
format: int64
default: 0
limit
in: query
 integer(int32)
The maximum number of enrollment representations to return in this page.
format: int32
default: 100
sortBy
in: 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
in: 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
in: 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
in: 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
in: query
 string
Optional search string. See searching.
user
in: 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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/enrollments/v2.8.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryEnrollment/v1.9.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryEnrollment/v1.9.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}

Return a HAL representation of this enrollment resource.

Parameters

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollment
HeaderETag
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.
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

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


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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}';
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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Parameters

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollment
HeaderETag
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.
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

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


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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}';
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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Parameters

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

StatusDescription
200 OK
OK.
Schema: enrollment
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/enrollments/{enrollmentId}

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

Parameters

ParameterDescription
enrollmentId
in: path
 string (required)
The unique identifier of this enrollment. This is an opaque string.

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/application/v2.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to rejected.
Schema: enrollment
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to approved.
Schema: enrollment
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

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

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Responses

StatusDescription
200 OK
OK. The operation succeeded. The enrollment was updated and its state changed to canceled.
Schema: enrollment
HeaderETag
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.
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

Documents

Documents related to applications and enrollments

replaceDocument

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/accountApplications/processes/{processId}/documents/{documentIndex} \
  -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/processes/{processId}/documents/{documentIndex} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json


const fetch = require('node-fetch');
const inputBody = '{
  "uri": "https://api.devbank.apiture.com/vault/files/7d0e5c70-6efd-4d7e-84c8-d62335227080",
  "contentType": "image/jpeg",
  "type": "governmentId"
}';
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/processes/{processId}/documents/{documentIndex}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


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/processes/{processId}/documents/{documentIndex}',
  method: 'put',

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


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/processes/{processId}/documents/{documentIndex}',
  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/processes/{processId}/documents/{documentIndex}', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.devbank.apiture.com/accountApplications/processes/{processId}/documents/{documentIndex}");
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/processes/{processId}/documents/{documentIndex}", data)
    req.Header = headers

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

Provide a new document for the application or enrollment

PUT https://api.devbank.apiture.com/accountApplications/processes/{processId}/documents/{documentIndex}

Add a missing document or replace an existing document for an active application or enrollment process. The process' state must be running or blocked. The type of the document must also match the type of the corresponding requiredDocuments[{documentIndex}].

Note that uploading a new document may affect the process' (application or enrollment) corresponding workflow.

Body parameter

{
  "uri": "https://api.devbank.apiture.com/vault/files/7d0e5c70-6efd-4d7e-84c8-d62335227080",
  "contentType": "image/jpeg",
  "type": "governmentId"
}

Parameters

ParameterDescription
body documentReplacement (required)
processId
in: path
 string (required)
The unique _id of an account application resource or an enrollment resource.
documentIndex
in: path
 integer (required)
The zero-based array index within the documents array associated with the application or enrollment. This also corresponds to an item in the requiredDocuments array.
minimum: 0

Example responses

200 Response

{
  "uri": "https://api.devbank.apiture.com/vault/files/7d0e5c70-6efd-4d7e-84c8-d62335227080",
  "contentType": "image/jpeg",
  "type": "governmentId"
}

Responses

StatusDescription
200 OK
OK. The new document was added to the account application or enrollment process.
Schema: documentReplacement
StatusDescription
404 Not Found

Not Found.

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

Schema: errorResponse
StatusDescription
409 Conflict

Conflict. The operation is not allowed because it would result in a system conflict or inconsistency.

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

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


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/createResourceTrackingIds/v1.1.1/profile.json",
  "_links": {},
  "trackingIds": [
    "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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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.

The caller must have entitlements to update the application (i.e. the primary applicant) in order to add tracking IDs.

Body parameter

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

Parameters

ParameterDescription
body createResourceTrackingIds
applicationId
in: path
 string (required)
The unique identifier of this application. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/resourceTrackingIds/v1.1.3/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": [
    {
      "id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
      "createdAt": "2021-06-07T09:11:02.375Z"
    },
    {
      "id": "55c9141a-94d5-4ae8-b664-9ac4c9eaea2d",
      "createdAt": "2021-07-011T15:33:00.375Z"
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: resourceTrackingIds
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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.

The caller must have entitlements to read the application (i.e. the primary applicant) in order to read tracking IDs.

Parameters

ParameterDescription
If-None-Match
in: 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
in: path
 string (required)
The unique identifier of this application. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/resourceTrackingIds/v1.1.3/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": [
    {
      "id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
      "createdAt": "2021-06-07T09:11:02.375Z"
    },
    {
      "id": "55c9141a-94d5-4ae8-b664-9ac4c9eaea2d",
      "createdAt": "2021-07-011T15:33:00.375Z"
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: resourceTrackingIds
HeaderETag
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.
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

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


const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/promotionCode/v1.0.1/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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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.1/profile.json",
  "_links": {},
  "code": "SAVE2021"
}

Parameters

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/validatedPromotionCode/v1.0.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

ParameterDescription
Accept-Language
in: 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.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "groups": {
    "firstGroup": {
      "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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/apiDoc

Return the OpenAPI document that describes this API.

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/configurations/groups

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/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
HeaderETag
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.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

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

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
HeaderETag
string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

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

Example responses

200 Response

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

Responses

StatusDescription
200 OK
OK.
Schema: configurationValues
HeaderETag
string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT
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 is invalid. It is either not valid JSON or it does not conform to the corresponding configuration group schema. The _error field in the response will contain details about the request error.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

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

Parameters

ParameterDescription
groupName
in: path
 string (required)
The unique name of this configuration group.
If-Match
in: header
 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body configurationValues (required)

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
HeaderETag
string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT
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
403 Forbidden
Access denied. Only administrators may update configuration.
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

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


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);
});


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));
  }
})


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 https://api.devbank.apiture.com/accountApplications/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

  • a primitive number, boolean, or quoted JSON string.
  • a JSON array.
  • a JSON object.
  • null.

Examples:

  • "a string configuration value"
  • 120
  • true
  • null
  • { "borderWidth": 8, "foregroundColor": "blue" }

To update a specific value, use PUT /accountApplications/configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

ParameterDescription
groupName
in: path
 string (required)
The unique name of this configuration group.
valueName
in: 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 | '-' | '_']*.

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
HeaderETag
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.
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

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 'If-Match: string' \
  -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
If-Match: string


const fetch = require('node-fetch');
const inputBody = 'string';
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/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});


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/{valueName}',
  method: 'put',

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


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/{valueName}',
  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/{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"},
        "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/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

PUT https://api.devbank.apiture.com/accountApplications/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

  • a primitive number, boolean, or quoted JSON string.
  • a JSON array.
  • a JSON object.
  • null.

Examples:

  • "a string configuration value"
  • 120
  • true
  • null
  • { "borderWidth": 8, "foregroundColor": "blue" }

To fetch specific value, use GET /accountApplications/configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

ParameterDescription
groupName
in: path
 string (required)
The unique name of this configuration group.
valueName
in: 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 | '-' | '_']*.
If-Match
in: header
 string (required)
The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
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.

Example responses

200 Response

"string"

Responses

StatusDescription
200 OK
OK.
Schema: string
HeaderETag
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.
StatusDescription
400 Bad Request
Bad Request. The request body is invalid. It is either not valid JSON or it does not conform to the corresponding configuration group schema. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
403 Forbidden
Access denied. Only administrators may update configuration.
Schema: errorResponse
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
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

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
Abstract Request (v2.0.0) object
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.

_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
format: uri

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
Abstract Resource (v2.0.0) object
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.

_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
format: uri
_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
Account Numbers (v1.0.0) object
Different representations of an account number.

This schema was resolved from common/accountNumbers.

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


enum values: unknown, creditCardProcessing, generalOperatingFunds, lottery, payroll, savings, other, notApplicable

accountVerificationMethod

"instant"

Account Verification Method (v1.0.0)

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.

type: string


enum values: instant, microDeposits

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


enum 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
Address (v1.0.0) object
A postal address.

This schema was resolved from businessVerifications/address.

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


enum 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": [
      {
        "type": "taxId",
        "value": "*****3333"
      }
    ],
    "emailAddresses": [
      {
        "_id": "ea1",
        "value": "api@apiture.com",
        "type": "personal",
        "id": "pe0"
      },
      {
        "_id": "ek3",
        "value": "support@apiture.com",
        "type": "work",
        "id": "wp1"
      }
    ],
    "preferredEmailAddressId": "ea1",
    "phones": [
      {
        "_id": "pa1",
        "type": "home",
        "number": "+19105550155"
      },
      {
        "_id": "da6",
        "type": "mobile",
        "number": "+19105550155"
      },
      {
        "_id": "wp1",
        "type": "work",
        "number": "+19105550162",
        "extension": "4512"
      }
    ],
    "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",
    "preferredContactMethod": "email",
    "_profile": "https://production.api.apiture.com/schemas/contacts/contact/v2.1.3/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.2/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
      }
    },
    "firstName": "John",
    "middleName": "Daniel",
    "lastName": "Smith",
    "addresses": [
      {
        "_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"
          }
        }
      },
      {
        "_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": [
      {
        "id": "pe0",
        "value": "johnny1733@example.com",
        "type": "personal",
        "_id": "pe0"
      },
      {
        "id": "wp1",
        "value": "support@apiture.com",
        "type": "work",
        "_id": "we0"
      }
    ],
    "preferredEmailAddressId": "pe0",
    "phones": [
      {
        "_id": "hp0",
        "type": "home",
        "number": "+19105550155"
      },
      {
        "_id": "mp0",
        "type": "mobile",
        "number": "+19105550159"
      },
      {
        "_id": "wp1",
        "type": "work",
        "number": "+19105550162",
        "extension": "4512"
      }
    ],
    "preferredPhoneId": "hp0",
    "preferredName": "John",
    "suffix": "MD",
    "identification": [
      {
        "type": "taxId",
        "value": "********3333"
      }
    ],
    "preferredContactMethod": "email",
    "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
    "username": "Johnny1733",
    "residencyStatus": "resident",
    "customerId": 47294723672,
    "birthdate": "1974-10-27",
    "citizenship": [
      {
        "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": [
      {
        "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"
      },
      {
        "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.2.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.2.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.1/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": [
        {
          "type": "personalInfoDoesNotMatch",
          "description": "The retrieved identity does not match the provided PII."
        },
        {
          "type": "addressIsHighRisk",
          "description": "The provided address is considered high-risk"
        },
        {
          "type": "addressIsPOBoxOrNonApproved",
          "description": "The provided address is a PO Box or other non-approved address"
        },
        {
          "type": "identityOnGovernmentWatchlist",
          "description": "The provided identity is located on one or more watchlists"
        },
        {
          "type": "ipRestricted",
          "description": "The provided IP address is restricted"
        },
        {
          "type": "emailRestricted",
          "description": "The provided email address is restricted"
        },
        {
          "type": "nonStandardTaxId",
          "description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
        },
        {
          "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.6.1)

An applicant for a new account.

Properties

NameDescription
Applicant (v1.6.1) object
An applicant for a new account.
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.
deprecated: true
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.
deprecated: true
approvals array: [approval]
Any approvals associated with this applicant.
items: object
consents array: [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.
items: object
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.9.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",
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0,
  "accountVerificationMethod": "instant",
  "fundingAccount": {
    "title": "Elsa Snowqueen",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "full": "9876543210",
      "masked": "*************3210"
    }
  },
  "newAccounts": [
    {
      "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.9.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 Banking ProductGET
apiture:applicant ApplicantGET
apiture:organization OrganizationGET
apiture:fundingAccount Funding AccountGET
apiture:workflow WorkflowGET
apiture:approval Application ApprovalGET

Properties

NameDescription
Account Application (v2.9.0) object

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 Banking ProductGET
apiture:applicant ApplicantGET
apiture:organization OrganizationGET
apiture:fundingAccount Funding AccountGET
apiture:workflow WorkflowGET
apiture:approval Application ApprovalGET
_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
format: uri
_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
enum values: pending, running, blocked, canceled, expired, rejected, approved
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
format: date-time
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
format: date-time
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
format: date-time
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.
enum values: personal, business
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 array: [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
items: object
requiredDocuments array: [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.
items: object
documents array: [applicationDocument]
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. The items in this array match with the requiredDocuments 1-to-1 and items may be null if the user has not yet uploaded the corresponding required document.
items: object
approvals array: [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
items: object
products array: [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
items: object
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 array: [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.
items: object
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.

completedTaskCount integer(int32)
The number of visible workflow tasks which have been completed.
read-only
format: int32
minimum: 0
runningTaskCount integer(int32)
The number of visible workflow tasks which are currently running.
read-only
format: int32
minimum: 0
runningTaskNames array: [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
items: string
pendingTaskCount integer(int32)
The number of visible workflow tasks which are still pending.
read-only
format: int32
minimum: 0
blockedTaskCount integer(int32)
The number of visible workflow tasks which are blocked.
read-only
format: int32
minimum: 0
canceledTaskCount integer(int32)
The number of visible workflow tasks which have been canceled.
read-only
format: int32
minimum: 0
newAccounts array: [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.
items: object
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
format: date-time
accountVerificationMethod accountVerificationMethod
Optional account verification method that was used for linking a new external account.
read-only
enum 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
Application Account (v1.0.0) object
Descriptive information about a new account being opened via this application.
_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
format: uri
_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: true
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
enum values: CCA, CDA, CLA, CMA, DDA, EQU, GLA, ILA, INV, IRA, IRL, LOC, MLA, MMA, PBA, PPA, RWD, SDA
usageAnswers usageAnswers
Answers to financial institution questions on how the account is to be used.
Additional Properties: true

applicationDocument

{
  "uri": "https://www.example.com/",
  "contentType": "image/jpeg",
  "type": "governmentId",
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applicationDocument/v1.1.0/profile.json",
  "_links": {
    "apiture:replace": {
      "href": "https://api.devbank.apiture.com/accountApplications/processes/2da08d87-8fcb-479b1e9d52e1/documents/2"
    }
  }
}

Application Document (v1.1.0)

A document uploaded as part of the application or enrollment process.

Response and request bodies using this applicationDocument schema may contain the following links:

RelSummaryMethod
apiture:replaceProvide a new document for the application or enrollmentPUT

Properties

NameDescription
Application Document (v1.1.0) object

A document uploaded as part of the application or enrollment process.

Response and request bodies using this applicationDocument schema may contain the following links:

RelSummaryMethod
apiture:replaceProvide a new document for the application or enrollmentPUT
uri string (required)
A URI of the document which the applicant has uploaded and which is to be reviewed and approved or rejected. The document must reside in the document storage system. This may be the URI of a file in the Vault API, or a raw document.
contentType string (required)
The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
type string (required)
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents, such as a governmentId etc.). This corresponds to the type of a file in the Vault API.
_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.

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


enum values: pending, running, blocked, canceled, expired, rejected, approved

applicationWorkflowTasks

{
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Application Workflow Tasks (v1.0.0)

Properties which describe the detailed state of the workflow tasks.
The schema applicationWorkflowTasks was added on version 0.36.0 of the API.

Properties

NameDescription
Application Workflow Tasks (v1.0.0) object
Properties which describe the detailed state of the workflow tasks.
The schema applicationWorkflowTasks was added on version 0.36.0 of the API.
completedTaskCount integer(int32)
The number of visible workflow tasks which have been completed.
read-only
format: int32
minimum: 0
runningTaskCount integer(int32)
The number of visible workflow tasks which are currently running.
read-only
format: int32
minimum: 0
runningTaskNames array: [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
items: string
pendingTaskCount integer(int32)
The number of visible workflow tasks which are still pending.
read-only
format: int32
minimum: 0
blockedTaskCount integer(int32)
The number of visible workflow tasks which are blocked.
read-only
format: int32
minimum: 0
canceledTaskCount integer(int32)
The number of visible workflow tasks which have been canceled.
read-only
format: int32
minimum: 0

applications

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/applications/v2.6.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/applications/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/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.1)

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
Account Application Collection (v2.6.1) object
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.
_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 array: [summaryApplication]
An array containing a page of account application items.
items: object
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
format: uri
_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.2.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.2.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.2.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
apiture:target Approval TargetGET
apiture:approvalTypeFetch a representation of this approval typeGET

This schema was resolved from approvals/approval.

Properties

NameDescription
Approval (v1.2.0) object
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
apiture:target Approval TargetGET
apiture:approvalTypeFetch a representation of this approval typeGET

This schema was resolved from approvals/approval.

_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
format: uri
_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
default: "open"
enum values: open, submitted, approved, rejected, waived, returned, canceled
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
format: date-time
_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
format: date-time
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
format: date-time
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.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. `governmentId` approvals may not be waived or canceled.",
    "disallowedStates": [
      "waived",
      "canceled"
    ],
    "domain": "https://production.api.apiture.com/domains/approvals/documentRequirement",
    "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
  },
  "target": {}
}

Approval Embedded Objects (v1.1.0)

The objects which participate in this approval.

This schema was resolved from approvals/approvalEmbeddedObjects.

Properties

NameDescription
Approval Embedded Objects (v1.1.0) object
The objects which participate in this approval.

This schema was resolved from approvals/approvalEmbeddedObjects.

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
Approval Fields (v1.0.0) object
Common fields of the approval resource, used to define other model schemas.

This schema was resolved from approvals/approvalFields.

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
default: "open"
enum values: open, submitted, approved, rejected, waived, returned, canceled
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
format: date-time

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


default: "open"
enum 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
Approval Type Fields (v1.0.0) object
Common fields of the approval resource used to build other model schemas.

This schema was resolved from approvals/approvalTypeFields.

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 array: [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.
items: string
» enum values: rejected, waived, returned, canceled

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

This schema was resolved from common/attributeValue.

Properties

NameDescription
Attribute Value (v2.0.0) object
The data associated with this attribute.

This schema was resolved from common/attributeValue.

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
Attributes (v2.0.0) object
An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Attribute Value (v2.0.0) attributeValue
The data associated with this attribute.

This schema was resolved from common/attributeValue.

authorization

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": [
    {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "_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
Authorization (v1.1.0) object
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.

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 array: [address] (required)
An array of postal/mailing addresses.
items: object
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.
format: email
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.

enum values: primary, joint, authorizedSigner
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.

  • primary the person is the primary owner of a personal account. There may be only one primary owner.
  • joint the person is a non-primary joint owner of a personal account.
  • authorizedSigner the person is an authorized signer for all business accounts owned by the organization.

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


enum 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
Authorized Signer (v1.0.0) object
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.

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 array: [object]
A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.
items: object

birthdate string(date)
The authorized signer's birth date in yyyy-mm-dd format.
format: date
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.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "items": [
    {
      "_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": [
        {
          "_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.3)

The list of users who are authorized to access the organization and its bank accounts.

This schema was resolved from organizations/authorizedSigners.

Properties

NameDescription
Authorized Signers (v1.2.3) object
The list of users who are authorized to access the organization and its bank accounts.

This schema was resolved from organizations/authorizedSigners.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items array: [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
items: object

beneficialOwner

{
  "firstName": "William",
  "middleName": "Daniel",
  "lastName": "Wellphunded",
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "1234 S 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",
  "emailAddresses": [
    {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "pe0",
  "phones": [
    {
      "_id": "hp1",
      "type": "home",
      "number": "+19105550155"
    },
    {
      "_id": "mp1",
      "type": "mobile",
      "number": "+19105550159"
    },
    {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  ],
  "preferredPhoneId": "hp1",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "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
Beneficial Owner (v1.4.0) object
A person who owns 25% or more of a business organization.

This schema was resolved from organizations/beneficialOwner.

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 array: [address]
An array of postal/mailing addresses.
items: object
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
emailAddresses array: [typedEmailAddress]
An array of email addresses.
items: object
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
phones array: [phoneNumber]
An array of phone numbers.
items: object
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 array: [identification] (required)
A collection of official identifying information associated with the contact.
items: object
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
enum values: unknown, sms, email, other, notApplicable
_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.
minimum: 0
maximum: 100
birthdate string(date)
The beneficial owner's birth date in YYYY-MM-DD format.
format: date
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.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": [
    {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": [
        {
          "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": [
        {
          "type": "taxId",
          "value": "111-11-1111"
        }
      ],
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  ]
}

Beneficial Owners (v1.4.1)

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
Beneficial Owners (v1.4.1) object
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.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items array: [beneficialOwner] (required)
A list of people who own at least 25% of the business, and the percentage owned.
maxLength: 10
items: object

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
Business Verification Report (v1.0.0) object
The verification report contains analsys of the business data and includes the state of the verification.

This schema was resolved from businessVerifications/businessVerification.

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.
enum values: passed, failed
completedAt string(date-time)
An ISO 8601 UTC time stamp indicating when the verification report was created.
format: date-time
type string
The identity method type. Possible values are verificationReport or administratorApproval.
enum 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
Business Verification Score (v1.0.0) object
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.

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": [
    {
      "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"
        }
      }
    },
    {
      "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
Business Verifications (v2.0.0) object
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.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
businessVerifications array: [businessVerification]
An array of business verification resources
items: object

citizenship

{
  "countryCode": "US",
  "state": "citizen"
}

Citizenship (v1.0.0)

Citizenship or nationality status.

This schema was resolved from contacts/citizenship.

Properties

NameDescription
Citizenship (v1.0.0) object
Citizenship or nationality status.

This schema was resolved from contacts/citizenship.

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.
enum 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.1)

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
Collection (v2.1.1) object
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.

_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
format: uri
_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
Authorized Representative Comprehensive Verification Score (v1.0.0) object
The comprehensive verification score is a risk verification score for the authorized representative.

This schema was resolved from businessVerifications/comprehensiveVerificationScore.

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.1/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.1)

Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

Properties

NameDescription
Configuration Group (v2.1.1) object
Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

_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
format: uri
_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.1/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.1)

A summary of the data contained within a configuration group resource.

This schema was resolved from configurations/configurationGroupSummary.

Properties

NameDescription
Configuration Group Summary (v2.1.1) object
A summary of the data contained within a configuration group resource.

This schema was resolved from configurations/configurationGroupSummary.

_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
format: uri
_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.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.1/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.1)

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
Configuration Group Collection (v2.1.1) object
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.

_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
format: uri
_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.1/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.1)

Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

Properties

NameDescription
Configuration Groups Embedded Objects (v1.1.1) object
Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

items array: [configurationGroupSummary]
An array containing a page of configuration group items.
items: object

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
Configuration Schema (v2.1.0) object
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.

Configuration Schema Value (v2.0.0) 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

NameDescription
Configuration Schema Value (v2.0.0) object
The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

NameDescription
Configuration Value (v2.0.0) object
The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

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
Configuration Values (v2.0.0) object
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.

Configuration Value (v2.0.0) 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.1/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.1)

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
Consent (v1.1.1) object
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.

_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
format: uri
_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.
format: uri
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.
format: uri
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
enum values: pending, given, stale, rescinded, revoked
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
format: date-time
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
format: date-time
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
format: date-time

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
Consent Fields (v1.1.0) object
Common fields of the consent resource used to build other model schemas.

This schema was resolved from consents/consentFields.

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.
format: uri
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.
format: uri
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


enum 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
Product Constraints (v1.0.0) object
Product constraints, such as minimum and maximum balances.

This schema was resolved from products/constraints.

transactionTypes array: [transactionType]
The types of transactions permitted for this account. Values which appear in this array are permitted.
items: string
» enum values: debit, credit
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.
format: period
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.
format: period

contact

{
  "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": "pe0"
    },
    {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work",
      "id": "wp1"
    }
  ],
  "preferredEmailAddressId": "ea1",
  "phones": [
    {
      "_id": "pa1",
      "type": "home",
      "number": "+19105550155"
    },
    {
      "_id": "da6",
      "type": "mobile",
      "number": "+19105550155"
    },
    {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  ],
  "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",
  "preferredContactMethod": "email",
  "_profile": "https://production.api.apiture.com/schemas/contacts/contact/v2.1.3/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.3)

Representation of a contact resource. Contact data (mailing addresses, phone numbers, email addresses) for an individual.

This schema was resolved from contacts/contact.
deprecated

Properties

NameDescription
Contact (v2.1.3) object
Representation of a contact resource. Contact data (mailing addresses, phone numbers, email addresses) for an individual.

This schema was resolved from contacts/contact.
deprecated: true

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: true
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: true
enum 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: true
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 array: [address]
An array of postal/mailing addresses.
items: object
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
emailAddresses array: [typedEmailAddress]
An array of email addresses.
items: object
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
phones array: [phoneNumber]
An array of phone numbers.
items: object
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 array: [identification]
A collection of official identifying information associated with the contact.
items: object
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
enum values: unknown, sms, email, other, notApplicable
birthdate string(date)
The contact's birth date in YYYY-MM-DD format.
format: date
citizenship array: [citizenship]
This individual's citizenship or nationality status.
items: object
residencyStatus residencyStatus
This individual's residency status.
enum values: unknown, resident, nonresident, residentAlien, nonresidentAlien, other, notApplicable
occupation occupation
The occupation of this individual.
enum values: unknown, architectureAndEngineering, artsDesignEntertainmentSportsAndMedia, buildingAndGroundsCleaningAndMaintenance, businessAndFinancialOperations, communityAndSocialService, computerAndMathematical, constructionAndExtraction, educationTrainingAndLibrary, farmingFishingAndForestry, foodPreparationAndServingRelated, healthcarePractitionersAndTechnical, healthcareSupport, installationMaintenanceAndRepair, legal, lifePhysicalAndSciences, management, militarySpecific, officeAndAdministrativeSupport, personalCareAndService, production, protectiveServices, salesAndRelated, transportationAndMaterialMoving, other, notApplicable
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: true
enum values: unknown, oneOrFewer, two, three, fourOrMore
_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
format: uri
_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
enum values: inactive, active, merged, removed
_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.
format: date-time
updatedAt string(date-time)
The date-time when the contact was updated
format: date-time

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


enum 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": [
    {
      "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"
    },
    {
      "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
Verification (v2.1.0) object
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: true

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
verifications array: [identityHistoryItem]
The history of this contact's identity verifications.
items: object

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.3)

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.27.0 of the API.

This schema was resolved from contacts/contactVerificationFields.
deprecated

Properties

NameDescription
Contact Fields (v1.1.3) object
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.27.0 of the API.

This schema was resolved from contacts/contactVerificationFields.
deprecated: true

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: true
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: true
enum 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: true

createApplication

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/createApplication/v3.6.0/profile.json",
  "_links": {
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/51df9a81-2cb8-4515-aad1-9543b3c4fc18"
    }
  },
  "accountName": "My checking account",
  "applicants": [
    {
      "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": [
    {
      "name": "Personal Savings",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/products/products/40ed6e40-cffa-4944-8d54-f9b50ed2081f"
        }
      }
    }
  ]
}

Create Account Application (v3.6.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:

  • products - an array of one or more Product objects which determine the banking product for the new account(s). The first(required) item in the array is the primary account; others are optional secondary accounts in a product bundle. The products must be an active internal account products that is eligible for opening new accounts. ("newAccountAvailability": "available")

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
Create Account Application (v3.6.0) object
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:

  • products - an array of one or more Product objects which determine the banking product for the new account(s). The first(required) item in the array is the primary account; others are optional secondary accounts in a product bundle. The products must be an active internal account products that is eligible for opening new accounts. ("newAccountAvailability": "available")

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.

_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
format: uri
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 array: [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
items: object
requiredDocuments array: [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.
items: object
documents array: [applicationDocument]
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. The items in this array match with the requiredDocuments 1-to-1 and items may be null if the user has not yet uploaded the corresponding required document.
items: object
approvals array: [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
items: object
products array: [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
items: object
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 array: [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.
items: object
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.9.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
Create an Enrollment (v1.9.0) object
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.
_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
format: uri
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: true
applicants array: [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
items: object
requiredDocuments array: [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.
items: object
documents array: [applicationDocument]
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. The items in this array match with the requiredDocuments 1-to-1 and items may be null if the user has not yet uploaded the corresponding required document.
items: object
approvals array: [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
items: object

createResourceTrackingIds

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

Create Resource Tracking IDs (v1.1.1)

A tracking ID to add to a resource.

This schema was resolved from common/createResourceTrackingIds.

Properties

NameDescription
Create Resource Tracking IDs (v1.1.1) object
A tracking ID to add to a resource.

This schema was resolved from common/createResourceTrackingIds.

_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
format: uri
trackingIds array: [string]
An array of trackings ID to add to the resource.
unique items
minItems: 1
maxItems: 16
items: string
» minLength: 4
» maxLength: 80
» pattern: "^[-_a-zA-Z0-9$]{4,80}$"

createVerificationReport

{
  "businessName": "ABC EXAMPLE CO.",
  "phone": "555-555-1234",
  "identification": [
    {
      "type": "taxId",
      "value": "12-347894309"
    }
  ],
  "attributes": {},
  "addresses": [
    {
      "addressLine1": "3212 N. 2nd Ave.",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28412"
    }
  ],
  "authorizedSigners": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "identification": [
        {
          "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
Create Verification Report (v2.0.0) object
Representation used to create a new verification report.

This schema was resolved from businessVerifications/createVerificationReport.

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 array: [object]
A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.
items: object

authorizedSigners array: [authorizedSigner]
An optional array of authorized signer entities
items: object
addresses array: [address]
An array of postal mailing addresses for this contact.
items: object
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
format: uri

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


enum 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
Document (v1.0.0) object
Properties of a target document.

This schema was resolved from consents/document.

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.)
format: uri
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).
format: date-time

documentReplacement

{
  "uri": "https://api.devbank.apiture.com/vault/files/7d0e5c70-6efd-4d7e-84c8-d62335227080",
  "contentType": "image/jpeg",
  "type": "governmentId"
}

Document Replacement (v1.0.0)

A document uploaded to replace a document within the application or enrollment process.

Properties

NameDescription
Document Replacement (v1.0.0) object
A document uploaded to replace a document within the application or enrollment process.
uri string (required)
A URI of the document which the applicant has uploaded and which is to be reviewed and approved or rejected. The document must reside in the document storage system. This may be the URI of a file in the Vault API, or a raw document.
contentType string (required)
The media type for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
type string (required)
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents, such as a governmentId etc.). This corresponds to the type of a file in the Vault API.

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


enum 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.

type: string

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"
    }
  },
  "completedTaskCount": 4,
  "runningTaskCount": 1,
  "runningTaskNames": [
    "uploadDocuments"
  ],
  "pendingTaskCount": 8,
  "blockedTaskCount": 0,
  "canceledTaskCount": 0
}

Digital Banking User Enrollment (v1.12.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
apiture:account AccountGET
apiture:product Banking ProductGET
apiture:organization OrganizationGET

Properties

NameDescription
Digital Banking User Enrollment (v1.12.0) object

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
apiture:account AccountGET
apiture:product Banking ProductGET
apiture:organization OrganizationGET
applicants array: [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
items: object
requiredDocuments array: [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.
items: object
documents array: [applicationDocument]
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. The items in this array match with the requiredDocuments 1-to-1 and items may be null if the user has not yet uploaded the corresponding required document.
items: object
approvals array: [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
items: object
_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
format: uri
_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
enum values: pending, running, blocked, canceled, expired, rejected, approved
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
format: date-time
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
format: date-time
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
format: date-time
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: true
_id string
The unique identifier for this application. This is an immutable opaque string.
read-only
completedTaskCount integer(int32)
The number of visible workflow tasks which have been completed.
read-only
format: int32
minimum: 0
runningTaskCount integer(int32)
The number of visible workflow tasks which are currently running.
read-only
format: int32
minimum: 0
runningTaskNames array: [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
items: string
pendingTaskCount integer(int32)
The number of visible workflow tasks which are still pending.
read-only
format: int32
minimum: 0
blockedTaskCount integer(int32)
The number of visible workflow tasks which are blocked.
read-only
format: int32
minimum: 0
canceledTaskCount integer(int32)
The number of visible workflow tasks which have been canceled.
read-only
format: int32
minimum: 0
productRates productInterestRates
The interest rates for accounts based on this product. For deposit products, the rates describe the rate of return. For loan products, this includes the interest rate charged on balances. The apy, apye, nominal and apr values are a decimal percentage, coded as strings in order to represent the rate exactly. Rates are coded to two or three decimal places. Rates can be fixed, such { "apy" : "1.40" } for 1.4% APY. Rates (usually only on loan accounts) may relative to a benchmark, such as { "benchmark" : "primeUs", "apr" : "0.50" } to express U.S. Prime Rate + 0.5%.

This schema was resolved from products/productInterestRates.

productName string
The name of the banking product associated with this enrollment.
read-only
minLength: 1
maxLength: 128
productTarget productTarget
The target of the banking product associated with this enrollment.
enum values: personal, business
organizationName string
The name of the organization, if this is an enrollment for a business account.
read-only
minLength: 1
maxLength: 128

enrollments

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/enrollments/v2.8.1/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": [
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryEnrollment/v1.9.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365c"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "My Personal Checking",
        "state": "running"
      },
      {
        "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryEnrollment/v1.9.1/profile.json",
        "_links": {
          "self": {
            "href": "/accountApplications/enrollments/0399abed-fd3d-4830-a88b-30f38b8a365d"
          }
        },
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "state": "approved"
      }
    ]
  }
}

Enrollment Collection (v2.8.1)

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
Enrollment Collection (v2.8.1) object
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.
_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 array: [summaryEnrollment]
An array containing a page of account application items.
items: object
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
format: uri
_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
Error (v2.0.0) object
Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

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.
format: date-time
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 array: [error]
An optional array of nested error objects. This property is not always present.
items: object

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/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.1)

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
Error Response (v2.1.1) object
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.

_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
format: uri
_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


enum 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
Estimated Monthly Amounts (v1.1.0) object
Estimated monthly amounts for banking services.

This schema was resolved from organizations/estimatedMonthlyAmounts.

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
Estimated Monthly Counts (v1.0.0) object
Estimated monthly activity for banking services.

This schema was resolved from organizations/estimatedMonthlyCounts.

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:

  • To activate an account, use the apiture:activate link to POST to /accounts/activeAccounts. * To deactivate an account, use the apiture:deactivate link to POST to /accounts/inactiveAccounts. * To freeze an account, use the apiture:freeze link to POST to /accounts/frozenAccounts. * To close an account, use the apiture:close link to POST to /accounts/closedAccounts. * To mark an account as under review, use the apiture:review link to POST to /accounts/externalAccountsUnderReview. * To mark an account as being verified via micro-deposits, use the apiture:requestMicroDepositVerification link to POST to /externalAccountsNeedingMicroDepositVerification.

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


enum values: pending, verifying, failed, active, inactive, frozen, closed, underReview, microDepositsRequested

foreignPoliticalFigureAssociation

"unknown"

Foreign Political Figure Association (v1.1.1)

Describes if/how the person is associated with a foreign political figure.

foreignPoliticalFigureAssociation strings may have one of the following enumerated values:

ValueDescription
unknownUnknown
closeAssociateClose Associate: This person is a close associate of a foreign political figure.
familyMemberFamily Member: This person is a family of a foreign political figure.
noneNone: This person is not associated with 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.
Warning: The schema foreignPoliticalFigureAssociation was deprecated on version v0.19.0 of the API. Use foreignPoliticalFigureAssociation on kycAnswers schema in Users API instead. foreignPoliticalFigureAssociation will be removed on version v0.27.0 of the API.

This schema was resolved from contacts/foreignPoliticalFigureAssociation.
deprecated

type: string


deprecated: true
enum 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
Fraud-risk Category (v1.0.0) object
Representation of a fraud-risk category.

This schema was resolved from identity/fraudRiskCategory.

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.
enum values: ipRestricted, identityOnGovernmentWatchlist, identityOnAlertList, addressIsPOBoxOrNonApproved, addressIsHighRisk, ageRestricted, nonStandardTaxId, personalInfoDoesNotMatch, emailRestricted

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


enum 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": [
      {
        "type": "personalInfoDoesNotMatch",
        "description": "The retrieved identity does not match the provided PII."
      },
      {
        "type": "addressIsHighRisk",
        "description": "The provided address is considered high-risk"
      },
      {
        "type": "addressIsPOBoxOrNonApproved",
        "description": "The provided address is a PO Box or other non-approved address"
      },
      {
        "type": "identityOnGovernmentWatchlist",
        "description": "The provided identity is located on one or more watchlists"
      },
      {
        "type": "ipRestricted",
        "description": "The provided IP address is restricted"
      },
      {
        "type": "emailRestricted",
        "description": "The provided email address is restricted"
      },
      {
        "type": "nonStandardTaxId",
        "description": "The provided taxId is non-standard. Example: The provided SSN is an ITIN (Individual Taxpayer Identification Number)"
      },
      {
        "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
Fraud-risk Report (v2.1.0) object
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.

_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
format: uri
_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.
format: date-time
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.
format: date-time
type identityVerificationType
The type of identity verification report. A fraud-risk report uses type of fraudRiskReport.
read-only
enum values: fraudRiskReport, quiz, adminApproval
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
Fraud-risk Report Inputs (v1.0.0) object
The inputs of a fraud-risk report.

This schema was resolved from identity/fraudRiskReportInputs.

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
Fraud-risk Report Outputs (v1.0.0) object
The outputs of a fraud-risk report.

This schema was resolved from identity/fraudRiskReportOutputs.

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.
enum values: passed, passedWithRiskFactors, failed

fraudRiskCategories array: [fraudRiskCategory]
A list of categories in this report.
items: object

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


enum 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
Identification (v1.0.1) object
Official identifying information associated with the contact.

This schema was resolved from contacts/identification.

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.
enum values: taxId, passportNumber
expiration string(date)
The date when the form of identification expires, in RFC 3339 YYYY-MM-DD format.
format: date

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

type: array: [object]

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


enum 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
Identity (v1.0.0) object
Information that describes the identity.

This schema was resolved from identity/identity.

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 (required)
The identity's city.
minLength: 1
maxLength: 64
region string (required)
The identity's region.
minLength: 1
maxLength: 128
postalCode string (required)
The identity's postal code.
minLength: 1
maxLength: 32
phone string (required)
The identity's phone.
minLength: 1
maxLength: 32
birthdate string(date) (required)
The identity's birth date in yyyy-mm-dd format.
format: date
minLength: 10
maxLength: 10
pattern: "^([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$"
email string(email)
The identity's email address.
format: email
maxLength: 256
ipAddress string(ipv4)
The identity's IP address.
format: ipv4

identityHistoryItem

{
  "state": "passed",
  "createdAt": "2019-11-21T08:43:54.375Z",
  "type": "quiz",
  "_links": {
    "apiture:user": {
      "href": "https://api.example.bank/users/users/d77bef0b-c75c-4192-ba88-278b9ce4063b"
    }
  }
}

Identity Verification Item (v1.0.0)

One verification record for a contact's history of verifications.

This schema was resolved from identity/identityHistoryItem.

Properties

NameDescription
Identity Verification Item (v1.0.0) object
One verification record for a contact's history of verifications.

This schema was resolved from identity/identityHistoryItem.

_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.

state identityVerificationState (required)
The type of the historical verification.

identityVerificationState strings may have one of the following enumerated values:

ValueDescription
passedPassed: Identity verification passed.
failedFailed: Identity verification failed.
passedWithRiskFactorsPassedWithRiskFactors: Identity verification passed with risk factors.
pendingPending: Identity verification has not started.
askedAsked: Identity verification is in progress, after personal questions have been presented to the user.
identityServiceFailureIdentityServiceFailure: Identity verification failed to complete due to a failure in a back-end or third party service.
scoringScoring: Identity verification is generating a verification score.
expiredExpired: The user did not complete the identity verification process before it expired.

These enumeration values are further described by the label group named identityVerificationState in the response from the getLabels operation.

This schema was resolved from identity/identityVerificationState.
enum values: passed, failed, passedWithRiskFactors, pending, asked, identityServiceFailure, scoring, expired

type identityVerificationType
Describes how the identity verification was performed.

identityVerificationType strings may have one of the following enumerated values:

ValueDescription
fraudRiskReportFraud Risk Report: Verification performed by generating a fraud risk report based on the identity's personal information.
quizQuiz: Verification performed by executing a quiz based on personal knowledge the individual should know.
adminApprovalAdmin Approval: Verification performed by an administrator explicitly approving the identity, for example after manually inspecting identity verification documents from the user.

These enumeration values are further described by the label group named identityVerificationType in the response from the getLabels operation.

This schema was resolved from identity/identityVerificationType.
enum values: fraudRiskReport, quiz, adminApproval

createdAt string(date-time) (required)
The date-time when the verification occurred or completed. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.
format: date-time
expiredAt string(date-time)
The date-time when the verification expired. This is only set if the state is expired. This is an RFC 3066 time stamp in the form YYYY-DD-MMThh:mm:ss.sssZ.
format: date-time

identityVerification

{
  "provider": "string",
  "sessionId": "string",
  "scoredAt": "2019-09-13T06:11:01.375Z",
  "score": "passed",
  "state": "verified"
}

Identity Verification Data (v1.1.2)

Data points on the identity verification process that tells if a user has passed, failed or expired the identity check.
Warning: The schema identityVerification was deprecated on version v0.19.0 of the API. Use identity verification of the user in the Identity service instead. identityVerification will be removed on version v0.27.0 of the API.

This schema was resolved from contacts/identityVerification.
deprecated

Properties

NameDescription
Identity Verification Data (v1.1.2) object
Data points on the identity verification process that tells if a user has passed, failed or expired the identity check.
Warning: The schema identityVerification was deprecated on version v0.19.0 of the API. Use identity verification of the user in the Identity service instead. identityVerification will be removed on version v0.27.0 of the API.

This schema was resolved from contacts/identityVerification.
deprecated: true

provider string
The name of the identity verification provider.
Warning: The property provider was deprecated on version v1.1.0 of the schema. Use identity verification of the user in the Identity service instead. provider will be removed on version v2.0.0 of the schema.
deprecated: true
sessionId string
The unique id for a session of the identity verification process.
Warning: The property sessionId was deprecated on version v1.1.0 of the schema. Use identity verification of the user in the Identity service instead. sessionId will be removed on version v2.0.0 of the schema.
deprecated: true
scoredAt string(date-time)
The date-time when the provider ran identity verification. This is an RFC 3339 time stamp.
Warning: The property scoredAt was deprecated on version v1.1.0 of the schema. Use identity verification of the user in the Identity service instead. scoredAt will be removed on version v2.0.0 of the schema.
format: date-time
deprecated: true
score string
The indication if the contact has passed or failed the identity verification process.
Warning: The property score was deprecated on version v1.1.0 of the schema. Use identity verification of the user in the Identity service instead. score will be removed on version v2.0.0 of the schema.
deprecated: true
enum values: passed, failed, expired
state string
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 state was deprecated on version v1.1.0 of the schema. Use identity verification of the user in the Identity service instead. state will be removed on version v2.0.0 of the schema.
read-only
deprecated: true
enum values: verified, unverified

identityVerificationState

"passed"

IdentityVerification Type (v1.0.0)

The type of the historical verification.

identityVerificationState strings may have one of the following enumerated values:

ValueDescription
passedPassed: Identity verification passed.
failedFailed: Identity verification failed.
passedWithRiskFactorsPassedWithRiskFactors: Identity verification passed with risk factors.
pendingPending: Identity verification has not started.
askedAsked: Identity verification is in progress, after personal questions have been presented to the user.
identityServiceFailureIdentityServiceFailure: Identity verification failed to complete due to a failure in a back-end or third party service.
scoringScoring: Identity verification is generating a verification score.
expiredExpired: The user did not complete the identity verification process before it expired.

These enumeration values are further described by the label group named identityVerificationState in the response from the getLabels operation.

This schema was resolved from identity/identityVerificationState.

type: string


enum values: passed, failed, passedWithRiskFactors, pending, asked, identityServiceFailure, scoring, expired

identityVerificationType

"fraudRiskReport"

Identity Verification Type (v1.0.0)

Describes how the identity verification was performed.

identityVerificationType strings may have one of the following enumerated values:

ValueDescription
fraudRiskReportFraud Risk Report: Verification performed by generating a fraud risk report based on the identity's personal information.
quizQuiz: Verification performed by executing a quiz based on personal knowledge the individual should know.
adminApprovalAdmin Approval: Verification performed by an administrator explicitly approving the identity, for example after manually inspecting identity verification documents from the user.

These enumeration values are further described by the label group named identityVerificationType in the response from the getLabels operation.

This schema was resolved from identity/identityVerificationType.

type: string


enum values: fraudRiskReport, quiz, adminApproval

ifxType

"CCA"

IFX Account Type (v1.0.1)

A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.

ifxType strings may have one of the following enumerated values:

ValueDescription
CCACredit card account
CDACertificate of deposit account (CD)
CLACommercial loan account
CMACash management account
DDADemand deposit account
EQUHome equity loan
GLAGeneral ledger account
ILAInstallment loan account
INVInvestment account
IRAIndividual retirement account
IRLAccounts held in Ireland
LOCConsumer line of credit
MLAMilitary Lending Account: Credit facility held by former US service member
MMAMoney market account
PBAPackaged bank Account: Account with additional benefits that charges a fixed monthly fee.
PPAPrivate pension administrator
RWDReward accounts
SDASavings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

type: string


enum values: CCA, CDA, CLA, CMA, DDA, EQU, GLA, ILA, INV, IRA, IRL, LOC, MLA, MMA, PBA, PPA, RWD, SDA

interestRateTier

{
  "apy": "1.40",
  "nominal": "1.445",
  "minimumBalance": "12000.00"
}

Interest Rate Tier (v1.0.0)

The rates offered for accounts whose minimum balance within the statement period meets or exceeds the tier's minimumBalance and which do not also meet the minimumBalance of a higher tier.

This schema was resolved from products/interestRateTier.

Properties

NameDescription
Interest Rate Tier (v1.0.0) object
The rates offered for accounts whose minimum balance within the statement period meets or exceeds the tier's minimumBalance and which do not also meet the minimumBalance of a higher tier.

This schema was resolved from products/interestRateTier.

minimumBalance string (required)
The minimum balance that a deposit account must hold to earn the rate in this tier. This value is expressed in the product's currency.
nominal string(decimal) (required)
The effective interest rate before accounting for inflation. Used on deposit and loan account products.
read-only
format: decimal
pattern: "^-?\\d{1,2}\\.\\d{2,3}$"
apy string(decimal) (required)
The annual percentage yield (APY): the effective yield from interest, including compounding, as a percentage. Used on deposit account products.
read-only
format: decimal
pattern: "^-?\\d{1,2}\\.\\d{2}$"

intermediaryServices

"unknown"

Intermediary Services (v1.0.0)

The intermediary/non-bank financial institution services provided.

Warning: the enum list will be removed in a future release and the values defined at runtime via the intermediaryServices group in the response from the getLabels operation.

This schema was resolved from organizations/intermediaryServices.

type: string


enum values: unknown, accounting, fundsManagement, insurance, investment, legal, medical, notary, realEstate, taxPreparation, trustManagement, gambling, securities, loanFinance, pawnBrokerage, travelAgency, vehicleSales, foreignCurrency, preciousMetals, other, notApplicable

kycAnswers

{
  "foreignPoliticalFigure": false,
  "foreignPoliticalFigureCountry": "st",
  "foreignPoliticalFigureAssociation": "unknown"
}

Know Your Customer Answers (v1.1.2)

Answers to 'Know Your Customer' questions which allow financial institutions to conform to a customer identification program.
Warning: The schema kycAnswers was deprecated on version v0.19.0 of the API. Use kycAnswers on user schema in Users API instead. kycAnswers will be removed on version v0.27.0 of the API.

This schema was resolved from contacts/kycAnswers.
deprecated

Properties

NameDescription
Know Your Customer Answers (v1.1.2) object
Answers to 'Know Your Customer' questions which allow financial institutions to conform to a customer identification program.
Warning: The schema kycAnswers was deprecated on version v0.19.0 of the API. Use kycAnswers on user schema in Users API instead. kycAnswers will be removed on version v0.27.0 of the API.

This schema was resolved from contacts/kycAnswers.
deprecated: true

foreignPoliticalFigure boolean
true if the person is a foreign senior political figure.
default: false
foreignPoliticalFigureCountry string
If the person is a foreign senior political figure, this is the foreign country ISO 3166-1 country code. This field is omitted if foreignPoliticalFigure is false.
maxLength: 2
foreignPoliticalFigureAssociation foreignPoliticalFigureAssociation
The type of association to a foreign political figure.
deprecated: true
enum values: unknown, closeAssociate, familyMember, none, other, notApplicable

labelGroup

{
  "unknown": {
    "label": "Unknown",
    "code": "0",
    "hidden": true
  },
  "under1Million": {
    "label": "Under $1M",
    "code": "1",
    "range": "[0,1000000.00)",
    "variants": {
      "fr": {
        "label": "Moins de $1M"
      }
    }
  },
  "from1to10Million": {
    "label": "$1M to $10M",
    "code": "2",
    "range": "[1000000.00,10000000.00)",
    "variants": {
      "fr": {
        "label": "$1M \\u00e0 $10M"
      }
    }
  },
  "from10to100Million": {
    "label": "$10M to $100M",
    "code": "3",
    "range": "[10000000.00,100000000.00)",
    "variants": {
      "fr": {
        "label": "$10M \\u00e0 $100M"
      }
    }
  },
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  },
  "other": {
    "label": "Other",
    "code": "254"
  }
}

Label Group (v1.0.3)

A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:

  • Unknown
  • Under $1M
  • $1M to $10M
  • $10M to $100M
  • $100M or more

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

Properties

NameDescription
Label Group (v1.0.3) object
A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:

  • Unknown
  • Under $1M
  • $1M to $10M
  • $10M to $100M
  • $100M or more

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

Label Item (v1.0.2) labelItem
An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

labelGroups

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "groups": {
    "firstGroup": {
      "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": "_"
      }
    }
  }
}

Label Groups (v1.1.3)

A set of named groups of labels, each of which contains multiple item labels.

The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00).

This schema was resolved from common/labelGroups.

Properties

NameDescription
Label Groups (v1.1.3) object
A set of named groups of labels, each of which contains multiple item labels.

The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00).

This schema was resolved from common/labelGroups.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
groups object
Groups of localized labels. This maps group names → a group of labels within that group.
» Label Group (v1.0.3) labelGroup
A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00).

This allows the client to let the user select a value from a list, such as the following derived from the labels in the example:

  • Unknown
  • Under $1M
  • $1M to $10M
  • $10M to $100M
  • $100M or more

Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }.

This schema was resolved from common/labelGroup.

labelItem

{
  "label": "Over $100,000,000.00",
  "code": "4",
  "range": "[100000000.00,]",
  "variants": {
    "fr": {
      "label": "Plus de $10M"
    }
  }
}

Label Item (v1.0.2)

An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

Properties

NameDescription
Label Item (v1.0.2) object
An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.

This schema was resolved from common/labelItem.

label string (required)
A label or title which may be used as labels or other UI controls which present a value.
description string
A more detailed localized description of a localizable label.
variants object
The language-specific variants of this label. The keys in this object are RFC 7231 language codes.
» Simple Label (v1.0.0) simpleLabel
A text label and optional description.

This schema was resolved from common/simpleLabel.

code string
If the localized value is associated with an external standard or definition, this is a lookup code or key or URI for that value.
minLength: 1
hidden boolean
If true, this item is normally hidden from the User Interface.
range string
The range of values, if the item describes a bounded numeric value. This is range notation such as [min,max], (exclusiveMin,max], [min,exclusiveMax), or (exclusiveMin,exclusiveMax). For example, [0,100) is the range greater than or equal to 0 and less than 100. If the min or max value are omitted, that end of the range is unbounded. For example, (,1000.00) means less than 1000.00 and [20000.00,] means 20000.00 or more. The ranges do not overlap or have gaps.
pattern: "^[\\[\\(](-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?,(-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?[\\]\\)]$" 

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

Link (v1.0.0)

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

NameDescription
Link (v1.0.0) object
Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

href string(uri) (required)
The URI or URI template for the resource/operation this link refers to.
format: uri
type string
The media type for the resource.
templated boolean
If true, the link's href is a URI template.
title string
An optional human-readable localized title for the link.
deprecation string(uri)
If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation.
format: uri
profile string(uri)
The URI of a profile document, a JSON document which describes the target resource/operation.
format: uri 

{
  "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"
  }
}

Links (v1.0.0)

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.

NameDescription
Links (v1.0.0) object
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.

Link (v1.0.0) link
Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

money

{
  "value": "3456.78",
  "currency": "str"
}

Money (v1.0.0)

An amount of money in a specific currency.

This schema was resolved from transactions/money.

Properties

NameDescription
Money (v1.0.0) object
An amount of money in a specific currency.

This schema was resolved from transactions/money.

value string
The net monetary value. A negative amount denotes a debit; a positive amount a credit. The numeric value is represented as a string so that it can be exact with no loss of precision.
currency string
The ISO 4217 currency code for this monetary value. This is always upper case ASCII. Note: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters.
minLength: 3
maxLength: 3

occupation

"unknown"

Occupation (v1.0.0)

The person's occupation.

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 occupation in the response from the getLabels operation.

This schema was resolved from contacts/occupation.

type: string


enum values: unknown, architectureAndEngineering, artsDesignEntertainmentSportsAndMedia, buildingAndGroundsCleaningAndMaintenance, businessAndFinancialOperations, communityAndSocialService, computerAndMathematical, constructionAndExtraction, educationTrainingAndLibrary, farmingFishingAndForestry, foodPreparationAndServingRelated, healthcarePractitionersAndTechnical, healthcareSupport, installationMaintenanceAndRepair, legal, lifePhysicalAndSciences, management, militarySpecific, officeAndAdministrativeSupport, personalCareAndService, production, protectiveServices, salesAndRelated, transportationAndMaterialMoving, other, notApplicable

organization

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "phones": [
    {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": [
      "trustManagement"
    ],
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": [],
  "beneficialOwners": [],
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_embedded": {}
}

Organization (v1.7.3)

Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for an organization.

An organization which is used for a business banking account may have authorized signers, which are people authorized to perform banking operations on the business account(s) such as initiating funds transfers.

Regulations require identifying an organization's beneficial owners: people who own 25% or more of a business. These may be listed and updated with the getBeneficialOwners and updateBeneficialOwners operations.

An organization may have the following links in the _links object:

  • apiture:activate - Activate a new, pending organization.
  • apiture:deactivate - Deactivate an organization (if it is pending or active).
  • apiture:remove - Remove an inactive organization.
  • apiture:authorizedSigners - List the authorized signers.
  • apiture:beneficialOwners - List the beneficial owners.

This schema was resolved from organizations/organization.

Properties

NameDescription
Organization (v1.7.3) object
Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for an organization.

An organization which is used for a business banking account may have authorized signers, which are people authorized to perform banking operations on the business account(s) such as initiating funds transfers.

Regulations require identifying an organization's beneficial owners: people who own 25% or more of a business. These may be listed and updated with the getBeneficialOwners and updateBeneficialOwners operations.

An organization may have the following links in the _links object:

  • apiture:activate - Activate a new, pending organization.
  • apiture:deactivate - Deactivate an organization (if it is pending or active).
  • apiture:remove - Remove an inactive organization.
  • apiture:authorizedSigners - List the authorized signers.
  • apiture:beneficialOwners - List the beneficial owners.

This schema was resolved from organizations/organization.

_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 organizationEmbeddedObjects
Embedded objects, as selected with the ?embed query parameter.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
name string
The organization's official full name
label string
The organization's common name.
type organizationType
Indicates what type of organization this resource represents.

The enumeration values are described by the organizationType value in the response of the getLabels operation.

subtype organizationSubtype
A refinement of the type.

The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.

identification array: [organizationIdentification]
A collection of official identifying information associated with the organization. This currently only supports government tax ID.
items: object
addresses array: [organizationAddress]
An array containing address items.
items: object
phones array: [organizationPhoneNumber]
An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
items: object
emailAddresses array: [organizationEmailAddress]
An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
items: object
preferredEmailAddressId string
The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
preferredPhoneId string
The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
taxAddressId string
The _id of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an approved physical address, and it may not be a P.O. Box. This value is set with the setTaxAddress operation.
minLength: 1
maxLength: 4
establishedOn string(date)
The date the organization was established.
format: date
establishedDate string(date)
The date the organization was established.
Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.
format: date
deprecated: true
state organizationState
The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
enum values: pending, inactive, active, merged, removed
tradeName string
The trade name of the organization.
governmentOwned boolean
Indicates whether the organization is a government-owned entity.
publiclyHeld boolean
Indicates whether the organization is publicly held.
smallBusiness boolean
Indicates whether the organization is classified as a small business
taxExempt boolean
Indicates whether the organization is the tax-exempt.
employeeCountRange string
Indicates the approximate number of employees, as a range.

The allowed values for this property are defined at runtime in the label group named employeeCountRange in the response from the getLabels operation.

employeeCountLowerBound integer
The lower bound of persons employed, derived from the range selected in employeeCountRange.
read-only
minimum: 1
employeeCountUpperBound number
The lower bound of persons employed, derived from the range selected in employeeCountRange.
read-only
maximum: 20000000
yearsOwned yearsOwned
The number of years the owners/operators have owned the business. Warning: the enum list will be removed in a future release and the values defined at runtime via the yearsOwned group in the response from the getLabels operation.

This schema was resolved from organizations/yearsOwned.
enum values: unknown, one, two, three, fourOrMoreYears, other, notApplicable

physicalLocationsCount physicalLocationsCount
The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the enum list will be removed in a future release and the values defined at runtime via the physicalLocationsCount group in the response from the getLabels operation.

This schema was resolved from organizations/physicalLocationsCount.
enum values: unknown, under10, from10to50, from50to100, moreThan100, other, notApplicable

homeUrl string
The organization's home page.
industry string
Indicates what industry does this organization work within.

The allowed values for this property are defined at runtime in the label group named industrySectors in the response from the getLabels operation.

countryOfOperations string
The ISO 3166-1 country code for the organization's operation.
minLength: 2
maxLength: 2
regulatory regulatory
Answers to organization-specific regulatory questions.
currency string
The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters.
minLength: 3
maxLength: 3
mobileCheckDepositEnabled boolean
true if mobile check deposits are enabled for the organization.
achEnabled boolean
true if ACH transfers are enabled the organization.
wireEnabled boolean
true if wire transfers are enabled for the organization .
estimatedMonthlyAmounts estimatedMonthlyAmounts
Estimated monthly amounts for banking services.
estimatedMonthlyCounts estimatedMonthlyCounts
Estimated banking activity per month.
accountPurpose accountPurpose
The purpose of the account.
enum values: unknown, creditCardProcessing, generalOperatingFunds, lottery, payroll, savings, other, notApplicable
registeredIn string
The US state or other region in which the organization is registered.

The allowed values for this property are defined at runtime in the label group named regionCodes in the response from the getLabels operation.
minLength: 2
maxLength: 2
pattern: "^[a-zA-Z]{2}$"

_id string
The unique identifier for this organization resource. This is an immutable opaque string.
read-only
customerId string
The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the organization in the banking core. The customerId differs from the _id (which is the ID of the resource in the Organizations API).
read-only
minLength: 1
maxLength: 100
createdAt string(date-time)
The date-time when the organization was created.
format: date-time
updatedAt string(date-time)
The date-time when the organization was updated
format: date-time
coreBanking organizationCoreBanking
Organization properties that are specific to the banking core provider.
read-only
attributes object
An optional map of name/value pairs which provide additional metadata about the organization.

organizationAddress

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ba1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredAddress?value=ba1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/taxAddress?value=ba1"
    }
  },
  "_id": "ba1",
  "type": "business",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "state": "approved"
}

Organization Address (v1.2.1)

Representation of an organization's address resource.

Response and request bodies using this organizationAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this address resourceDELETE
apiture:setAsPreferredSet Preferred Mailing AddressPUT
apiture:setAsTaxAddressSet Tax AddressPUT

This schema was resolved from organizations/organizationAddress.

Properties

NameDescription
Organization Address (v1.2.1) object
Representation of an organization's address resource.

Response and request bodies using this organizationAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this address resourceDELETE
apiture:setAsPreferredSet Preferred Mailing AddressPUT
apiture:setAsTaxAddressSet Tax AddressPUT

This schema was resolved from organizations/organizationAddress.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
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
state profileItemState
The state of this address. pending addresses may require financial institution approval. Only approved addresses may be set as the preferred or tax address.
enum values: pending, approved

organizationCoreBanking

{
  "finxact": {
    "customerGroup": "--64964c9c8e8f----2d-5e-",
    "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
  }
}

Organization Core Banking Properties (v1.0.0)

Organization properties that are specific to the banking core provider. The actual banking core in which the Apiture platfiorm is executing determines what data appears. The sub-object for each banking core is present on a organization only if the Apiture system is connected to the corresponding core banking provider. The name of each sub-object is the name of that provider.

This schema was resolved from organizations/organizationCoreBanking.

Properties

NameDescription
Organization Core Banking Properties (v1.0.0) object
Organization properties that are specific to the banking core provider. The actual banking core in which the Apiture platfiorm is executing determines what data appears. The sub-object for each banking core is present on a organization only if the Apiture system is connected to the corresponding core banking provider. The name of each sub-object is the name of that provider.

This schema was resolved from organizations/organizationCoreBanking.

finxact organizationFinxactCoreBanking
Organization properties that are specific to the Finxact banking core system. This object is present only if the Apiture platform is connected to a Finxact system.
read-only

organizationEmailAddress

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved"
}

Email Address (v1.1.1)

Representation of email address resources. An email address is immutable, although organizations can add new email addresses.

Response and request bodies using this organizationEmailAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this email address resourceDELETE
apiture:setAsPreferredSet Preferred Email AddressPUT

This schema was resolved from organizations/organizationEmailAddress.

Properties

NameDescription
Email Address (v1.1.1) object
Representation of email address resources. An email address is immutable, although organizations can add new email addresses.

Response and request bodies using this organizationEmailAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this email address resourceDELETE
apiture:setAsPreferredSet Preferred Email AddressPUT

This schema was resolved from organizations/organizationEmailAddress.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
value string(email)
The email address, such as JohnBankCustomer@example.com
format: email
minLength: 8
maxLength: 120
type emailType
The kind of email address.
enum values: unknown, personal, work, school, other, notApplicable
_id string
An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
state profileItemState
The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.
enum values: pending, approved

organizationEmbeddedObjects

{
  "authorizedSigners": {
    "_profile": "https://production.api.apiture.com/schemas/organizations/authorizedSigners/v1.2.3/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
      }
    },
    "items": [
      {
        "_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": [
          {
            "_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"
      }
    ]
  },
  "beneficialOwners": {
    "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.1/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
      }
    },
    "items": [
      {
        "_id": "b003",
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": [
          {
            "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": [
          {
            "type": "taxId",
            "value": "111-11-1111"
          }
        ],
        "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
      }
    ]
  }
}

Organization Embedded Objects (v1.2.3)

Objects that are conditionally embedded within an organization object.

This schema was resolved from organizations/organizationEmbeddedObjects.

Properties

NameDescription
Organization Embedded Objects (v1.2.3) object
Objects that are conditionally embedded within an organization object.

This schema was resolved from organizations/organizationEmbeddedObjects.

authorizedSigners authorizedSigners
The list of users who are authorized to access the organization and its bank accounts.

This schema was resolved from organizations/authorizedSigners.

beneficialOwners beneficialOwners
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.

organizationFinxactCoreBanking

{
  "customerGroup": "--64964c9c8e8f----2d-5e-",
  "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
}

Organization Core Banking Properties (v1.0.0)

Organization properties that are specific to the Finxact banking core system. (Note that the Finxact customerId property is the Apiture organization.customerId.)

This schema was resolved from organizations/organizationFinxactCoreBanking.

Properties

NameDescription
Organization Core Banking Properties (v1.0.0) object
Organization properties that are specific to the Finxact banking core system. (Note that the Finxact customerId property is the Apiture organization.customerId.)

This schema was resolved from organizations/organizationFinxactCoreBanking.

customerGroup string
Each organization in Finxact belongs to a organization group. This property is the Finxact identifier of the this organization's customer group.
read-only
partyOrgId string
The unique identifier for the organization in the Finxact system. (This is analogous to the organization's _id in Apiture.)
read-only

organizationIdentification

{
  "value": "string",
  "type": "taxId",
  "expiresOn": "2019-08-24",
  "expiration": "2019-08-24"
}

Organization Identification (v1.1.0)

The type and value of the organizations unique identification numbers.

This schema was resolved from organizations/organizationIdentification.

Properties

NameDescription
Organization Identification (v1.1.0) object
The type and value of the organizations unique identification numbers.

This schema was resolved from organizations/organizationIdentification.

value string (required)
The value of this form of identification (the tax ID as a string, for example)
type organizationIdentificationType (required)
The type of this form of identification. taxId is the only supported type at this time.
enum values: taxId, dunsNumber
expiresOn string(date)
The date when this form of identification expires.
format: date
expiration string(date)
The date when this form of identification expires.
Warning: The property expiration was deprecated on version v1.1.0 of the schema. Use expiresOn instead. expiration will be removed on version v2.0.0 of the schema.
format: date
deprecated: true

organizationIdentificationType

"taxId"

Organization Identification Type (v1.0.0)

The type of the form of an organization's identification. taxId is the only supported type at this time.

organizationIdentificationType strings may have one of the following enumerated values:

ValueDescription
taxIdTax Identification Number: The company's federal Tax Identification Number. This is also known as the Employer Identification Number or EIN in the US. It may be the owner's SSN for a sole proprietorship.
dunsNumberDun & Bradstreet D-U-N-S Number: Dun & Bradstreet D-U-N-S Number, a unique nine-digit identifier for businesses.

These enumeration values are further described by the label group named organizationIdentificationType in the response from the getLabels operation.

This schema was resolved from organizations/organizationIdentificationType.

type: string


enum values: taxId, dunsNumber

organizationPhoneNumber

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "state": "approved"
}

Phone Number (v1.2.1)

Representation of phone number resources.

Response and request bodies using this organizationPhoneNumber schema may contain the following links:

RelSummaryMethod
deleteDelete this phone number resourceDELETE
apiture:setAsPreferredSet Preferred Phone NumberPUT

This schema was resolved from organizations/organizationPhoneNumber.

Properties

NameDescription
Phone Number (v1.2.1) object
Representation of phone number resources.

Response and request bodies using this organizationPhoneNumber schema may contain the following links:

RelSummaryMethod
deleteDelete this phone number resourceDELETE
apiture:setAsPreferredSet Preferred Phone NumberPUT

This schema was resolved from organizations/organizationPhoneNumber.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
type phoneNumberType (required)
The type or role of this phone number.
enum values: unknown, home, work, mobile, fax, other
number string (required)
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information.
minLength: 8
maxLength: 20
extension string
The extension number for a phone number, as a string. An extension is a short internal number assigned to a particular employee, team, or department of the main business number. Extensions are typically only present when the phone type is work.
minLength: 1
maxLength: 10
pattern: "^[0-9]{1,10}$"
label string
A text label, suitable for presentation to the end user. This is also used if type is other.
maxLength: 32
_id string
An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
state profileItemState
The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.
enum values: pending, approved

organizationState

"pending"

Organization State (v1.0.0)

The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.

organizationState strings may have one of the following enumerated values:

ValueDescription
pendingPending: The organization resource has been created but is not yet active; it is a draft and may be deleted.
inactiveInactive: The organization resource is inactive and not available for use or assignment, such as associated to business account or payee.
activeActive: The organization resource is inactive and not available for use or assignment, such as associated to business account or payee.
mergedMerged: The organization resource is has been merged into another organization and is not available for use or for activating.
removedRemoved: The inactive organization resource is has been marked as removed.

These enumeration values are further described by the label group named organizationState in the response from the getLabels operation.

This schema was resolved from organizations/organizationState.

type: string


enum values: pending, inactive, active, merged, removed

organizationSubtype

"string"

Organization Subtype (v1.0.0)

A refinement of the organization type.

The allowed values for this property are defined at runtime in the label group named organizationSubtype in the response from the getLabels operation.

This schema was resolved from organizations/organizationSubtype.

type: string

organizationType

"string"

Organization Type (v1.0.0)

The primary organization type.

The allowed values for this property are defined at runtime in the label group named organizationType in the response from the getLabels operation.

This schema was resolved from organizations/organizationType.

type: string

outputs

{
  "token": "string"
}

Outputs (v1.0.0)

Base model schema for identity verification operations outputs.

This schema was resolved from identity/outputs.

Properties

NameDescription
Outputs (v1.0.0) object
Base model schema for identity verification operations outputs.

This schema was resolved from identity/outputs.

token string
An opaque string that conveys the state of the contact's identity verification.

phoneNumber

{
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155"
}

Phone Number (v1.1.0)

A phone number and its role.

This schema was resolved from contacts/phoneNumber.

Properties

NameDescription
Phone Number (v1.1.0) object
A phone number and its role.

This schema was resolved from contacts/phoneNumber.

type phoneNumberType (required)
The type or role of this phone number.
enum values: unknown, home, work, mobile, fax, other
number string (required)
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information.
minLength: 8
maxLength: 20
extension string
The extension number for a phone number, as a string. An extension is a short internal number assigned to a particular employee, team, or department of the main business number. Extensions are typically only present when the phone type is work.
minLength: 1
maxLength: 10
pattern: "^[0-9]{1,10}$"
label string
A text label, suitable for presentation to the end user. This is also used if type is other.
maxLength: 32
_id string
An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"

phoneNumberType

"unknown"

Phone Number Type (v1.0.0)

The type or role of this phone number.

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 phoneNumberType in the response from the getLabels operation.

This schema was resolved from contacts/phoneNumberType.

type: string


enum values: unknown, home, work, mobile, fax, other

physicalLocationsCount

"unknown"

Physical Locations (v1.0.0)

The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the enum list will be removed in a future release and the values defined at runtime via the physicalLocationsCount group in the response from the getLabels operation.

This schema was resolved from organizations/physicalLocationsCount.

type: string


enum values: unknown, under10, from10to50, from50to100, moreThan100, other, notApplicable

preferredContactMethod

"unknown"

Preferred Contact Method (v1.0.0)

The contact's preferred method of communication.

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 preferredContactMethod in the response from the getLabels operation.

This schema was resolved from contacts/preferredContactMethod.

type: string


enum values: unknown, sms, email, other, notApplicable

primaryIncomeSource

"string"

Primary Income Source (v1.0.0)

Possible sources of individual income.

The allowed values for this property are defined at runtime in the label group named primaryIncomeSource in the response from the getLabels operation.

This schema was resolved from users/primaryIncomeSource.

type: string

prodState

"pending"

Product or Product Type State (v1.0.0)

The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.

prodState strings may have one of the following enumerated values:

ValueDescription
pendingThis product has been created in draft form but is not yet available
activeThis product is active and available for use
inactiveThis product is temporarily not available for use
removedThis product has been removed and is permanently not available for use

These enumeration values are further described by the label group named prodState in the response from the getLabels operation.

This schema was resolved from products/prodState.

type: string


default: "pending"
enum values: pending, active, inactive, removed

productInterestRates

{
  "apy": "1.40",
  "nominal": "1.405",
  "apye": "1.40",
  "compoundPeriod": "P1D",
  "accrualType": "compounding"
}

Product Interest Rates (v1.2.0)

The interest rates for accounts based on this product. For deposit products, the rates describe the rate of return. For loan products, this includes the interest rate charged on balances. The apy, apye, nominal and apr values are a decimal percentage, coded as strings in order to represent the rate exactly. Rates are coded to two or three decimal places. Rates can be fixed, such { "apy" : "1.40" } for 1.4% APY. Rates (usually only on loan accounts) may relative to a benchmark, such as { "benchmark" : "primeUs", "apr" : "0.50" } to express U.S. Prime Rate + 0.5%.

This schema was resolved from products/productInterestRates.

Properties

NameDescription
Product Interest Rates (v1.2.0) object
The interest rates for accounts based on this product. For deposit products, the rates describe the rate of return. For loan products, this includes the interest rate charged on balances. The apy, apye, nominal and apr values are a decimal percentage, coded as strings in order to represent the rate exactly. Rates are coded to two or three decimal places. Rates can be fixed, such { "apy" : "1.40" } for 1.4% APY. Rates (usually only on loan accounts) may relative to a benchmark, such as { "benchmark" : "primeUs", "apr" : "0.50" } to express U.S. Prime Rate + 0.5%.

This schema was resolved from products/productInterestRates.

apy twoDecimalInterestRate(decimal)
The annual percentage yield (APY): the effective yield from interest, including compounding, as a percentage. Used on deposit account products. If the product has rate tiers, this is tiers[0].apy (the lowest tier).
read-only
format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\\d?)\\.\\d{2}$"
apye twoDecimalInterestRate(decimal)
The annualized rate based on the amount of interest actually earned, including compounding, as a percentage of the account's average daily balance. Used on deposit account products.
format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\\d?)\\.\\d{2}$"
nominal threeDecimalInterestRate(decimal)
The effective interest rate before accounting for inflation. Used on deposit and loan account products. If the product has rate tiers, this is tiers[0].nominal (the lowest tier).
read-only
format: decimal
minLength: 5
maxLength: 6
pattern: "^(0|[1-9]\\d?)\\.\\d{3}$"
apr twoDecimalInterestRate(decimal)
The base annual percentage rate (APR) charged on loan accounts. If benchmark is set, the current APR is relative to that benchmark: For example, a rate of { 'apr': '1.00', 'benchmark': 'primeUS' } means the APR is "Prime plus 1.00%": if the current Prime rate is 1.10%, the actual APR is 2.10%. A negative rate means a rate below the benchmark.
read-only
format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\\d?)\\.\\d{2}$"
purchaseApr twoDecimalInterestRate(decimal)
The annual percentage rate charged on purchases in a revolving loan account such as a credit card.
read-only
format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\\d?)\\.\\d{2}$"
withdrawalApr twoDecimalInterestRate(decimal)
The annual percentage rate charged on withdrawals (including cash advances) in a revolving loan account such as a credit card or line of credit.
read-only
format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\\d?)\\.\\d{2}$"
interestRate twoDecimalInterestRate(decimal)
The base annual interest rate for a loan product. This rate excludes fees and other charges which are deflected the APR rates.
read-only
format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\\d?)\\.\\d{2}$"
benchmark string

An optional base benchmark that the rate is relative to. This typically only applies to loan products. If omitted, the rate is fixed. Otherwise the rate is added to the benchmark rate. Values may be (but are not limited to):

compoundPeriod string
The period at which interest compounds. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the compounding in the number of years/months/days. P1D mean compounded daily and P1M mean compounded monthly. The default is "P0D" (continuous).
accrualType accrualType
Indicates how interest is accrued according to the compoundPeriod.
enum values: compounding, simple
adjustmentPeriod string(period)
The period at which the rate is adjusted or recomputed to account for changes in the benchmark rate. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the integral number of years or months or days. The default is "P1D" (daily).
format: period
tiers array: [interestRateTier]
If present, the earned apy and nominal rate for the account statement period is based on looking up the account's minimum balance in this array. The items are sorted from lowest minimumBalance to highest. This array is not present if the rates are fixed (not based on the account's minimum balance): use just the apy and nominal rates.
minItems: 1
items: object

productTarget

"personal"

Product Target (v1.0.0)

The target audience for this product.

productTarget strings may have one of the following enumerated values:

ValueDescription
personalBanking products for personal use
businessBanking products for business use

These enumeration values are further described by the label group named productTarget in the response from the getLabels operation.

This schema was resolved from products/productTarget.

type: string


enum values: personal, business

profileItemState

"approved"

Organization Profile Item State (v1.0.0)

The state of an item (address, email address, or phone number) within the organization's profile. New addresses, email addresses, or phone numbers start with the state pending, which means approval by the financial institution is pending. After they have been verified, the state becomes approved. Some normalizing or sanitizing of the value may occur when this happens (for example, a ZIP code may change to ZIP+4 format). pending items may not be assigned as the preferred item.

profileItemState strings may have one of the following enumerated values:

ValueDescription
pendingPending: A profile item that the financial institution has not yet approved.
approvedApproved: A profile item that the financial institution has approved.

These enumeration values are further described by the label group named profileItemState in the response from the getLabels operation.

This schema was resolved from organizations/profileItemState.

type: string


enum values: pending, approved

promotionCode

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

Promotion Code (v1.0.1)

Contains a promotion code to validate within the context of an account application.

Properties

NameDescription
Promotion Code (v1.0.1) object
Contains a promotion code to validate within the context of an account application.
_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
format: uri
code string (required)
The promotion code to validate.
minLength: 1

regulatory

{
  "estimatedAnnualRevenue": "unknown",
  "atmOperator": true,
  "charity": true,
  "cashesChecksMoreThan1000Usd": true,
  "internetGamblingIncorporated": true,
  "marijuanaBusiness": true,
  "moneyOrderMoreThan1000Usd": true,
  "thirdPartyBenefit": true,
  "transmitBehalfOfCustomer": true,
  "virtualCurrency": true,
  "acceptsRcc": true,
  "intermediaryServices": [
    "unknown"
  ],
  "subjectToWithholdings": false,
  "property1": {},
  "property2": {}
}

Regulatory (v1.1.0)

Responses to regulatory-related questions.

This schema was resolved from organizations/regulatory.

Properties

NameDescription
Regulatory (v1.1.0) object
Responses to regulatory-related questions.

This schema was resolved from organizations/regulatory.

Regulatory Value (v1.0.0) regulatoryValue
The value associated with this regulatory property.

This schema was resolved from organizations/regulatoryValue.

estimatedAnnualRevenue estimatedAnnualRevenue
The range of estimated revenue in US dollars.
enum values: unknown, under1Million, from1to10Million, from10to100Million, over100Million, other, notApplicable
atmOperator boolean
The organization operates automated teller machines (ATMs).
charity boolean
Some of the organization's income depends on a charity.
cashesChecksMoreThan1000Usd boolean
The organization cashes checks for customers in amounts greater than $1,000.
internetGamblingIncorporated boolean
The organization derives income from internet gambling.
marijuanaBusiness boolean
The organization derives income from marijuana or other drugs/controlled substances.
moneyOrderMoreThan1000Usd boolean
Individuals at the organization may request money orders of more than $1,000.
thirdPartyBenefit boolean
The organization processes transactions on behalf of third parties.
transmitBehalfOfCustomer boolean
The organization transmits funds on behalf of third parties.
virtualCurrency boolean
The organization administers or exchanges virtual currency.
acceptsRcc boolean
The organization accepts Remotely Created Checks (RCCs) for goods or services.
intermediaryServices array: [intermediaryServices]
A list of intermediary/non-bank financial institution services provided the organization performs on behalf of others.
unique items
items: string
» enum values: unknown, accounting, fundsManagement, insurance, investment, legal, medical, notary, realEstate, taxPreparation, trustManagement, gambling, securities, loanFinance, pawnBrokerage, travelAgency, vehicleSales, foreignCurrency, preciousMetals, other, notApplicable
subjectToWithholdings boolean
If true, the organization is subject to tax withholdings.
default: false

regulatoryValue

{}

Regulatory Value (v1.0.0)

The value associated with this regulatory property.

This schema was resolved from organizations/regulatoryValue.

Properties

NameDescription
Regulatory Value (v1.0.0) object
The value associated with this regulatory property.

This schema was resolved from organizations/regulatoryValue.

requiredDocument

{
  "label": "Driver's License",
  "type": "governmentId",
  "productTarget": "personal",
  "documentUri": "https://api.devbank.apiture.com/vault/files/7d0e5c70-6efd-4d7e-84c8-d62335227080",
  "category": "driversLicense",
  "requireIfVerified": false
}

Required Document (v1.0.1)

An document which is required from the applicant. If a templateUri is provided, the applicant must download the document from the templateUri and return it completed.

Properties

NameDescription
Required Document (v1.0.1) object
An document which is required from the applicant. If a templateUri is provided, the applicant must download the document from the templateUri and return it completed.
label string (required)
User friendly label of the document.
type string (required)
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a governmentId etc.). This type corresponds to the document type type in the Vault API.
productTarget string (required)
The target of the relevant product, either business or personal. Note that business is synonymous with organizations in Apiture APIs.
enum values: business, personal
documentUri string
A URI pointing to a form document that the applicant is required to download, fill out, optionally scan, then upload (as a new document) to satisfy this document requirement. The form document must reside in the document storage system. This is the URI of a shared document in the Vault API.
category requiredDocumentCategory (required)
Document categories for documents uploaded as part of an account application or enrollment.

requiredDocumentCategory strings may have one of the following enumerated values:

ValueDescription
driversLicenseDrivers License
militaryIdentificationMilitary Identification
passportPassport
socialSecurityCardSocial Security Card
stateIdentificationState Identification
taxFormTax Form
utilityBillUtility Bill
articlesOfOrganizationArticles Of Organization

These enumeration values are further described by the label group named requiredDocumentCategory in the response from the getLabels operation.
enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, articlesOfOrganization

requireIfVerified boolean (required)
Whether to require this document even if the associated applicant or business has passed verification. If true, this document will always be required.

requiredDocumentCategory

"driversLicense"

Required Document Category (v1.0.0)

Document categories for documents uploaded as part of an account application or enrollment.

requiredDocumentCategory strings may have one of the following enumerated values:

ValueDescription
driversLicenseDrivers License
militaryIdentificationMilitary Identification
passportPassport
socialSecurityCardSocial Security Card
stateIdentificationState Identification
taxFormTax Form
utilityBillUtility Bill
articlesOfOrganizationArticles Of Organization

These enumeration values are further described by the label group named requiredDocumentCategory in the response from the getLabels operation.

type: string


enum values: driversLicense, militaryIdentification, passport, socialSecurityCard, stateIdentification, taxForm, utilityBill, articlesOfOrganization

residencyStatus

"unknown"

Residency (v1.0.0)

Residency status.

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 residencyStatus in the response from the getLabels operation.

This schema was resolved from contacts/residencyStatus.

type: string


enum values: unknown, resident, nonresident, residentAlien, nonresidentAlien, other, notApplicable

resourceTrackingId

{
  "id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
  "createdAt": "2021-06-07T09:11:02.375Z"
}

Resource Tracking Id (v1.0.0)

A tracking ID for a resource. The ID is an opaque string which client applications associate with some other process or resource, such as a promotional campaign.

This schema was resolved from common/resourceTrackingId.

Properties

NameDescription
Resource Tracking Id (v1.0.0) object
A tracking ID for a resource. The ID is an opaque string which client applications associate with some other process or resource, such as a promotional campaign.

This schema was resolved from common/resourceTrackingId.

id string
The unique tracking ID string.
minLength: 4
maxLength: 80
pattern: "^[-_a-zA-Z0-9$]{4,80}$"
createdAt string(date-time)
The date-time the tracking ID was added (if known) in RFC 3338 date-time format, in UTC timezone.
format: date-time

resourceTrackingIds

{
  "_profile": "https://production.api.apiture.com/schemas/common/resourceTrackingIds/v1.1.3/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": [
    {
      "id": "476824ec-7f8a-4909-bad7-b05ee26aba0f",
      "createdAt": "2021-06-07T09:11:02.375Z"
    },
    {
      "id": "55c9141a-94d5-4ae8-b664-9ac4c9eaea2d",
      "createdAt": "2021-07-011T15:33:00.375Z"
    }
  ]
}

Resource Tracking IDs (v1.1.3)

Tracking IDs associated with a resource.

Response and request bodies using this resourceTrackingIds schema may contain the following links:

RelSummaryMethod
self This set of resource tracking IDsGET
apiture:resource A Tracked ResourceGET

This schema was resolved from common/resourceTrackingIds.

Properties

NameDescription
Resource Tracking IDs (v1.1.3) object
Tracking IDs associated with a resource.

Response and request bodies using this resourceTrackingIds schema may contain the following links:

RelSummaryMethod
self This set of resource tracking IDsGET
apiture:resource A Tracked ResourceGET

This schema was resolved from common/resourceTrackingIds.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
trackingIds array: [resourceTrackingId]
An array of tracking IDs associated with the resource.
maxItems: 150
items: object

riskFactor

{
  "riskCode": "string",
  "description": "string"
}

Risk Factor (v1.0.0)

Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.

This schema was resolved from businessVerifications/riskFactor.

Properties

NameDescription
Risk Factor (v1.0.0) object
Risk factors, warning codes, or risk codes are not necessarily indicators of fraud or of any fraudulent intent. They are value added attributes that indicate information that may have contributed to a lower score.

This schema was resolved from businessVerifications/riskFactor.

riskCode string
The risk factor risk code
description string
The risk code description

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"
}

Role (v1.0.0)

Representation of a role resource. Roles are used to associate resources. The most common roles may be related to entitlements(users) but can also be applied to organizations or non-users (such as beneficiaries, payees, etc.).

This schema was resolved from associations/role.

Properties

NameDescription
Role (v1.0.0) object
Representation of a role resource. Roles are used to associate resources. The most common roles may be related to entitlements(users) but can also be applied to organizations or non-users (such as beneficiaries, payees, etc.).

This schema was resolved from associations/role.

name string
The name of this role, for identification purposes, such as primaryOwner, beneficiary, authorizedSigner. Some roles have well-known uses in the platform.
minLength: 1
maxLength: 128
label string
The text label for this role, for use in human presentation. This field may be localized.
minLength: 1
maxLength: 128
description string
A fuller description of this role. This field may be localized.
minLength: 1
maxLength: 4096
_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
The unique identifier for this role resource. This is an immutable opaque string.
read-only
createdAt string(date-time)
The date-time when the role was created. This is in ISO 8601 format, UTC. This is derived and immutable.
read-only
format: date-time

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/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"
}

API Root (v2.1.1)

A HAL response, with hypermedia _links for the top-level resources and operations in API.

This schema was resolved from common/root.

Properties

NameDescription
API Root (v2.1.1) object
A HAL response, with hypermedia _links for the top-level resources and operations in API.

This schema was resolved from common/root.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
This API's unique ID.
read-only
name string
This API's name.
apiVersion string
This API's version.

simpleAddress

{
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US"
}

Simple Address (v1.0.0)

A postal address.

This schema was resolved from contacts/simpleAddress.

Properties

NameDescription
Simple Address (v1.0.0) object
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1 string
The first street address line of the address, normally a house number and street name.
minLength: 4
maxLength: 128
addressLine2 string
The optional second street address line of the address.
maxLength: 128
city string
The name of the city or municipality.
minLength: 2
maxLength: 128
regionCode string
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
minLength: 2
maxLength: 2
pattern: "^[a-zA-Z]{2}$"
postalCode string
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
minLength: 5
maxLength: 10
pattern: "^[0-9]{5}(?:-[0-9]{4})?$"
countryCode string
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
minLength: 2
maxLength: 2
pattern: "^[a-zA-Z]{2}$"

simpleContact

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "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",
  "emailAddresses": [
    {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "pe0",
  "phones": [
    {
      "_id": "hp1",
      "type": "home",
      "number": "+19105550155"
    },
    {
      "_id": "mp1",
      "type": "mobile",
      "number": "+19105550159"
    },
    {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  ],
  "preferredPhoneId": "hp1",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "*****3333"
    }
  ],
  "preferredContactMethod": "email"
}

Simple Contact (v1.2.0)

Basic contact and identification information for a person, consisting of the name, mailing address, phone numbers, email addresses, and government identification.

This schema was resolved from contacts/simpleContact.

Properties

NameDescription
Simple Contact (v1.2.0) object
Basic contact and identification information for a person, consisting of the name, mailing address, phone numbers, email addresses, and government identification.

This schema was resolved from contacts/simpleContact.

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 array: [address]
An array of postal/mailing addresses.
items: object
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
emailAddresses array: [typedEmailAddress]
An array of email addresses.
items: object
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
phones array: [phoneNumber]
An array of phone numbers.
items: object
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 array: [identification]
A collection of official identifying information associated with the contact.
items: object
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
enum values: unknown, sms, email, other, notApplicable

simpleLabel

{
  "label": "Board of Directors",
  "description": "string"
}

Simple Label (v1.0.0)

A text label and optional description.

This schema was resolved from common/simpleLabel.

Properties

NameDescription
Simple Label (v1.0.0) object
A text label and optional description.

This schema was resolved from common/simpleLabel.

label string (required)
A label or title which may be used as labels or other UI controls which present a value.
description string
A more detailed localized description of a localizable label.

simpleOrganization

{
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "phones": [
    {
      "type": "work",
      "number": "+19105550155"
    },
    {
      "type": "mobile",
      "number": "+19105550154"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "establishedOn": "2009-07-09",
  "_profile": "https://production.api.apiture.com/schemas/organizations/simpleOrganization/v1.4.1/profile.json"
}

Simple Organization (v1.4.1)

The simplest form of an organization.

This schema was resolved from organizations/simpleOrganization.

Properties

NameDescription
Simple Organization (v1.4.1) object
The simplest form of an organization.

This schema was resolved from organizations/simpleOrganization.

name string
The organization's official full name
label string
The organization's common name.
type organizationType
Indicates what type of organization this resource represents.

The enumeration values are described by the organizationType value in the response of the getLabels operation.

subtype organizationSubtype
A refinement of the type.

The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.

identification array: [organizationIdentification]
A collection of official identifying information associated with the organization. This currently only supports government tax ID.
items: object
addresses array: [organizationAddress]
An array containing address items.
items: object
phones array: [organizationPhoneNumber]
An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
items: object
emailAddresses array: [organizationEmailAddress]
An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
items: object
preferredEmailAddressId string
The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
preferredPhoneId string
The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
taxAddressId string
The _id of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an approved physical address, and it may not be a P.O. Box. This value is set with the setTaxAddress operation.
minLength: 1
maxLength: 4
establishedOn string(date)
The date the organization was established.
format: date
establishedDate string(date)
The date the organization was established.
Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.
format: date
deprecated: true

summaryApplication

{
  "_profile": "https://production.api.apiture.com/schemas/accountApplications/summaryApplication/v1.5.1/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"
    }
  },
  "_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"
}

Account Application Summary (v1.5.1)

Summary representation of an account application resource in account applications collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

Properties

NameDescription
Account Application Summary (v1.5.1) object
Summary representation of an account application resource in account applications collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.
_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
format: uri
_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
enum values: pending, running, blocked, canceled, expired, rejected, approved
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
format: date-time
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
format: date-time
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
format: date-time
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.
enum values: personal, business
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

summaryApprovalType

{
  "_profile": "https://production.api.apiture.com/schemas/approvals/summaryApprovalType/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. `governmentId` approvals may not be waived or canceled.",
  "disallowedStates": [
    "waived",
    "canceled"
  ],
  "domain": "https://production.api.apiture.com/domains/approvals/documentRequirement",
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
}

Approval Type Summary (v1.1.0)

Summary representation of an approval type resource in approvals collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from approvals/summaryApprovalType.

Properties

NameDescription
Approval Type Summary (v1.1.0) object
Summary representation of an approval type resource in approvals collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from approvals/summaryApprovalType.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
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 array: [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.
items: string
» enum values: rejected, waived, returned, canceled
_id string
The unique identifier for this approval resource. This is an immutable opaque string.
read-only

summaryConsent

{
  "_profile": "https://production.api.apiture.com/schemas/consents/summaryConsent/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/consents/consents/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"
  },
  "type": "productTermsAndConditions",
  "userId": "5a5e834c-a7bd-401c",
  "state": "pending",
  "contextUri": "/products/products/34011fe5-192d-4ffb-be32-e7215e56028a"
}

Consent Summary (v1.1.1)

Summary representation of a consent resource in consents collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from consents/summaryConsent.

Properties

NameDescription
Consent Summary (v1.1.1) object
Summary representation of a consent resource in consents collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from consents/summaryConsent.

_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
format: uri
_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.
format: uri
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.
format: uri
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
enum values: pending, given, stale, rescinded, revoked
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
format: date-time
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
format: date-time
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
format: date-time

summaryContact

{
  "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": "pe0"
    },
    {
      "_id": "ek3",
      "value": "support@apiture.com",
      "type": "work",
      "id": "wp1"
    }
  ],
  "preferredEmailAddressId": "ea1",
  "phones": [
    {
      "_id": "pa1",
      "type": "home",
      "number": "+19105550155"
    },
    {
      "_id": "da6",
      "type": "mobile",
      "number": "+19105550155"
    },
    {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  ],
  "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",
  "preferredContactMethod": "email",
  "_profile": "https://production.api.apiture.com/schemas/contacts/summaryContact/v2.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/contacts/contacts/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
}

Contact Summary (v2.1.3)

Summary representation of a contact resource in contacts collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from contacts/summaryContact.
deprecated

Properties

NameDescription
Contact Summary (v2.1.3) object
Summary representation of a contact resource in contacts collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from contacts/summaryContact.
deprecated: true

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: true
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: true
enum 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: true
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 array: [address]
An array of postal/mailing addresses.
items: object
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array.
minLength: 1
maxLength: 4
emailAddresses array: [typedEmailAddress]
An array of email addresses.
items: object
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array.
minLength: 1
maxLength: 4
phones array: [phoneNumber]
An array of phone numbers.
items: object
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 array: [identification]
A collection of official identifying information associated with the contact.
items: object
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
enum values: unknown, sms, email, other, notApplicable
birthdate string(date)
The contact's birth date in YYYY-MM-DD format.
format: date
citizenship array: [citizenship]
This individual's citizenship or nationality status.
items: object
residencyStatus residencyStatus
This individual's residency status.
enum values: unknown, resident, nonresident, residentAlien, nonresidentAlien, other, notApplicable
occupation occupation
The occupation of this individual.
enum values: unknown, architectureAndEngineering, artsDesignEntertainmentSportsAndMedia, buildingAndGroundsCleaningAndMaintenance, businessAndFinancialOperations, communityAndSocialService, computerAndMathematical, constructionAndExtraction, educationTrainingAndLibrary, farmingFishingAndForestry, foodPreparationAndServingRelated, healthcarePractitionersAndTechnical, healthcareSupport, installationMaintenanceAndRepair, legal, lifePhysicalAndSciences, management, militarySpecific, officeAndAdministrativeSupport, personalCareAndService, production, protectiveServices, salesAndRelated, transportationAndMaterialMoving, other, notApplicable
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: true
enum values: unknown, oneOrFewer, two, three, fourOrMore
_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
format: uri
_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
enum values: inactive, active, merged, removed
_id string
The unique identifier for this contact resource. This is an immutable opaque string.
read-only

summaryEnrollment

{
  "_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 Summary (v1.9.1)

Representation of enrollments in the collection.

Properties

NameDescription
Digital Banking User Enrollment Summary (v1.9.1) object
Representation of enrollments in the collection.
_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
format: uri
_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
enum values: pending, running, blocked, canceled, expired, rejected, approved
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
format: date-time
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
format: date-time
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
format: date-time
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: true
_id string
The unique identifier for this application. This is an immutable opaque string.
read-only

summaryOrganization

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "phones": [
    {
      "type": "work",
      "number": "+19105550155"
    },
    {
      "type": "mobile",
      "number": "+19105550154"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 101,
  "employeeCountUpperBound": 250,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": "trustManagement",
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d"
}

Organization Summary (v1.6.1)

Summary representation of an organization resource in organizations collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from organizations/summaryOrganization.

Properties

NameDescription
Organization Summary (v1.6.1) object
Summary representation of an organization resource in organizations collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from organizations/summaryOrganization.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
name string
The organization's official full name
label string
The organization's common name.
type organizationType
Indicates what type of organization this resource represents.

The enumeration values are described by the organizationType value in the response of the getLabels operation.

subtype organizationSubtype
A refinement of the type.

The enumeration values are described by the organizationSubtype value in the response of the getLabels operation.

identification array: [organizationIdentification]
A collection of official identifying information associated with the organization. This currently only supports government tax ID.
items: object
addresses array: [organizationAddress]
An array containing address items.
items: object
phones array: [organizationPhoneNumber]
An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number.
items: object
emailAddresses array: [organizationEmailAddress]
An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email.
items: object
preferredEmailAddressId string
The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
preferredPhoneId string
The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
preferredMailingAddressId string
The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
taxAddressId string
The _id of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an approved physical address, and it may not be a P.O. Box. This value is set with the setTaxAddress operation.
minLength: 1
maxLength: 4
establishedOn string(date)
The date the organization was established.
format: date
establishedDate string(date)
The date the organization was established.
Warning: The property establishedDate was deprecated on version v1.1.0 of the schema. Use establishedOn instead. establishedDate will be removed on version v2.0.0 of the schema.
format: date
deprecated: true
state organizationState
The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
enum values: pending, inactive, active, merged, removed
tradeName string
The trade name of the organization.
governmentOwned boolean
Indicates whether the organization is a government-owned entity.
publiclyHeld boolean
Indicates whether the organization is publicly held.
smallBusiness boolean
Indicates whether the organization is classified as a small business
taxExempt boolean
Indicates whether the organization is the tax-exempt.
employeeCountRange string
Indicates the approximate number of employees, as a range.

The allowed values for this property are defined at runtime in the label group named employeeCountRange in the response from the getLabels operation.

employeeCountLowerBound integer
The lower bound of persons employed, derived from the range selected in employeeCountRange.
read-only
minimum: 1
employeeCountUpperBound number
The lower bound of persons employed, derived from the range selected in employeeCountRange.
read-only
maximum: 20000000
yearsOwned yearsOwned
The number of years the owners/operators have owned the business. Warning: the enum list will be removed in a future release and the values defined at runtime via the yearsOwned group in the response from the getLabels operation.

This schema was resolved from organizations/yearsOwned.
enum values: unknown, one, two, three, fourOrMoreYears, other, notApplicable

physicalLocationsCount physicalLocationsCount
The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the enum list will be removed in a future release and the values defined at runtime via the physicalLocationsCount group in the response from the getLabels operation.

This schema was resolved from organizations/physicalLocationsCount.
enum values: unknown, under10, from10to50, from50to100, moreThan100, other, notApplicable

homeUrl string
The organization's home page.
industry string
Indicates what industry does this organization work within.

The allowed values for this property are defined at runtime in the label group named industrySectors in the response from the getLabels operation.

countryOfOperations string
The ISO 3166-1 country code for the organization's operation.
minLength: 2
maxLength: 2
regulatory regulatory
Answers to organization-specific regulatory questions.
currency string
The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters.
minLength: 3
maxLength: 3
mobileCheckDepositEnabled boolean
true if mobile check deposits are enabled for the organization.
achEnabled boolean
true if ACH transfers are enabled the organization.
wireEnabled boolean
true if wire transfers are enabled for the organization .
estimatedMonthlyAmounts estimatedMonthlyAmounts
Estimated monthly amounts for banking services.
estimatedMonthlyCounts estimatedMonthlyCounts
Estimated banking activity per month.
accountPurpose accountPurpose
The purpose of the account.
enum values: unknown, creditCardProcessing, generalOperatingFunds, lottery, payroll, savings, other, notApplicable
registeredIn string
The US state or other region in which the organization is registered.

The allowed values for this property are defined at runtime in the label group named regionCodes in the response from the getLabels operation.
minLength: 2
maxLength: 2
pattern: "^[a-zA-Z]{2}$"

_id string
The unique identifier for this organization resource. This is an immutable opaque string.
read-only
customerId string
The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the organization in the banking core. The customerId differs from the _id (which is the ID of the resource in the Organizations API).
read-only
minLength: 1
maxLength: 100

summaryProduct

{
  "_profile": "https://production.api.apiture.com/schemas/products/summaryProduct/v3.3.1/profile.json",
  "_links": {
    "self": {
      "href": "/products/products/a6459cdf-543e-46df-887b-ac5378ee9acd"
    },
    "apiture:productType": {
      "href": "/products/productTypes/4d4242ed-eb8d-46ca-bc3c-13e1f82337c8"
    },
    "apiture:productSubtype": {
      "href": "/products/productTypes/fa4f2335-3306-4721-b74c-8ec0c77823e9"
    }
  },
  "_id": "a6459cdf-543e-46df-887b-ac5378ee9acd",
  "name": "Premiere Checking",
  "label": "Premiere Checking",
  "description": "A premiere demand deposit checking account for business use.",
  "state": "active",
  "type": "Demand Deposit",
  "subtype": "Demand Deposit with Interest",
  "newAccountAvailability": "available",
  "availability": "general",
  "target": "business",
  "_embedded": {},
  "ifxType": "DDA",
  "rates": {
    "apy": "1.45",
    "nominal": "1.455",
    "apye": "1.45",
    "compoundPeriod": "P1D",
    "accrualType": "compounding"
  },
  "currency": "USD",
  "paymentsEnabled": true,
  "checkOrderingEnabled": true,
  "regDEnabled": true,
  "promotionalCodesEnabled": true,
  "constraints": {
    "transactionTypes": [
      "debit",
      "credit"
    ],
    "minimumBalance": "500.00",
    "minimumFundingAmount": "500.00",
    "maximumFundingAmount": "25000.00",
    "maximumTransferAmount": "25000.00",
    "fundingTerm": "P7D"
  }
}

Product Summary (v3.3.1)

Summary representation of a product resource in products collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. This representation omits the attributes of the full representation.

Response and request bodies using this summaryProduct schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this productGET
apiture:productTypeFetch a representation of this product type.GET
apiture:productSubtypeFetch a representation of this product type.GET

This schema was resolved from products/summaryProduct.

Properties

NameDescription
Product Summary (v3.3.1) object
Summary representation of a product resource in products collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects. This representation omits the attributes of the full representation.

Response and request bodies using this summaryProduct schema may contain the following links:

RelSummaryMethod
selfFetch a representation of this productGET
apiture:productTypeFetch a representation of this product type.GET
apiture:productSubtypeFetch a representation of this product type.GET

This schema was resolved from products/summaryProduct.

_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
format: uri
_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 product.
minLength: 1
maxLength: 128
label string
The text label for this product. This field may be localized.
minLength: 1
maxLength: 128
description string(markdown)
A fuller description of this product. This field may be localized. The content is processed as Github Flavored Markdown and thus supports rich text.
format: markdown
minLength: 1
maxLength: 4096
code string
The unique product code for this product, normally defined by the underlying banking core. The code cannot be changed once the state is beyond pending.
maxLength: 64
category string
The product category name. This is a more readable form of the product's type.
ifxType ifxType
The product IFX Account Type.
enum values: CCA, CDA, CLA, CMA, DDA, EQU, GLA, ILA, INV, IRA, IRL, LOC, MLA, MMA, PBA, PPA, RWD, SDA
target productTarget
Describes the target audience or consumer of the accounts, personal or business. Labels and descriptions for the enumeration values are in the productTarget key in the response of the getLabels operation.
enum values: personal, business
rates productInterestRates
The interest rates for this product.
currency string
The ISO 4217 currency code for this product.
minLength: 3
maxLength: 3
state prodState
The state of this product or product type. New resources are pending by default and must be activated before they may be used.

The state property is immutable and derived and may not be changed via the PUT or PATCH operations. To change the state of a product or product type, use the POST operation using the apiture:activate, apiture:deactivate or apiture:remove links on the resource.
default: "pending"
enum values: pending, active, inactive, removed

_id string
The unique identifier for this product resource. This is an immutable opaque string.
read-only
type string
The product type name, which is derived from the linked product type.
read-only
subtype string
The product subtype name, which is derived from the linked product subtype. This is a derived, immutable property.
read-only
constraints constraints
Product constraints, such as minimum and maximum balances.

This schema was resolved from products/constraints.

paymentsEnabled boolean
If true, active accounts of this banking product may be eligible for payment features such as bill pay. This is merely the default; clients should check the paymentsEnabled property on the account service to ensure payment services are available for the authenticated account user.
The property paymentsEnabled was added on version 2.3.0 of the schema.
The property paymentsEnabled was added on version 2.3.0 of the schema.
read-only
checkOrderingEnabled boolean
If true, active accounts derived from this banking product may allow ordering checks through the Check Orders API. Accounts inherit this value from their product. The financial institution may disable check ordering on individual accounts, so clients should reference the checkOrderingEnabled property on the account.
The property checkOrderingEnabled was added on version 2.3.0 of the schema.
The property checkOrderingEnabled was added on version 2.3.0 of the schema.
read-only
default: false
regDEnabled boolean
If true, active accounts derived from this banking product will potentially incur a fee on a transaction that exceeds the configured transaction limit. Accounts inherit this value from their product. This configuration is product specific so clients will reference the regDEnabled property on the product associated to that account.
The property regDEnabled was added on version 2.8.0 of the schema.
The property regDEnabled was added on version 2.8.0 of the schema.
read-only
default: false
promotionalCodesEnabled boolean
If true, new accounts derived from this banking product may be eligible for promotional rates, activated with a promotion code entered during account opening.
default: false

summaryRole

{
  "name": "primaryUser",
  "label": "Primary User",
  "description": "The primary user on the account.\nThere may be only one primary user on an account.",
  "_profile": "https://production.api.apiture.com/schemas/associations/summaryRole/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/associations/roles/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
}

Role Summary (v1.0.0)

Summary representation of a role resource in roles collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from associations/summaryRole.

Properties

NameDescription
Role Summary (v1.0.0) object
Summary representation of a role resource in roles collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from associations/summaryRole.

name string
The name of this role, for identification purposes, such as primaryOwner, beneficiary, authorizedSigner. Some roles have well-known uses in the platform.
minLength: 1
maxLength: 128
label string
The text label for this role, for use in human presentation. This field may be localized.
minLength: 1
maxLength: 128
description string
A fuller description of this role. This field may be localized.
minLength: 1
maxLength: 4096
_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
The unique identifier for this role resource. This is an immutable opaque string.
read-only

summaryUser

{
  "_profile": "https://production.api.apiture.com/schemas/users/summaryUser/v1.8.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    }
  },
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": [
    {
      "_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"
        }
      }
    },
    {
      "_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": [
    {
      "id": "pe0",
      "value": "johnny1733@example.com",
      "type": "personal",
      "_id": "pe0"
    },
    {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work",
      "_id": "we0"
    }
  ],
  "preferredEmailAddressId": "pe0",
  "phones": [
    {
      "_id": "hp0",
      "type": "home",
      "number": "+19105550155"
    },
    {
      "_id": "mp0",
      "type": "mobile",
      "number": "+19105550159"
    },
    {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  ],
  "preferredPhoneId": "hp0",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "********3333"
    }
  ],
  "preferredContactMethod": "email",
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "username": "Johnny1733",
  "residencyStatus": "resident",
  "customerId": 47294723672,
  "birthdate": "1974-10-27",
  "citizenship": [
    {
      "countryCode": "US",
      "state": "citizen"
    }
  ],
  "occupation": "officeAndAdministrativeSupport",
  "taxAddressId": "ha1",
  "yearsAtAddress": "fourOrMore",
  "state": "active",
  "attributes": {}
}

Summary User (v1.8.2)

Summary representation of a user resource in user collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from users/summaryUser.

Properties

NameDescription
Summary User (v1.8.2) object
Summary representation of a user resource in user collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from users/summaryUser.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
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 array: [userAddress]
An array of postal/mailing addresses. Add or delete addresses with the createAddress and deleteAddress operations.
read-only
items: object
preferredMailingAddressId string
The _id of a user addresswhere the financial institution mails documents to a user, such as statements and 1099-INT forms. The preferred mailing address may differ from the user's tax address or it may be the same. This value is set with the setPreferredAddress operation.
read-only
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
emailAddresses array: [userEmailAddress]
An array of email addresses. Add or delete email addresses with the createEmailAddress and deleteEmailAddress operations.
read-only
items: object
preferredEmailAddressId string
The preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
phones array: [phoneNumber]
An array of phone numbers.
items: object
preferredPhoneId string
The ID of preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
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 array: [identification]
A collection of official identifying information associated with the contact.
items: object
preferredContactMethod preferredContactMethod
The contact's preferred method of communication.
enum values: unknown, sms, email, other, notApplicable
birthdate string(date)
The contact's birth date in YYYY-MM-DD format.
format: date
citizenship array: [citizenship]
This individual's citizenship or nationality status.
items: object
residencyStatus residencyStatus
This individual's residency status.
enum values: unknown, resident, nonresident, residentAlien, nonresidentAlien, other, notApplicable
occupation occupation
The occupation of this individual.
enum values: unknown, architectureAndEngineering, artsDesignEntertainmentSportsAndMedia, buildingAndGroundsCleaningAndMaintenance, businessAndFinancialOperations, communityAndSocialService, computerAndMathematical, constructionAndExtraction, educationTrainingAndLibrary, farmingFishingAndForestry, foodPreparationAndServingRelated, healthcarePractitionersAndTechnical, healthcareSupport, installationMaintenanceAndRepair, legal, lifePhysicalAndSciences, management, militarySpecific, officeAndAdministrativeSupport, personalCareAndService, production, protectiveServices, salesAndRelated, transportationAndMaterialMoving, other, notApplicable
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, as of the date the user registered. This value may become stale over time.
enum values: unknown, oneOrFewer, two, three, fourOrMore
kycAnswers kycAnswers
This user's answers to the financial institutions Know Your Customer (KYC) questions.
read-only
deprecated: true
identityVerificationStatus userIdentityVerificationState
The identity verification status for this person. This field is read-only and is derived from the results of any Identity API verification applied to this user's personally identifiable information (PII).
read-only
enum values: unknown, verified, unverified
identityVerification identityVerification
The identity verification data for this person. These fields are derived from the results from the results of any Identity API verification applied to this user's personally identifiable information (PII).
Warning: The property identityVerification was deprecated on version v1.1.0 of the schema. Use identity information in Identity service instead. identityVerification will be removed on version v2.0.0 of the schema.
read-only
deprecated: true
username string
The unique username for the user.
state userState
The state of this user record. The default is active.
enum values: active, inactive, locked, frozen, removed
taxAddressId string
The _id of a user address that the financial institution and the customer use for tax purposes. The tax address may differ from the user's preferred mailing address, but it must be an approved physical address, and it may not be a P.O. Box. This value is set with the setTaxAddress operation.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
phoneNumbers array: [userPhoneNumber]
An array of phone numbers. Add or delete phoneNumbers with the createPhoneNumber and deletePhoneNumber operations.
read-only
items: object
_id string
The unique identifier for this user resource. This is an opaque string.
read-only
customerId string
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

summaryVerificationReport

{
  "_profile": "https://production.api.apiture.com/schemas/businessVerifications/summaryVerificationReport/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.example.com//businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c"
}

Verification Report Summary (v2.0.0)

Summary representation of a verification report resource in verification report collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from businessVerifications/summaryVerificationReport.

Properties

NameDescription
Verification Report Summary (v2.0.0) object
Summary representation of a verification report resource in verification report collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

This schema was resolved from businessVerifications/summaryVerificationReport.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
The unique identifier for this verification report resource. This is an immutable opaque string.
read-only
reportScoringSummary verificationReportScoringSummary
Model schema for business verification report summary.

This schema was resolved from businessVerifications/verificationReportScoringSummary.

threeDecimalInterestRate

"1.405"

Three Decimal Interest Rate (v1.0.0)

An interest rate, expressed as a percentage value with three decimal places of accuracy.
The schema threeDecimalInterestRate was added on version 1.18.0 of the API.
The schema threeDecimalInterestRate was added on version 1.18.0 of the API.

This schema was resolved from common/threeDecimalInterestRate.

type: string(decimal)


format: decimal
minLength: 5
maxLength: 6
pattern: "^(0|[1-9]\d?)\.\d{3}$"

transactionType

"debit"

Transaction Type (v1.0.0)

A string which defines a transaction type allowed for an account.

  • credit : Credits may be posted to this account, such as transfer funds to this external account.
  • debit : Debits may be posted to this account, such as transfer funds from this external account. Labels and descriptions for the enumeration values are in the transactionType key in the response of the getLabels operation.

transactionType strings may have one of the following enumerated values:

ValueDescription
debitA transaction which descreases an account's balance
creditA transaction which increases an accounts's balance

These enumeration values are further described by the label group named transactionType in the response from the getLabels operation.

This schema was resolved from products/transactionType.

type: string


enum values: debit, credit

transactionTypes

[
  "debit"
]

Transaction Types (v1.0.0)

An array which lists which transaction types are allowed for an account.

This schema was resolved from products/transactionTypes.

transactionTypes is an array schema.

Array Elements

type: array: [transactionType]

transferAccount

{
  "_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"
    }
  }
}

Transfer Account (v1.1.0)

Summary properties of the source and target account for a transfer.

This schema was resolved from transfers/transferAccount.

Properties

NameDescription
Transfer Account (v1.1.0) object
Summary properties of the source and target account for a transfer.

This schema was resolved from transfers/transferAccount.

_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
format: uri
_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: true
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
enum values: CCA, CDA, CLA, CMA, DDA, EQU, GLA, ILA, INV, IRA, IRL, LOC, MLA, MMA, PBA, PPA, RWD, SDA

twoDecimalInterestRate

"1.40"

Two Decimal Interest Rate (v1.0.0)

An interest rate, expressed as a percentage value with two decimal places of accuracy.
The schema twoDecimalInterestRate was added on version 1.18.0 of the API.
The schema twoDecimalInterestRate was added on version 1.18.0 of the API.

This schema was resolved from common/twoDecimalInterestRate.

type: string(decimal)


format: decimal
minLength: 4
maxLength: 5
pattern: "^(0|[1-9]\d?)\.\d{2}$"

typedEmailAddress

{
  "value": "JohnBankCustomer@example.com",
  "type": "unknown",
  "_id": "ha3"
}

Email Address (v1.0.0)

An email address and the email address type.

This schema was resolved from contacts/typedEmailAddress.

Properties

NameDescription
Email Address (v1.0.0) object
An email address and the email address type.

This schema was resolved from contacts/typedEmailAddress.

value string(email)
The email address, such as JohnBankCustomer@example.com
format: email
minLength: 8
maxLength: 120
type emailType
The kind of email address.
enum values: unknown, personal, work, school, other, notApplicable
_id string
An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"

usageAnswers

{
  "primaryAccount": true,
  "accountPurpose": "college savings",
  "primarySourceOfDeposits": "transfers from savings"
}

Usage Answers (v1.0.0)

Answers to financial institution questions on how the account is to be used. The questions correspond to the property names in questionsSchema in the configuration group accountUsageQuestions.

This schema was resolved from accounts/usageAnswers.

Properties

NameDescription
Usage Answers (v1.0.0) object
Answers to financial institution questions on how the account is to be used. The questions correspond to the property names in questionsSchema in the configuration group accountUsageQuestions.

This schema was resolved from accounts/usageAnswers.
Additional Properties: true

userAddress

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
    },
    "delete": {
      "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=pe1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/taxAddress?value=pe1"
    }
  },
  "_id": "ha1",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "state": "approved"
}

User Address (v1.2.1)

Representation of a user's address.

Response and request bodies using this userAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this address resourceDELETE
apiture:setAsPreferredSet Preferred Mailing AddressPUT
apiture:setAsTaxAddressSet Tax AddressPUT

This schema was resolved from users/userAddress.

Properties

NameDescription
User Address (v1.2.1) object
Representation of a user's address.

Response and request bodies using this userAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this address resourceDELETE
apiture:setAsPreferredSet Preferred Mailing AddressPUT
apiture:setAsTaxAddressSet Tax AddressPUT

This schema was resolved from users/userAddress.

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
_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
state profileItemState
The state of this address. pending addresses require financial institution approval. Only approved addresses may be set as the preferred address.
read-only
enum values: pending, approved

userEmailAddress

{
  "_profile": "https://production.api.apiture.com/schemas/users/userEmailAddress/v1.0.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/users/users/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddress?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "value": "user7838@example.com",
  "state": "approved"
}

Email Address (v1.0.3)

Representation of email address resources. An email address is immutable, although users can add new email addresses.

Response and request bodies using this userEmailAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this email address resourceDELETE
apiture:setAsPreferredSet Preferred Email AddressPUT

This schema was resolved from users/userEmailAddress.

Properties

NameDescription
Email Address (v1.0.3) object
Representation of email address resources. An email address is immutable, although users can add new email addresses.

Response and request bodies using this userEmailAddress schema may contain the following links:

RelSummaryMethod
deleteDelete this email address resourceDELETE
apiture:setAsPreferredSet Preferred Email AddressPUT

This schema was resolved from users/userEmailAddress.

_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
value string(email)
The email address, such as JohnBankCustomer@example.com
format: email
minLength: 8
maxLength: 120
type emailType
The kind of email address.
enum values: unknown, personal, work, school, other, notApplicable
_id string
An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
state profileItemState
The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.
enum values: pending, approved

userIdentityVerificationState

"unknown"

User Identity Verification State (v1.0.0)

The status of the user identity verification.

userIdentityVerificationState strings may have one of the following enumerated values:

ValueDescription
unknownUnknown
verifiedVerified
unverifiedUnVerified

These enumeration values are further described by the label group named userIdentityVerificationState in the response from the getLabels operation.

This schema was resolved from users/userIdentityVerificationState.

type: string


enum values: unknown, verified, unverified

userPhoneNumber

{
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "_profile": "https://production.api.apiture.com/schemas/users/userPhoneNumber/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/users/users/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "state": "approved"
}

Phone Number (v1.1.1)

Representation of phone number resources.

Response and request bodies using this userPhoneNumber schema may contain the following links:

RelSummaryMethod
deleteDelete this phone number resourceDELETE
apiture:setAsPreferredSet Preferred Phone NumberPUT

This schema was resolved from users/userPhoneNumber.

Properties

NameDescription
Phone Number (v1.1.1) object
Representation of phone number resources.

Response and request bodies using this userPhoneNumber schema may contain the following links:

RelSummaryMethod
deleteDelete this phone number resourceDELETE
apiture:setAsPreferredSet Preferred Phone NumberPUT

This schema was resolved from users/userPhoneNumber.

type phoneNumberType (required)
The type or role of this phone number.
enum values: unknown, home, work, mobile, fax, other
number string (required)
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are returned in responses in E.164 format with a leading +, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information.
minLength: 8
maxLength: 20
extension string
The extension number for a phone number, as a string. An extension is a short internal number assigned to a particular employee, team, or department of the main business number. Extensions are typically only present when the phone type is work.
minLength: 1
maxLength: 10
pattern: "^[0-9]{1,10}$"
label string
A text label, suitable for presentation to the end user. This is also used if type is other.
maxLength: 32
_id string
An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array.
minLength: 1
maxLength: 8
pattern: "^[-a-zA-Z0-9_]{1,8}$"
_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
state profileItemState
The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.
enum values: pending, approved

userState

"active"

User State (v1.0.0)

The state of this user resource.

userState strings may have one of the following enumerated values:

ValueDescription
activeactive: The user has been activated after intial creation, or reactivated after being locked or after being frozen by an FI admin.
inactiveinactive: The user has been deactivated after inactivity for a certain amount of days.
lockedlocked: The user has entered the incorrect password too many times and now needs to reset their password.
frozenfrozen: The user has been frozen by the financial institution or reasons including suspicion of fraudulent activity.
removedremoved: The user has been removed can not be reactivated, for example an old user account not being used anymore.

These enumeration values are further described by the label group named userState in the response from the getLabels operation.

This schema was resolved from users/userState.

type: string


enum values: active, inactive, locked, frozen, removed

userVerificationFields

{
  "kycAnswers": {
    "foreignPoliticalFigure": false,
    "foreignPoliticalFigureCountry": "st",
    "foreignPoliticalFigureAssociation": "unknown"
  },
  "identityVerificationStatus": "unknown",
  "identityVerification": {
    "provider": "string",
    "sessionId": "string",
    "scoredAt": "2019-09-13T06:11:01.375Z",
    "score": "passed",
    "state": "verified"
  }
}

User Verification Fields (v1.4.1)

Fields for recording the status of user verification for a financial institution's Customer Identification Program (CIP). (This fragment schema is used to build other schemas.)

This schema was resolved from users/userVerificationFields.

Properties

NameDescription
User Verification Fields (v1.4.1) object
Fields for recording the status of user verification for a financial institution's Customer Identification Program (CIP). (This fragment schema is used to build other schemas.)

This schema was resolved from users/userVerificationFields.

kycAnswers kycAnswers
This user's answers to the financial institutions Know Your Customer (KYC) questions.
read-only
deprecated: true
identityVerificationStatus userIdentityVerificationState
The identity verification status for this person. This field is read-only and is derived from the results of any Identity API verification applied to this user's personally identifiable information (PII).
read-only
enum values: unknown, verified, unverified
identityVerification identityVerification
The identity verification data for this person. These fields are derived from the results from the results of any Identity API verification applied to this user's personally identifiable information (PII).
Warning: The property identityVerification was deprecated on version v1.1.0 of the schema. Use identity information in Identity service instead. identityVerification will be removed on version v2.0.0 of the schema.
read-only
deprecated: true

validatedPromotionCode

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

Promotion Code Validation (v1.0.1)

Contains the response from validating a promotion code.

Properties

NameDescription
Promotion Code Validation (v1.0.1) object
Contains the response from validating a promotion code.
_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
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
code string (required)
The promotion code to validate.
minLength: 1
valid boolean (required)
true if the code is valid and `false if not.

verificationReport

{
  "_profile": "https://production.api.apiture.com/schemas/businessVerifications/summaryVerificationReport/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.example.com//businessVerifications/verificationReports/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "_embedded": {},
  "input": {
    "businessName": "ABC EXAMPLE CO.",
    "phone": "555-555-1234",
    "identification": [
      {
        "type": "taxId",
        "value": "12-347894309"
      }
    ],
    "authorizedSigners": [
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "identification": [
          {
            "type": "taxId",
            "value": "121-34-5431"
          }
        ],
        "birthdate": "1980-12-01",
        "email": "email@email.com"
      }
    ],
    "addresses": [
      {
        "addressLine1": "3212 N. 2nd Ave.",
        "city": "Wilmington",
        "regionCode": "NC",
        "postalCode": "28412"
      }
    ]
  },
  "reportScoringSummary": {
    "transactionId": "578490325jk439834yuf43",
    "state": "failed",
    "businessVerification": [
      {
        "value": 40,
        "description": "Strong verification of the input data is confirmed"
      }
    ],
    "businessRiskFactors": [
      {
        "riskCode": "20",
        "description": "Unable to verify business address on business records"
      },
      {
        "riskCode": "21",
        "description": "Unable to verify business TIN on business records"
      }
    ],
    "comprehensiveVerificationScores": [
      {
        "inputRepNumber": "1",
        "score": 20,
        "description": "Full name, address, phone, SSN verified"
      }
    ],
    "authorizedRepresentativeRiskFactors": [
      {
        "riskCode": "81",
        "description": "The input date-of-birth was missing or incomplete"
      },
      {
        "riskCode": "25",
        "description": "Unable to verify address"
      }
    ]
  },
  "reportResults": {}
}

Verification Report (v2.0.0)

Representation of verification report resources.

This schema was resolved from businessVerifications/verificationReport.

Properties

NameDescription
Verification Report (v2.0.0) object
Representation of verification report resources.

This schema was resolved from businessVerifications/verificationReport.

_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
The objects which participate in this verification report
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
format: uri
_error error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
The unique identifier for this verification report resource. This is an immutable opaque string.
read-only
reportScoringSummary verificationReportScoringSummary
Model schema for business verification report summary.

This schema was resolved from businessVerifications/verificationReportScoringSummary.

createdAt string(date-time)
An ISO 8601 UTC time stamp indicating when the verification report was created.
format: date-time
input createVerificationReport
Representation used to create a new verification report.

This schema was resolved from businessVerifications/createVerificationReport.

reportResults object
The raw verification report results

verificationReportScoringSummary

{
  "transactionId": "string",
  "state": "passed",
  "businessVerifications": [
    {
      "value": "string",
      "description": "string"
    }
  ],
  "businessRiskFactors": [
    {
      "riskCode": "string",
      "description": "string"
    }
  ],
  "comprehensiveVerificationScores": [
    {
      "inputRepNumber": "string",
      "score": 0,
      "description": "string"
    }
  ],
  "authorizedRepresentativeRiskFactors": [
    {
      "riskCode": "string",
      "description": "string"
    }
  ]
}

Verification Report Summary (v1.0.0)

Model schema for business verification report summary.

This schema was resolved from businessVerifications/verificationReportScoringSummary.

Properties

NameDescription
Verification Report Summary (v1.0.0) object
Model schema for business verification report summary.

This schema was resolved from businessVerifications/verificationReportScoringSummary.

transactionId string
The unique transactionId for this verification report used for tracking this verification report
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.
enum values: passed, failed
businessVerifications array: [businessVerificationScore]
A list of business verification scores.
items: object
businessRiskFactors array: [riskFactor]
A list of business verification risk factors.
items: object
comprehensiveVerificationScores array: [comprehensiveVerificationScore]
A list of comprehensive business verification scores.
items: object
authorizedRepresentativeRiskFactors array: [riskFactor]
A list of representative business risk factors.
items: object

verificationRequestFields

{
  "businessName": "ABC EXAMPLE CO.",
  "phone": "555-555-1234",
  "identification": [
    {
      "type": "taxId",
      "value": "12-347894309"
    }
  ],
  "attributes": {},
  "addresses": [
    {
      "addressLine1": "3212 N. 2nd Ave.",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28412"
    }
  ],
  "authorizedSigners": [
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "identification": [
        {
          "type": "taxId",
          "value": "121-34-5431"
        }
      ],
      "birthdate": "1980-12-01",
      "email": "email@email.com"
    }
  ]
}

Verification Request Fields (v1.0.0)

Common fields of a verification request, used to build other model schemas.

This schema was resolved from businessVerifications/verificationRequestFields.

Properties

NameDescription
Verification Request Fields (v1.0.0) object
Common fields of a verification request, used to build other model schemas.

This schema was resolved from businessVerifications/verificationRequestFields.

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 array: [object]
A collection of official identifying information associated with an entity.

This schema was resolved from businessVerifications/identificationModel.
items: object

authorizedSigners array: [authorizedSigner]
An optional array of authorized signer entities
items: object
addresses array: [address]
An array of postal mailing addresses for this contact.
items: object
attributes attributes
An optional map of name/value pairs which provide additional metadata about the verification report.

verificationToken

{
  "token": "string"
}

Verification Token (v1.0.0)

The token used to validate and track a contact for identity verification purposes.

This schema was resolved from identity/verificationToken.

Properties

NameDescription
Verification Token (v1.0.0) object
The token used to validate and track a contact for identity verification purposes.

This schema was resolved from identity/verificationToken.

token string
An opaque string that conveys the state of the contact's identity verification.

verifiedTransferAccount

{
  "_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"
    }
  }
}

Verified Transfer Account (v1.1.0)

Details of the account, possibly an external account, used to fund the new account.

Properties

NameDescription
Verified Transfer Account (v1.1.0) object
Details of the account, possibly an external account, used to fund the new account.
_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
format: uri
_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: true
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
enum values: CCA, CDA, CLA, CMA, DDA, EQU, GLA, ILA, INV, IRA, IRL, LOC, MLA, MMA, PBA, PPA, RWD, SDA
verificationReport verificationReport
If this funding account is a new external account, this is an account verification report from an external account verification provider. It contains a pass/fail result based on risk factors. This property does not exist if the account is an internal account at this financial institution, or if this account is an external account that the user verified before starting this application.
state externalAccountState
The state of the external account.
read-only
enum values: pending, verifying, failed, active, inactive, frozen, closed, underReview, microDepositsRequested

yearsAtAddress

"unknown"

Years at Address (v1.0.0)

Categories for how long the person has been at their present home address.

This schema was resolved from contacts/yearsAtAddress.

type: string


enum values: unknown, oneOrFewer, two, three, fourOrMore

yearsOwned

"unknown"

Years Owned (v1.0.0)

The number of years the owners/operators have owned the business. Warning: the enum list will be removed in a future release and the values defined at runtime via the yearsOwned group in the response from the getLabels operation.

This schema was resolved from organizations/yearsOwned.

type: string


enum values: unknown, one, two, three, fourOrMoreYears, other, notApplicable

Generated by @apiture/api-doc 3.2.4 on Mon Oct 28 2024 14:41:02 GMT+0000 (Coordinated Universal Time).
Shell HTTP Node.JS JavaScript Ruby Python Java Go