Shell HTTP Node.JS JavaScript Ruby Python Java Go

Documents v0.6.7

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

The Documents API provides operations for all bank customers to list their banking documents, such as :

Users may request lists of documents based on document category, document type, and/or date intervals based on query parameters:

The caller can fetch the document resource for each document. This document metadata includes properties which describe the document, such as the document name, label, document types, document category, content type, the date range the document applies to, the document context (usually an account).

Each document resource has an apiture:content link to download the document's content. The content is typically a PDF (application/pdf) file.

Document Providers

This API supports integration with third party document providers, such as vendors which issue monthly statements or tax documents. The vendor integrations are configured in the documentProviders configuration group. There may be multiple providers, each of which prints different groups of documents. Use getDocumentGroups to determine all the different groups of documents, by provider. Each document group specifies one or more document contexts and document types and optionall account types. For each returned group, the client can instantiate the integration (typically, embedding an HTML iFrame) via the results from calling createDocumentProviderParameters with the group as part of the request body.

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.

groupNotFound

Description: No Groups were found for the specified groupName.
Remediation: Check to make sure that the supplied groupName corresponds to an apiture group resource.

valueNotFound

Description: No Group values were found for the specified groupName and valueName.
Remediation: Check to make sure that the supplied groupName and valueName corresponds to an apiture group and value resource.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Authentication

Scope Scope Description
banking/read Read access to accounts and account-related resources such as transfers and transactions.
banking/full Full access to accounts and account-related resources such as transfers and transactions.

Documents

Documents

getDocuments

Code samples

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

GET https://api.devbank.apiture.com/documents/documents 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/documents/documents',
{
  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/documents/documents',
  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/documents/documents',
  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/documents/documents', params={

}, headers = headers)

print r.json()

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

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

Return a collection of documents

GET /documents

Return a paginated filterable collection of documents. The links in the response include pagination links. Periodic or recurring documents such as statements or tax documents may be filtered in several ways:

  1. Pass endOn and a period which represents how far in the past to include. The endOn is the current date if omitted. For example, to fetch documents for the last six months, request ?period=P6M query parameters. Each prev link will return the previous six months of documents. The default period if ommitted is P6M. Thus, the default request if none of startOn, endOn and period are passed is the last 6 months of documents. This implies a result sorted in descending order by time.
  2. Pass startOn and endOn, to find any documents which overlap that date range. This implies a result sorted in ascending order by time.
  3. Pass the startOn and a period which represents how far after the start date to include. For example, to fetch documents for the first six months of 2018, request ?startOn=2018-01-01&period=P6M query parameters. Each next link in the response collection will return the next six months of documents, if available. This implies a result sorted in ascending order by time.
  4. If one or ore accounts are included in the the optional account query parameter, only documents associated with those accounts will be returned; the caller must be a primary owner, joint owner, or authorized signer of the accounts. An empty list of _embedded.items will be returned if the user is not entitled to any of the requested accounts.

Parameters

ParameterDescription
start integer(int64)
The zero-based index of the first document item to include in this page. The default 0 denotes the beginning of the collection.
Default: 0
limit integer(int32)
The maximum number of document representations to return in this page.
Default: 100
account array[string]
An optional pipe (|) separated list of one or more account IDs. Note: these are not account numbers but are the unique resource _id of the corresponding financial institution accounts via the Accounts API. The user must have access to the corresponding accounts in order to view documents associated with the accounts. If omitted, the listed documents may match any account the user is entitled to view, or may not be account-specific documents. Examples:
?account=e486ebd0-167d-4fc6-8fd0-0edf275ef431
?account=e486ebd0-167d-4fc6-8fd0-0edf275ef431|43ae102e-4cec-488f-a3c5-7f15c3659960

pipe-delimited
startOn string(date)
The start date of the query range. May be combined with endOn or period but not both.
endOn string(date)
The end date of the query range. May be combined with endOn or period but not both.
period string(period)
The time period for the date range, looking backwards from endOn (or today, if endOn is omitted), or forward from startOn. For example, to list the documents for the last 6 months, use ?period=P6m.
type array[string]
Match documents by document category. This matches any of the values in the |-seprated list. Note: type and category are mutually exclusive. Examples:
?category=form1099Int
?category=form1099Int|form1099Sa.
pipe-delimited
category array[string]
Match documents by document category. This matches any of the values in the |-seprated list. Note: type and category are mutually exclusive. Examples:
?category=accountStatement
?category=accountStatement|agreements.
pipe-delimited
filter string
Optional filter criteria. See filtering.
This collection may be filtered by the following properties and functions:
• Property startOn using functions eq, ne, lt, le, gt, ge
• Property endOn using functions eq, ne, lt, le, gt, ge
• Property type using functions eq, in
• Property category using functions eq, in.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documents/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/documents/documents"
    }
  },
  "name": "documents",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:content": {
            "href": "https://api.devbank.apiture.com/some/expiring/download/location"
          },
          "apiture:account": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/{accountId}"
          }
        },
        "name": "532a0e1b82f592e40803-1099-INT.pdf",
        "label": "1099 INT for Account ******3210 for 2019",
        "typeName": "form1099Int",
        "categoryName": "taxForm",
        "contentType": "application/pdf",
        "startOn": "2020-01-01",
        "endOn": "2020-01-31",
        "createdAt": "2020-02-01T00:01:38.375Z",
        "account": {
          "name": "Personal Savings",
          "title": "John Smith",
          "institutionName": "3rd Party Bank",
          "routingNumber": "021000021",
          "accountNumbers": {
            "masked": "******3210"
          }
        }
      },
      {
        "_id": "83babc98-f0bf-4c14-b7d6-4cb1539e2b47",
        "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/documents/documents/83babc98-f0bf-4c14-b7d6-4cb1539e2b47"
          },
          "apiture:content": {
            "href": "https://api.devbank.apiture.com/some/expiring/download/location"
          },
          "apiture:account": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/{accountId}"
          }
        },
        "name": "532a0e1b82f592e40803-1099-SA.pdf",
        "label": "1099 SA for Account ******3210 for 2019",
        "typeName": "form1099Sa",
        "categoryName": "taxForm",
        "contentType": "application/pdf",
        "startOn": "2020-01-01",
        "endOn": "2020-01-31",
        "createdAt": "2020-02-01T00:01:38.375Z",
        "account": {
          "name": "Personal Savings",
          "title": "John Smith",
          "institutionName": "3rd Party Bank",
          "routingNumber": "021000021",
          "accountNumbers": {
            "masked": "******3210"
          }
        }
      }
    ]
  }
}

Responses

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

getDocument

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/documents/documents/{documentId} \
  -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/documents/documents/{documentId} 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/documents/documents/{documentId}',
{
  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/documents/documents/{documentId}',
  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/documents/documents/{documentId}',
  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/documents/documents/{documentId}', params={

}, headers = headers)

print r.json()

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

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

Fetch a representation of this document

GET /documents/{documentId}

Return a HAL representation of this document resource. This returns a JSON object which describes the document, its category, type. The document representation includes a n apiture:content link to the getContent operation for downloading the document's content.

Parameters

ParameterDescription
documentId string (required)
The unique identifier of this document. This is an opaque string.
unmasked boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of true, to request that the response body includes the full account number. Such requests are auditable.
Default: false
If-None-Match string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
    },
    "apiture:account": {
      "documents": "/accounts/accounts/{accountId}",
      "href": "https://api.devbank.apiture.com/accounts/account/100a6159-7811-4986-b1df-99555b059757"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "532a0e1b82f592e40803-1099-INT.pdf",
  "label": "1099 INT for Account ******3210 for 2019",
  "contentType": "application/pdf",
  "typeName": "form1099Int",
  "categoryName": "taxForm",
  "startOn": "2020-01-01",
  "endOn": "2020-01-31",
  "createdAt": "2020-02-01T00:01:38.375Z",
  "period": "P1Y",
  "account": {
    "name": "Personal Savings",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "******3210"
    }
  },
  "type": {
    "name": "accountStatement",
    "label": "Account Statement",
    "period": "P1M",
    "category": {
      "name": "accountStatements",
      "label": "Account Statements"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: document
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 document resource at the specified {documentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this document resource.

getContent

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/documents/documents/{documentId}/content \
  -H 'Accept: */*' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/documents/documents/{documentId}/content HTTP/1.1
Host: api.devbank.apiture.com
Accept: */*

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

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

};

fetch('https://api.devbank.apiture.com/documents/documents/{documentId}/content',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/documents/documents/{documentId}/content',
  method: 'get',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/documents/documents/{documentId}/content', params={

}, headers = headers)

print r.json()

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

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

Return the raw content of the document

GET /documents/{documentId}/content

Return the raw content of the document as a stream of bytes. This operation normally returns a 302 to redirect the caller to the actual URL where the file content is available.

Parameters

ParameterDescription
documentId string (required)
The unique identifier of this document. This is an opaque string.

Try It

Example responses

200 Response

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_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
200 OK
OK.
Schema: string
StatusDescription
302 Found
Found. The URL where the file's content is located. This is the most likely response.
StatusDescription
404 Not Found
Not Found. There is no such document resource at the specified {documentId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

Response Headers

StatusDescription
200 Content-Type string
The media type of the file content.
302 Location string
The URL where the file's content is located.

Statements

Monthly Account Statements

getStatements

Code samples

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

GET https://api.devbank.apiture.com/documents/statements 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/documents/statements',
{
  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/documents/statements',
  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/documents/statements',
  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/documents/statements', params={

}, headers = headers)

print r.json()

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

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

Return a collection of statements

GET /statements

Return a paginated filterable collection of account activity statements. The links in the response include pagination links. This operation is a convenience for getDocuments?type=accountStatement. Thus, this operation does not support passing or augmenting the type or category query parameters or collection filters as allowed by that operation. Statements may be filtered using the ?startOn, ?endOn and period query parameters of that operation. Note that the items in the response are summary document representations, and the nested document resources are located at /documents/{documentId}.

Parameters

ParameterDescription
start integer(int64)
The zero-based index of the first statement item to include in this page. The default 0 denotes the beginning of the collection.
Default: 0
limit integer(int32)
The maximum number of statement representations to return in this page.
Default: 100
accounts array[string]
An optional pipe (|) separated list of one or more account IDs. Note: these are not account numbers but are the unique resource _id of the corresponding financial institution accounts via the Accounts API. The user must have access to the corresponding accounts in order to view documents associated with the accounts. If omitted, the listed documents may match any account the user is entitled to view, be account-specific documents. Examples:
?account=e486ebd0-167d-4fc6-8fd0-0edf275ef431
?account=e486ebd0-167d-4fc6-8fd0-0edf275ef431|43ae102e-4cec-488f-a3c5-7f15c3659960

pipe-delimited
startOn string(date)
The start date of the query range. May be combined with endOn or period but not both.
endOn string(date)
The end date of the query range. May be combined with endOn or period but not both.
period string(period)
The time period for the date range, looking backwards from endOn (or today, if endOn is omitted), or forward from startOn. For example, to list the statements for the last 6 months, use ?period=P6m.
filter string
Optional filter criteria. See filtering.
This collection may be filtered by the following properties and functions:
• Property startOn using functions eq, lt, le, gt, ge
• Property endOn using functions eq, lt, le, gt, ge.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documents/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/documents/documents"
    }
  },
  "name": "documents",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:content": {
            "href": "https://api.devbank.apiture.com/some/expiring/download/location"
          },
          "apiture:account": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/{accountId}"
          }
        },
        "name": "532a0e1b82f592e40803-1099-INT.pdf",
        "label": "1099 INT for Account ******3210 for 2019",
        "typeName": "form1099Int",
        "categoryName": "taxForm",
        "contentType": "application/pdf",
        "startOn": "2020-01-01",
        "endOn": "2020-01-31",
        "createdAt": "2020-02-01T00:01:38.375Z",
        "account": {
          "name": "Personal Savings",
          "title": "John Smith",
          "institutionName": "3rd Party Bank",
          "routingNumber": "021000021",
          "accountNumbers": {
            "masked": "******3210"
          }
        }
      },
      {
        "_id": "83babc98-f0bf-4c14-b7d6-4cb1539e2b47",
        "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/documents/documents/83babc98-f0bf-4c14-b7d6-4cb1539e2b47"
          },
          "apiture:content": {
            "href": "https://api.devbank.apiture.com/some/expiring/download/location"
          },
          "apiture:account": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/{accountId}"
          }
        },
        "name": "532a0e1b82f592e40803-1099-SA.pdf",
        "label": "1099 SA for Account ******3210 for 2019",
        "typeName": "form1099Sa",
        "categoryName": "taxForm",
        "contentType": "application/pdf",
        "startOn": "2020-01-01",
        "endOn": "2020-01-31",
        "createdAt": "2020-02-01T00:01:38.375Z",
        "account": {
          "name": "Personal Savings",
          "title": "John Smith",
          "institutionName": "3rd Party Bank",
          "routingNumber": "021000021",
          "accountNumbers": {
            "masked": "******3210"
          }
        }
      }
    ]
  }
}

Responses

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

Document Types

Documents Types

getDocumentTypes

Code samples

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

GET https://api.devbank.apiture.com/documents/documentTypes 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/documents/documentTypes',
{
  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/documents/documentTypes',
  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/documents/documentTypes',
  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/documents/documentTypes', params={

}, headers = headers)

print r.json()

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

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

A list of document types

GET /documentTypes

Return a list of document types.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentTypes/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documentTypes"
    }
  },
  "items": [
    {
      "name": "accountStatement",
      "label": "Account Statement",
      "period": "P1M",
      "category": {
        "name": "accountStatements",
        "label": "Account Statements"
      },
      "_profile": "https://production.api.apiture.com/schemas/documents/documentType/v1.0.2/profile.json"
    },
    {
      "name": "form1099Int",
      "label": "Form 1099-INT",
      "period": "P1Y",
      "category": {
        "name": "taxStatements",
        "label": "Tax Statements"
      },
      "_profile": "https://production.api.apiture.com/schemas/documents/documentType/v1.0.2/profile.json"
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: documentTypes

Document Categories

Documents Categories

getDocumentCategories

Code samples

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

GET https://api.devbank.apiture.com/documents/documentCategories 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/documents/documentCategories',
{
  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/documents/documentCategories',
  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/documents/documentCategories',
  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/documents/documentCategories', params={

}, headers = headers)

print r.json()

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

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

A list of document categories

GET /documentCategories

Return a list of document categories.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentCategories/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documentCategories"
    }
  },
  "items": [
    {
      "name": "agreements",
      "label": "Account Agreements",
      "_profile": "https://production.api.apiture.com/schemas/documents/documentCategory/v1.0.2/profile.json"
    },
    {
      "name": "taxForm",
      "label": "Tax Forms",
      "_profile": "https://production.api.apiture.com/schemas/documents/documentCategory/v1.0.2/profile.json"
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: documentCategories

Document Providers

Documents Grouped by Document Providers

getDocumentGroups

Code samples

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

GET https://api.devbank.apiture.com/documents/documentGroups 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/documents/documentGroups',
{
  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/documents/documentGroups',
  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/documents/documentGroups',
  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/documents/documentGroups', params={

}, headers = headers)

print r.json()

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

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

A list of document groups

GET /documentGroups

Return a list of document groups. Each group contains related documents types and account types published by a document provider. The clients may use this to define a UI component (a view, page, or card) to list all the related documents for download in each group that matches their accounts and/or organizations where they are an authorized signers.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentGroups/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documentGroups"
    }
  },
  "items": [
    {
      "name": "printMailForDepositAccounts",
      "label": "Deposit Account Statements and Tax Documents",
      "providerId": "printMail",
      "ifxTypes": [
        "CDA",
        "DDA",
        "MMA",
        "SDA"
      ],
      "accounts": [
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/1744f75f-f592-4970-a85f-d0283cb214bc",
          "name": "Personal Savings",
          "maskedAccountNumber": "7890"
        },
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/e2a8477f-d05a-4ce5-9af8-5d8782e17df6",
          "name": "Shared Checking Savings",
          "maskedAccountNumber": "6789"
        }
      ],
      "documentTypes": [
        "accountStatement",
        "form1099Int"
      ],
      "contexts": [
        "account",
        "user"
      ]
    },
    {
      "name": "printMailForLoanAccounts",
      "label": "Loan Statements and Tax Documents",
      "providerId": "printMail",
      "ifxTypes": [
        "ILA"
      ],
      "documentTypes": [
        "accountStatement",
        "form1099A"
      ],
      "accounts": [
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/1da2a0c4-9d0e-4cb8-bb0f-4357fd69e701",
          "name": "Capital expansion loan",
          "maskedAccountNumber": "1112"
        }
      ],
      "contexts": [
        "account",
        "organization"
      ],
      "organization": {
        "uri": "https://api.devbank.apiture.com//organization/sorganizations/df9e4d5b-7978-4d63-b1a4-e9a17edaf9a6",
        "name": "Smith's Auto Detailing"
      }
    },
    {
      "name": "printMailForDepositAccounts",
      "label": "Deposit Statements and Tax Documents",
      "providerId": "printMail",
      "ifxTypes": [
        "CDA",
        "DDA",
        "MMA",
        "SDA"
      ],
      "accounts": [
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/51593bea-c2ee-4e14-8cc4-c01072e919af",
          "name": "Business Checking - operations",
          "maskedAccountNumber": "2990"
        }
      ],
      "documentTypes": [
        "accountStatement",
        "form1099A"
      ],
      "contexts": [
        "account",
        "organization"
      ],
      "organization": {
        "uri": "https://api.devbank.apiture.com/organizations/organizations/0aa74c0b-28df-4f3e-b413-1ce5fef6fc63",
        "name": "Smith's Pre-Owned"
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: documentGroups

createDocumentProviderParameters

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/documents/documentProviderParameters \
  -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/documents/documentProviderParameters 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/documents/createDocumentProviderParameters/v1.0.2/profile.json",
  "_links": {},
  "group": {
    "name": "printMailForLoanAccounts",
    "label": "Loan Statements and Tax Documents",
    "providerid": "printMail",
    "ifxTypes": [
      "ILA"
    ],
    "documentTypes": [
      "accountStatement",
      "form1099A"
    ],
    "contexts": [
      "account",
      "organization"
    ],
    "organization": {
      "uri": "https://api.devbank.apiture.com/organizations/organizations/0aa74c0b-28df-4f3e-b413-1ce5fef6fc63",
      "name": "Smith's Pre-Owned"
    }
  },
  "parameters": []
}';
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/documents/documentProviderParameters',
{
  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/documents/documentProviderParameters',
  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/documents/documentProviderParameters',
  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/documents/documentProviderParameters', params={

}, headers = headers)

print r.json()

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

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

Generate document provider parameters

POST /documentProviderParameters

This operation generates parameters to integrate with a client-embedded secure document provider application component. The response is based on the current user and the passed group (one item from the getDocumentGroups response). The operation may take several seconds and this operation may process the request asynchronously, returning a 202 response code and Retry-After. After that retry delay, the client should try again with no request body until the operation returns a 200 response. After the first POST, retry operations should not pass a request body. If a POST includes a request body (even if the parameters are the same), this aborts the first operation and restarts the provider configuration. The client should not make concurrent requests with different request bodies/document groups.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/documents/createDocumentProviderParameters/v1.0.2/profile.json",
  "_links": {},
  "group": {
    "name": "printMailForLoanAccounts",
    "label": "Loan Statements and Tax Documents",
    "providerid": "printMail",
    "ifxTypes": [
      "ILA"
    ],
    "documentTypes": [
      "accountStatement",
      "form1099A"
    ],
    "contexts": [
      "account",
      "organization"
    ],
    "organization": {
      "uri": "https://api.devbank.apiture.com/organizations/organizations/0aa74c0b-28df-4f3e-b413-1ce5fef6fc63",
      "name": "Smith's Pre-Owned"
    }
  },
  "parameters": []
}

Parameters

ParameterDescription
body createDocumentProviderParameters
Optional data that is needed to curate the provider parameters

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentProviderParameters/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "group": {
    "name": "printMailForLoanAccounts",
    "label": "Loan Statements and Tax Documents",
    "providerId": "printMail",
    "ifxTypes": [
      "ILA"
    ],
    "documentTypes": [
      "accountStatement",
      "form1099A"
    ],
    "contexts": [
      "organization"
    ]
  },
  "parameters": [
    {
      "name": "widgetUrl",
      "value": "https://int-widgets.moneydesktop.com/md/connections/qfnp2wzqg9rthAp8tv70fb6pzqZ8v9xfzn3by2k2"
    }
  ]
}

Responses

StatusDescription
201 Created
Created. The response contains the parameters to integrate with the account verification provider components.
Schema: documentProviderParameters
202 Accepted
Accepted. The request has been accepted but could not complete in a timely manner. Retry the operation after waiting the number of seconds specified in the Retry-After response header. The returned response body has an empty parameters array.
Schema: documentProviderParameters
StatusDescription
400 Bad Request
Bad Request. The parameters are not well-formed.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. The request body does not correspond to a valid document group. Use only items from the response from the getDocumentGroups operation.
Schema: errorResponse

Response Headers

StatusDescription
202 Retry-After string
Indicates a suggested delay in seconds after which the client should retry the operation.
Example: Retry-After: 5

Configuration

Documents Service Configuration

getConfigurationGroups

Code samples

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

GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups", data)
    req.Header = headers

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

Return a collection of configuration groups

GET /configurations/groups

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

Try It

Example responses

200 Response

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

getConfigurationGroup

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups/{groupName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups/{groupName}", data)
    req.Header = headers

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

Fetch a representation of this configuration group

GET /configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

ParameterDescription
groupName string (required)
The unique name of this configuration group.
If-None-Match string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try It

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
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.
Schema: errorResponse

Response Headers

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

getConfigurationGroupSchema

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups/{groupName}/schema", data)
    req.Header = headers

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

Fetch the schema for this configuration group

GET /configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

ParameterDescription
groupName string (required)
The unique name of this configuration group.
If-None-Match string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try It

Example responses

200 Response

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

Responses

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

Response Headers

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

getConfigurationGroupValues

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Fetch the values for the specified configuration group

GET /configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

ParameterDescription
groupName string (required)
The unique name of this configuration group.
If-None-Match string
The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Try It

Example responses

200 Response

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

Responses

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

Response Headers

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

updateConfigurationGroupValues

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Update the values for the specified configuration group

PUT /configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

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

Parameters

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

Try It

Example responses

200 Response

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

Responses

StatusDescription
200 OK
OK.
Schema: configurationSchema
StatusDescription
400 Bad Request
Bad Request. The request body 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 no such configuration group resource at the specified {groupName} The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
412 Precondition Failed
Precondition Failed. The supplied If-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
Schema: errorResponse

Response Headers

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

getConfigurationGroupValue

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Fetch a single value associated with the specified configuration group

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

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be

Parameters

ParameterDescription
groupName string (required)
The unique name of this configuration group.
valueName string (required)
The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*.

Try It

Example responses

200 Response

"string"

Responses

StatusDescription
200 OK
OK. The value of the named configuration value as a JSON string, number, boolean, array, or object.
Schema: string
StatusDescription
404 Not Found

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

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

Schema: errorResponse

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource.

updateConfigurationGroupValue

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/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/documents/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

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

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema. The request body must conform to the configuration group's schema for the named {valueName}. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be

Body parameter

"string"

Parameters

ParameterDescription
groupName string (required)
The unique name of this configuration group.
valueName 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 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.

Try It

Example responses

200 Response

"string"

Responses

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

Response Headers

StatusDescription
200 ETag string
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this configuration group resource.

API

The Documents API

getLabels

Code samples

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

GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/labels', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/labels", data)
    req.Header = headers

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

Localized Labels

GET /labels

Return a JSON object which defines labels for enumeration types 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 string
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "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: localizedLabels

getApi

Code samples

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

GET https://api.devbank.apiture.com/documents/ 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/documents/',
{
  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/documents/',
  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/documents/',
  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/documents/', params={

}, headers = headers)

print r.json()

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

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

Top-level resources and operations in this API

GET /

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

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "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/documents/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/documents/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/documents/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/documents/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/documents/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/documents/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/documents/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/documents/apiDoc", data)
    req.Header = headers

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try It

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK.
Schema: Inline

Response Schema

Schemas

abstractRequest

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

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only

accountIdentification

{
  "name": "My Premiere Savings",
  "title": "John Smith",
  "routingNumber": "021000021",
  "accountNumbers": {
    "masked": "*************3210"
  },
  "institutionName": "3rd Party Bank"
}

Account Identification (v1.0.1)

Properties which identify a specific account.

This schema was resolved from accounts/accountIdentification.

Properties

NameDescription
name string
The account name.
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 which manages the account.
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 object: accountNumbers
The masked and full account numbers for this account. The full value only appears when ?unmasked=true is passed on the GET request.
read-only

accountNumbers

{
  "masked": "*************3210",
  "full": "9876543210"
}

Account Numbers (v1.0.1)

Different representations of an account number.

This schema was resolved from common/accountNumbers.

Properties

NameDescription
masked string
A partial account number that does not contain all the digits of the full account number. This masked number appears in statements or in user experience presentation. It is sufficient for a user to differentiate this account from other accounts they hold, but is not sufficient for initiating transfers, etc. The first character is the mask character and is repeated; this does not indicate that the full account number is the same as the mask length. This value is derived and immutable.
read-only
minLength: 8
maxLength: 32
full string
The full account number. This value only appears when ?unmasked=true is passed on the GET request. Not included in the summary representation of the account that is included in account collection responses. This value is derived and immutable.
read-only
minLength: 4
maxLength: 17

attributes

{}

Attributes (v2.1.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

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
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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.

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
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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 object: 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 object: 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
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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
_links object: 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: configurationGroupsEmbedded
Embedded objects.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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
items array: [configurationGroupSummary]
An array containing a page of configuration group items.

configurationSchema

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

Configuration Schema (v2.1.0)

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*.

This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

This schema was resolved from configurations/configurationSchema.

Properties

NameDescription
additionalProperties object: configurationSchemaValue
The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

Properties

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

configurationValues

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

Configuration Values (v2.0.0)

The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values.

For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

This schema was resolved from configurations/configurationValues.

Properties

NameDescription
additionalProperties object: configurationValue
The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

createDocumentProviderParameters

{
  "_profile": "https://production.api.apiture.com/schemas/documents/createDocumentProviderParameters/v1.0.2/profile.json",
  "_links": {},
  "group": {
    "name": "printMailForLoanAccounts",
    "label": "Loan Statements and Tax Documents",
    "providerid": "printMail",
    "ifxTypes": [
      "ILA"
    ],
    "documentTypes": [
      "accountStatement",
      "form1099A"
    ],
    "contexts": [
      "account",
      "organization"
    ],
    "organization": {
      "uri": "https://api.devbank.apiture.com/organizations/organizations/0aa74c0b-28df-4f3e-b413-1ce5fef6fc63",
      "name": "Smith's Pre-Owned"
    }
  },
  "parameters": []
}

Create Document Provider Parameters (v1.0.2)

Parameters that the client passes to create the document provider user interface component.

Properties

NameDescription
_links object: 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
group object: documentGroup (required)
The document provider group (one item from the response from getDocumentGroups which defines this document provider component.
parameters array: [documentProviderParameter] (required)
An array of individual document provider parameters.

document

{
  "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
    },
    "apiture:account": {
      "documents": "/accounts/accounts/{accountId}",
      "href": "https://api.devbank.apiture.com/accounts/account/100a6159-7811-4986-b1df-99555b059757"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "532a0e1b82f592e40803-1099-INT.pdf",
  "label": "1099 INT for Account ******3210 for 2019",
  "contentType": "application/pdf",
  "typeName": "form1099Int",
  "categoryName": "taxForm",
  "startOn": "2020-01-01",
  "endOn": "2020-01-31",
  "createdAt": "2020-02-01T00:01:38.375Z",
  "period": "P1Y",
  "account": {
    "name": "Personal Savings",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "******3210"
    }
  },
  "type": {
    "name": "accountStatement",
    "label": "Account Statement",
    "period": "P1M",
    "category": {
      "name": "accountStatements",
      "label": "Account Statements"
    }
  }
}

Document (v1.1.3)

Representation of document metadata. The links on a document include the content download URL, and for documents associated with an account, organization, or user, a link to the associated account organization, or user resource.

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

RelSummaryMethod
selfFetch a representation of this documentGET
apiture:contentReturn the raw content of the documentGET
apiture:account Account associated with this documentGET
apiture:user User associated with this documentGET
apiture:organization Organization associated with this documentGET

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
name string
The document name.
read-only
label string
A more descriptive label for the document.
read-only
typeName string
The name of the document type
read-only
categoryName string
The name of the document category.
read-only
contentType string
The media type for this file. This is document/pdf (Portable Document Format) for most document types. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
read-only
startOn string(date)
The inclusive beginning date in RFC 3339 YYYY-MM-DD format for this document. For example, for statements or other recurring documents, this is the beginning of the statement period. The document type indicates if the the document is recurring/periodical.
read-only
endOn string(date)
The inclusive end date in RFC 3339 YYYY-MM-DD format for this document. For example, for statements or other recurring documents, this is the end of the statement period. The document type indicates if the the document is recurring/periodical.
read-only
createdAt string(date-time)
The date-time of the document's creation, in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format.
account object: accountIdentification
Identifying attributes of the account that this document pertains to. If omitted, the document is not associated with an account.
read-only
_id string
The unique identifier for this document resource. This is an immutable opaque string.
read-only
type object: documentType
The document type, which also includes the document's category.

documentCategories

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentCategories/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documentCategories"
    }
  },
  "items": [
    {
      "name": "agreements",
      "label": "Account Agreements",
      "_profile": "https://production.api.apiture.com/schemas/documents/documentCategory/v1.0.2/profile.json"
    },
    {
      "name": "taxForm",
      "label": "Tax Forms",
      "_profile": "https://production.api.apiture.com/schemas/documents/documentCategory/v1.0.2/profile.json"
    }
  ]
}

Document Categories (v1.1.3)

Array of document categories.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items array: [documentCategory]
An array of all document categories.

documentCategory

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "taxForms",
  "label": "Tax Forms",
  "content": "user",
  "_profile": "https://production.api.apiture.com/schemas/documents/documentCategory/v1.0.2/profile.json"
}

Document Category (v1.0.2)

Representation of document category resources.

Properties

NameDescription
name string
The name of this document category. This is an identifier. This corresponds to an item in the getDocumentCategories response.
minLength: 4
maxLength: 48
pattern: ^[a-z][a-zA-Z0-9_$]{3,47}$
label string
The human-presentable label of this document category.
context string: documentContext
The type of resource that documents in this category are associated with.
enum values: account, organization, user

documentContext

"account"

Document Context (v1.0.0)

The type of resource that documents in this category are associated with.

documentContext strings may have one of the following enumerated values:

ValueDescription
accountAccount: The document is associated with the account referenced by the apiture:account link.
organizationorganization: The document is associated with an organization referenced by the apiture:organization link.
userAccount: The document is associated with a user referenced by the apiture:user link.

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

Type: string
enum values: account, organization, user

documentGroup

{
  "name": "printMailForDepositAccounts",
  "label": "Deposit Account Statements and Tax Documents",
  "providerId": "printMail",
  "ifxTypes": [
    "CDA",
    "DDA",
    "MMA",
    "SDA"
  ],
  "accounts": [
    {
      "uri": "https://api.devbank.apiture.com/accounts/accounts/1744f75f-f592-4970-a85f-d0283cb214bc",
      "name": "Personal Savings",
      "maskedAccountNumber": "7890"
    },
    {
      "uri": "https://api.devbank.apiture.com/accounts/accounts/e2a8477f-d05a-4ce5-9af8-5d8782e17df6",
      "name": "Shared Checking Savings",
      "maskedAccountNumber": "6789"
    }
  ],
  "contexts": [
    "account",
    "user"
  ],
  "documentTypes": [
    "accountStatement",
    "form1099Int"
  ],
  "profile": "https://production.api.apiture.com/schemas/documents/documentGroup/v1.0.2/profile.json"
}

Document Group (v1.0.2)

Describes document types, document contexts, and/or account types which form a related set of documents that the financial institution groups together for presentation to the user. The name corresponds to one of the document group names in the providers value in the documentProviders configuration group.

If the current user is an authorized signer on one or more accounts, there is a document group for each organization and the organization property describes that organization.

Properties

NameDescription
name string (required)
The name of this document group. This corresponds to an item in the getDocumentGroups response.
minLength: 4
maxLength: 48
pattern: ^[a-z][a-zA-Z0-9_$]{3,47}$
providerId string (required)
The "lowerCamelCase" system ID of the document provider. This string tells the client how to instantiate the provider integration/SSO for this group via createDocumentProviderParameters.
minLength: 4
maxLength: 48
pattern: ^[a-z][a-zA-Z0-9_$]{3,47}$
label string (required)
The human-presentable label of this document group.
documentTypes array: [string] (required)
An array of document type names that are included when in this document group's UI presentation.
unique items
minItems: 1
items:
» minLength: 4
» maxLength: 64
» pattern: ^[a-z][a-zA-Z0-9]{3,63}$
contexts array: [documentContext] (required)
The types of resources that documents in this group are associated with.
minItems: 1
ifxTypes array: [ifxType] (required)
The document types, if any, for documents in this group. This array may be empty.
unique items
accounts array: [documentGroupAccount] (required)
The accounts that matched the document group criteria. This array may be empty.
unique items
organization object: documentGroupOrganization
If the document group has organization as one of its contexts, this identifies the organization's whose documents are assembled in the group. Omitted if the group does not have an organization context.

documentGroupAccount

{
  "uri": "https://api.devbank.apiture.com/accounts/accounts/1744f75f-f592-4970-a85f-d0283cb214bc",
  "name": "Personal Savings",
  "maskedAccountNumber": "7890"
}

Document Group Account (v1.0.0)

Reference to an account. The document group contains documents for these accounts.

Properties

NameDescription
uri string(uri) (required)
The URI of the account from the Accounts API.
maxLength: 2048
name string (required)
The account name.
maskedAccountNumber string (required)
The last four digits of the account number.
minLength: 4
maxLength: 4

documentGroupOrganization

{
  "uri": "http://example.com",
  "name": "string"
}

Document Group Organization (v1.0.0)

Descriptive information for an organization in a document group, if the document group has an organization context.

Properties

NameDescription
uri string(uri) (required)
The URI of a business or oganization that owns accounts.
maxLength: 2048
name string (required)
The name of a business or oganization that owns accounts.

documentGroups

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentGroups/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documentGroups"
    }
  },
  "items": [
    {
      "name": "printMailForDepositAccounts",
      "label": "Deposit Account Statements and Tax Documents",
      "providerId": "printMail",
      "ifxTypes": [
        "CDA",
        "DDA",
        "MMA",
        "SDA"
      ],
      "accounts": [
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/1744f75f-f592-4970-a85f-d0283cb214bc",
          "name": "Personal Savings",
          "maskedAccountNumber": "7890"
        },
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/e2a8477f-d05a-4ce5-9af8-5d8782e17df6",
          "name": "Shared Checking Savings",
          "maskedAccountNumber": "6789"
        }
      ],
      "documentTypes": [
        "accountStatement",
        "form1099Int"
      ],
      "contexts": [
        "account",
        "user"
      ]
    },
    {
      "name": "printMailForLoanAccounts",
      "label": "Loan Statements and Tax Documents",
      "providerId": "printMail",
      "ifxTypes": [
        "ILA"
      ],
      "documentTypes": [
        "accountStatement",
        "form1099A"
      ],
      "accounts": [
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/1da2a0c4-9d0e-4cb8-bb0f-4357fd69e701",
          "name": "Capital expansion loan",
          "maskedAccountNumber": "1112"
        }
      ],
      "contexts": [
        "account",
        "organization"
      ],
      "organization": {
        "uri": "https://api.devbank.apiture.com//organization/sorganizations/df9e4d5b-7978-4d63-b1a4-e9a17edaf9a6",
        "name": "Smith's Auto Detailing"
      }
    },
    {
      "name": "printMailForDepositAccounts",
      "label": "Deposit Statements and Tax Documents",
      "providerId": "printMail",
      "ifxTypes": [
        "CDA",
        "DDA",
        "MMA",
        "SDA"
      ],
      "accounts": [
        {
          "uri": "https://api.devbank.apiture.com/accounts/accounts/51593bea-c2ee-4e14-8cc4-c01072e919af",
          "name": "Business Checking - operations",
          "maskedAccountNumber": "2990"
        }
      ],
      "documentTypes": [
        "accountStatement",
        "form1099A"
      ],
      "contexts": [
        "account",
        "organization"
      ],
      "organization": {
        "uri": "https://api.devbank.apiture.com/organizations/organizations/0aa74c0b-28df-4f3e-b413-1ce5fef6fc63",
        "name": "Smith's Pre-Owned"
      }
    }
  ]
}

Document Group Collection (v1.0.2)

An array of document groups in which the user's documents are organized according to the financial institution's configuration of document providers, document types, and document contexts (account, organization, user). The same group name may occur in multiple items, with different document selection criteria. For example, if a user is an authorized signer for two organizations, Smith's Auto Detailing and Smith's Pre-Owned, there may be one group for documents for organization Smith's Auto Detailing, then a similar group with the same document types but for organization Smith's Pre-Owned. The client should use createDocumentProviderParameters for each item in this array to create the UI view for the corresponding documents in each group.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items array: [documentGroup]
An array of all document groups for the current user and their accounts and organizations.
unique items

documentProviderParameter

{
  "name": "widgetUrl",
  "value": "https://statements-widget.example.com/connections/9537b6d4462142afae3f02dd5e19895e"
}

Document Provider Parameter (v1.0.0)

A single name/value parameter that the client passes to the document provider user interface component. This is an element of documentProviderParameters.

Properties

NameDescription
name string (required)
The parameter name.
minLength: 4
maxLength: 32
pattern: ^[a-zA-Z][-a-zA-Z0-9_]{3,31}
value string (required)
The parameter value.
maxLength: 256

documentProviderParameters

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentProviderParameters/v1.0.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "group": {
    "name": "printMailForLoanAccounts",
    "label": "Loan Statements and Tax Documents",
    "providerId": "printMail",
    "ifxTypes": [
      "ILA"
    ],
    "documentTypes": [
      "accountStatement",
      "form1099A"
    ],
    "contexts": [
      "organization"
    ]
  },
  "parameters": [
    {
      "name": "widgetUrl",
      "value": "https://int-widgets.moneydesktop.com/md/connections/qfnp2wzqg9rthAp8tv70fb6pzqZ8v9xfzn3by2k2"
    }
  ]
}

Document Provider Parameters (v1.0.2)

Parameters that the client passes to the document provider user interface component. The set of parameter names is dynamic and not defined by a schema, as providers may be deployed after the API has been deployed.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
group object: documentGroup (required)
The document provider group (one item from the response from getDocumentGroups which defines this document provider component.
parameters array: [documentProviderParameter] (required)
An array of individual document provider parameters.

documentType

{
  "name": "accountStatement",
  "label": "Account Statement",
  "period": "P1M",
  "category": {
    "name": "accountStatements",
    "label": "Account Statements"
  },
  "_profile": "https://production.api.apiture.com/schemas/documents/documentType/v1.0.2/profile.json"
}

Document Type (v1.0.2)

Representation of document type resources.

Properties

NameDescription
name string
The name of this document type. This corresponds to an item in the getDocumentTypes response.
minLength: 4
maxLength: 48
pattern: ^[a-z][a-zA-Z0-9_$]{3,47}$
label string
The human-presentable label of this document category.
period string(period)
The document issue period document for documents issued on a regular periodic basis. For example, account statements are issued monthly (P1M), and tax statements annually (`P1Y'). If empty, the documents are issued on an ad-hoc schedule, such as in response to banking or account activity.
category object: documentCategory
This document type's category.

documentTypes

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documentTypes/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documentTypes"
    }
  },
  "items": [
    {
      "name": "accountStatement",
      "label": "Account Statement",
      "period": "P1M",
      "category": {
        "name": "accountStatements",
        "label": "Account Statements"
      },
      "_profile": "https://production.api.apiture.com/schemas/documents/documentType/v1.0.2/profile.json"
    },
    {
      "name": "form1099Int",
      "label": "Form 1099-INT",
      "period": "P1Y",
      "category": {
        "name": "taxStatements",
        "label": "Tax Statements"
      },
      "_profile": "https://production.api.apiture.com/schemas/documents/documentType/v1.0.2/profile.json"
    }
  ]
}

Document Type Collection (v1.1.3)

An array of document types.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
items array: [documentType]
An array of all document types.

documents

{
  "_profile": "https://production.api.apiture.com/schemas/documents/documents/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/documents/documents?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/documents/documents"
    }
  },
  "name": "documents",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:content": {
            "href": "https://api.devbank.apiture.com/some/expiring/download/location"
          },
          "apiture:account": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/{accountId}"
          }
        },
        "name": "532a0e1b82f592e40803-1099-INT.pdf",
        "label": "1099 INT for Account ******3210 for 2019",
        "typeName": "form1099Int",
        "categoryName": "taxForm",
        "contentType": "application/pdf",
        "startOn": "2020-01-01",
        "endOn": "2020-01-31",
        "createdAt": "2020-02-01T00:01:38.375Z",
        "account": {
          "name": "Personal Savings",
          "title": "John Smith",
          "institutionName": "3rd Party Bank",
          "routingNumber": "021000021",
          "accountNumbers": {
            "masked": "******3210"
          }
        }
      },
      {
        "_id": "83babc98-f0bf-4c14-b7d6-4cb1539e2b47",
        "_profile": "https://production.api.apiture.com/schemas/documents/document/v1.1.3/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/documents/documents/83babc98-f0bf-4c14-b7d6-4cb1539e2b47"
          },
          "apiture:content": {
            "href": "https://api.devbank.apiture.com/some/expiring/download/location"
          },
          "apiture:account": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/{accountId}"
          }
        },
        "name": "532a0e1b82f592e40803-1099-SA.pdf",
        "label": "1099 SA for Account ******3210 for 2019",
        "typeName": "form1099Sa",
        "categoryName": "taxForm",
        "contentType": "application/pdf",
        "startOn": "2020-01-01",
        "endOn": "2020-01-31",
        "createdAt": "2020-02-01T00:01:38.375Z",
        "account": {
          "name": "Personal Savings",
          "title": "John Smith",
          "institutionName": "3rd Party Bank",
          "routingNumber": "021000021",
          "accountNumbers": {
            "masked": "******3210"
          }
        }
      }
    ]
  }
}

Document Collection (v1.1.2)

Collection of documents. The items in the collection are ordered in the _embedded.items array; the name is documents. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

NameDescription
_links object: 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: documentsEmbeddedObjects
Embedded objects.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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.

documentsEmbeddedObjects

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/documents/summaryDocument/v1.1.2/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:content": {
          "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
        },
        "apiture:account": {
          "documents": "/accounts/accounts/{accountId}"
        }
      },
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "name": "532a0e1b82f592e40803-1099-INT.pdf",
      "label": "1099 INT for Account ******3210 for 2019",
      "contentType": "application/pdf",
      "typeName": "form1099Int",
      "categoryName": "taxForm",
      "startOn": "2020-01-01",
      "endOn": "2020-01-31",
      "createdAt": "2020-02-01T00:01:38.375Z",
      "period": "P1Y",
      "account": {
        "name": "Personal Savings",
        "title": "John Smith",
        "institutionName": "3rd Party Bank",
        "routingNumber": "021000021",
        "accountNumbers": {
          "masked": "******3210"
        }
      }
    }
  ]
}

Documents Embedded Objects (v1.1.2)

Objects embedded in the documents collection.

Properties

NameDescription
items array: [summaryDocument]
An array containing a page of document items.

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

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

NameDescription
message string (required)
A localized message string describing the error condition.
_id string
A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string.
read-only
statusCode integer
The HTTP status code associate with this error.
minimum: 100
maximum: 599
type string
An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt string(date-time)
An RFC 3339 UTC time stamp indicating when the error occurred.
attributes object: 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.
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_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
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only

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

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 namea 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:

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
additionalProperties object: 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/apiName/resourceName/resourceId"
    }
  },
  "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
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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 namesa group of labels within that group.
» additionalProperties object: labelGroup
A map that defines labels for the items in a group. This is a map from each item namea 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 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.
» additionalProperties object: 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
href string(uri) (required)
The URI or URI template for the resource/operation this link refers to.
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.
profile string(uri)
The URI of a profile document, a JSON document which describes the target resource/operation.

{
  "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
additionalProperties object: 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.

localizedLabel

{
  "label": "Limited Liability Corporation",
  "description": "string",
  "language": "en-us",
  "code": "31"
}

Localized Label (v1.1.0)

A localized label and optional description for localizable content defined in this API. This schema is deprecated; use labelItem instead.

This schema was resolved from common/localizedLabel.
deprecated

Properties

NameDescription
label string
A localized label or title which may be used labels or other UI controls which present a value.
description string
A more detailed localized description of a localizable label.
language string
The actual natural language tag to which this localized label is associated, as per RFC 7231
code string
If the localized value is associated with an external standard, this is a lookup code or key or URI for that value.

localizedLabels

{
  "property1": {
    "label": "Limited Liability Corporation",
    "description": "string",
    "language": "en-us",
    "code": "31"
  },
  "property2": {
    "label": "Limited Liability Corporation",
    "description": "string",
    "language": "en-us",
    "code": "31"
  }
}

Localized Labels (v1.1.0)

A map that defines lables for an enumeration or other item in a JSON schema. This is a map which maps enumeration schema names to an localizedLabel object. This schema is deprecated. Use labelGroups` instead.

This schema was resolved from common/localizedLabels.
deprecated

Properties

NameDescription
additionalProperties object: localizedLabel
A localized label and optional description for localizable content defined in this API. This schema is deprecated; use labelItem instead.

This schema was resolved from common/localizedLabel.
deprecated

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "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
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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.

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

summaryDocument

{
  "_profile": "https://production.api.apiture.com/schemas/documents/summaryDocument/v1.1.2/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:content": {
      "href": "https://api.devbank.apiture.com/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
    },
    "apiture:account": {
      "documents": "/accounts/accounts/{accountId}"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "532a0e1b82f592e40803-1099-INT.pdf",
  "label": "1099 INT for Account ******3210 for 2019",
  "contentType": "application/pdf",
  "typeName": "form1099Int",
  "categoryName": "taxForm",
  "startOn": "2020-01-01",
  "endOn": "2020-01-31",
  "createdAt": "2020-02-01T00:01:38.375Z",
  "period": "P1Y",
  "account": {
    "name": "Personal Savings",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "******3210"
    }
  }
}

Document Summary (v1.1.2)

Summary representation of a document resource in documents 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 object also contains a link (apiture:content) to the downloadable document, typically PDF.

Properties

NameDescription
_links object: links
An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

_embedded object
An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
name string
The document name.
read-only
label string
A more descriptive label for the document.
read-only
typeName string
The name of the document type
read-only
categoryName string
The name of the document category.
read-only
contentType string
The media type for this file. This is document/pdf (Portable Document Format) for most document types. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
read-only
startOn string(date)
The inclusive beginning date in RFC 3339 YYYY-MM-DD format for this document. For example, for statements or other recurring documents, this is the beginning of the statement period. The document type indicates if the the document is recurring/periodical.
read-only
endOn string(date)
The inclusive end date in RFC 3339 YYYY-MM-DD format for this document. For example, for statements or other recurring documents, this is the end of the statement period. The document type indicates if the the document is recurring/periodical.
read-only
createdAt string(date-time)
The date-time of the document's creation, in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ format.
account object: accountIdentification
Identifying attributes of the account that this document pertains to. If omitted, the document is not associated with an account.
read-only
_id string
The unique identifier for this document resource. This is an immutable opaque string.
read-only