Documents v0.2.1

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 :

• account statements
• agreements
• notices
• user documents or organization documents not associated with specific accounts, such as tax documents.

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

• the start and end date
• a start or end date and a period, such as statements for the first 6 months of a year
• an end date and a period, such as statements for the last 6 months.

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.

Download OpenAPI Definition (YAML)

Base URLs:

• /documents

Terms of service

Email: Apiture Web: Apiture

Authentication

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

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

Scope	Scope Description
banking/read	Read access to accounts and account-related resources such as transfers and transactions.
banking/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 /documents/documents \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /documents/documents HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/documents',
  method: 'get',

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

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

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

};

fetch('/documents/documents',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/documents', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

Parameter	Description
start (query)	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.
limit (query)	integer(int32) The maximum number of document representations to return in this page. Default: 100
account (query)	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
startOn (query)	string(date) The start date of the query range. May be combined with endOn or period but not both.
endOn (query)	string(date) The end date of the query range. May be combined with endOn or period but not both.
period (query)	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 (query)	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
category (query)	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
filter (query)	string Optional filter criteria. See filtering. This collection may be filtered by 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://api.apiture.com/schemas/documents/documents/v1.0.1/profile.json",
  "name": "documents",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_links": {
    "self": {
      "href": "/documents/documents?start=10&limit=10"
    },
    "first": {
      "href": "/documents/documents?start=0&limit=10"
    },
    "next": {
      "href": "/documents/documents?start=20&limit=10"
    },
    "collection": {
      "href": "/documents/documents"
    }
  },
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:content": {
              "href": "/some/expiring/download/location"
            },
            "apiture:account": {
              "href": "/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://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/documents/documents/83babc98-f0bf-4c14-b7d6-4cb1539e2b47"
            },
            "apiture:content": {
              "href": "/some/expiring/download/location"
            },
            "apiture:account": {
              "href": "/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

getDocument

Code samples

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

GET /documents/documents/{documentId} HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/documents/{documentId}',
  method: 'get',

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

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

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

};

fetch('/documents/documents/{documentId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/documents/documents/{documentId}',
  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('/documents/documents/{documentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/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

Parameter	Description
documentId (path)	string (required) The unique identifier of this document. This is an opaque string.
unmasked (query)	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.

Try It

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:content": {
      "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
    },
    "apiture:account": {
      "href": "/accounts/account/100a6159-7811-4986-b1df-99555b059757"
    }
  },
  "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",
  "type": {
    "name": "accountStatement",
    "label": "Account Statement",
    "period": "P1M",
    "category": {
      "name": "accountStatements",
      "label": "Account Statements"
    }
  },
  "account": {
    "name": "Personal Savings",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "******3210"
    }
  }
}

Responses

Response Headers

Status	Description
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 /documents/documents/{documentId}/content \
  -H 'Accept: */*' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /documents/documents/{documentId}/content HTTP/1.1

Accept: */*

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

};

$.ajax({
  url: '/documents/documents/{documentId}/content',
  method: 'get',

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

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

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

};

fetch('/documents/documents/{documentId}/content',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/documents/{documentId}/content', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

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

Try It

Example responses

200 Response

"string"

Responses

Response Headers

Status	Description
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 /documents/statements \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /documents/statements HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/statements',
  method: 'get',

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

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

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

};

fetch('/documents/statements',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/statements', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

Parameter	Description
start (query)	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.
limit (query)	integer(int32) The maximum number of statement representations to return in this page. Default: 100
accounts (query)	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
startOn (query)	string(date) The start date of the query range. May be combined with endOn or period but not both.
endOn (query)	string(date) The end date of the query range. May be combined with endOn or period but not both.
period (query)	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 (query)	string Optional filter criteria. See filtering. This collection may be filtered by 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://api.apiture.com/schemas/documents/documents/v1.0.1/profile.json",
  "name": "documents",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_links": {
    "self": {
      "href": "/documents/documents?start=10&limit=10"
    },
    "first": {
      "href": "/documents/documents?start=0&limit=10"
    },
    "next": {
      "href": "/documents/documents?start=20&limit=10"
    },
    "collection": {
      "href": "/documents/documents"
    }
  },
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:content": {
              "href": "/some/expiring/download/location"
            },
            "apiture:account": {
              "href": "/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://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/documents/documents/83babc98-f0bf-4c14-b7d6-4cb1539e2b47"
            },
            "apiture:content": {
              "href": "/some/expiring/download/location"
            },
            "apiture:account": {
              "href": "/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

Document Types

Documents Types

getDocumentTypes

Code samples

# You can also use wget
curl -X GET /documents/documentTypes \
  -H 'Accept: application/hal+json'

GET /documents/documentTypes HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/documents/documentTypes',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/documents/documentTypes',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/documents/documentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/documents/documentTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/documents/documentTypes", data)
    req.Header = headers

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

Return a list of document types

GET /documentTypes

Return a list of document types.

Try It

Example responses

200 Response

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

Responses

Document Categories

Documents Cateories

getDocumentCategories

Code samples

# You can also use wget
curl -X GET /documents/documentCategories \
  -H 'Accept: application/hal+json'

GET /documents/documentCategories HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/documents/documentCategories',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json'

};

fetch('/documents/documentCategories',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/documents/documentCategories',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/documents/documentCategories', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/documents/documentCategories", data)
    req.Header = headers

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

Return a list of document categories

GET /documentCategories

Return a list of document categories.

Try It

Example responses

200 Response

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

Responses

Configuration

Documents Service Configuration

getConfigurationGroups

Code samples

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

GET /documents/configurations/groups HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/configurations/groups',
  method: 'get',

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

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

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

};

fetch('/documents/configurations/groups',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/configurations/groups', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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.0.1/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_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"
    }
  },
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.1/profile.json",
          "_links": {
            "self": {
              "href": "/configurations/groups/basic"
            }
          },
          "name": "basic",
          "label": "Basic Settings",
          "description": "The basic settings for the Transfers API"
        },
        {
          "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.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

getConfigurationGroup

Code samples

# You can also use wget
curl -X GET /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 /documents/configurations/groups/{groupName} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: '/documents/configurations/groups/{groupName}',
  method: 'get',

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

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

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

};

fetch('/documents/configurations/groups/{groupName}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/configurations/groups/{groupName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

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

Try It

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.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": "17:30:00"
  }
}

Responses

Response Headers

Status	Description
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 /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 /documents/configurations/groups/{groupName}/schema HTTP/1.1

Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: '/documents/configurations/groups/{groupName}/schema',
  method: 'get',

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

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

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

};

fetch('/documents/configurations/groups/{groupName}/schema',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/configurations/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

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

Try It

Example responses

200 Response

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

Responses

Response Headers

Status	Description
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 /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 /documents/configurations/groups/{groupName}/values HTTP/1.1

Accept: application/hal+json
If-None-Match: string

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

};

$.ajax({
  url: '/documents/configurations/groups/{groupName}/values',
  method: 'get',

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

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

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

};

fetch('/documents/configurations/groups/{groupName}/values',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

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

Try It

Example responses

200 Response

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

Responses

Response Headers

Status	Description
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 /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 /documents/configurations/groups/{groupName}/values HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

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

};

$.ajax({
  url: '/documents/configurations/groups/{groupName}/values',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/documents/configurations/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.put '/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('/documents/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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": "17:30:00"
}

Parameters

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

Try It

Example responses

200 Response

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

Responses

Response Headers

Status	Description
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 /documents/configurations/groups/{groupName}/values/{valueName} \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /documents/configurations/groups/{groupName}/values/{valueName} HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/configurations/groups/{groupName}/values/{valueName}',
  method: 'get',

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

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

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

};

fetch('/documents/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

• a primitive number, boolean, or quoted JSON string.
• a JSON array.
• a JSON object.
• null. Examples:
• "a string configuration value"
• 120
• true
• null
• { "borderWidth": 8, "foregroundColor": "blue" } To update a specific value, use PUT /documents/configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

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

Try It

Example responses

200 Response

"string"

Responses

Response Headers

Status	Description
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 /documents/configurations/groups/{groupName}/values/{valueName} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT /documents/configurations/groups/{groupName}/values/{valueName} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/configurations/groups/{groupName}/values/{valueName}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/documents/configurations/groups/{groupName}/values/{valueName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

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

result = RestClient.put '/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',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/documents/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/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

• a primitive number, boolean, or quoted JSON string.
• a JSON array.
• a JSON object.
• null. Examples:
• "a string configuration value"
• 120
• true
• null
• { "borderWidth": 8, "foregroundColor": "blue" } To fetch specific value, use GET /documents/configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

Parameter	Description
groupName (path)	string (required) The unique name of this configuration group.
valueName (path)	string (required) The unique name of a value in a configuration group. This is the name of the value in the schema. A {valueName} must be a simple identifier following the pattern letter [letter | digit | '-' | '_']*
body (body)	string (required) The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Try It

Example responses

200 Response

"string"

Responses

Response Headers

Status	Description
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 /documents/labels \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'

GET /documents/labels HTTP/1.1

Accept: application/hal+json
Accept-Language: string

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

};

$.ajax({
  url: '/documents/labels',
  method: 'get',

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

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

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

};

fetch('/documents/labels',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/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('/documents/labels', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

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

Try It

Example responses

200 Response

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

Responses

getApi

Code samples

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

GET /documents/ HTTP/1.1

Accept: application/hal+json

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

};

$.ajax({
  url: '/documents/',
  method: 'get',

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

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

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

};

fetch('/documents/',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/documents/',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/documents/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.1/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /documents/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET /documents/apiDoc HTTP/1.1

Accept: application/json

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

};

$.ajax({
  url: '/documents/apiDoc',
  method: 'get',

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

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

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

};

fetch('/documents/apiDoc',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/documents/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/documents/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/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", "/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

Response Schema

Schemas

abstractRequest

{
  "_profile": "{uri of resource profile.json}",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

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.

Properties

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

abstractResource

{
  "_profile": "{uri of resource profile.json}",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Resource (v2.0.0)

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

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.

accountIdentification

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

Account Identification (v1.0.0)

Properties which identify a specific account.

Properties

Name	Description
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	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.0)

Different representations of an account number.

Properties

Name	Description
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

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

Properties

attributes

{
  "property1": {},
  "property2": {}
}

Attributes (v2.0.0)

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

Properties

Name	Description
additionalProperties	attributeValue The data associated with this attribute.

collection

{
  "_links": {
    "property1": {
      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Applicant"
    },
    "property2": {
      "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
      "title": "Applicant"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_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"
      }
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection (v2.0.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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://api.apiture.com/schemas/configurations/configurationGroup/v2.0.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": "17:30:00"
  }
}

Configuration Group (v2.0.1)

Represents a configuration group.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
name	string The name of this configuration group, must be unique within the set of all resources of this type. minLength: 1 maxLength: 48 pattern: [a-zA-Z][-\w_]*
label	string The text label for this resource, suitable for presentation to the client. minLength: 1 maxLength: 128
description	string The full description for this resource, suitable for presentation to the client. minLength: 1 maxLength: 4096
schema	configurationSchema The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*. This is implicitly a schema for type: object and contains the properties. The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.
values	configurationValues The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema. Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

configurationGroupSummary

{
  "_profile": "https://api.apiture.com/schemas/configurations/configurationGroupSummary/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API"
}

Configuration Group Summary (v2.0.0)

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

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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.0.1/profile.json",
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_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"
    }
  },
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.1/profile.json",
          "_links": {
            "self": {
              "href": "/configurations/groups/basic"
            }
          },
          "name": "basic",
          "label": "Basic Settings",
          "description": "The basic settings for the Transfers API"
        },
        {
          "_profile": "https://api.apiture.com/schemas/configurations/configurationGroup/v2.0.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.0.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).

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	configurationGroupsEmbedded Embedded objects.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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://api.apiture.com/schemas/configurations/configurationGroupSummary/v2.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/configurations/groups/basic"
        }
      },
      "name": "basic",
      "label": "Basic Settings",
      "description": "The basic settings for the Transfers API"
    }
  ]
}

Configuration Groups Embedded Objects (v1.0.0)

Objects embedded in the configurationGroupscollection.

Properties

Name	Description
items	[configurationGroupSummary] An array containing a page of configuration group items.

configurationSchema

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

Configuration Schema

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.

Properties

Name	Description
additionalProperties	configurationSchemaValue The data associated with this configuration schema.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

Properties

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

Properties

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": "17:30:00"
}

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.

Properties

Name	Description
additionalProperties	configurationValue The data associated with this configuration.

document

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:content": {
      "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
    },
    "apiture:account": {
      "href": "/accounts/account/100a6159-7811-4986-b1df-99555b059757"
    }
  },
  "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",
  "type": {
    "name": "accountStatement",
    "label": "Account Statement",
    "period": "P1M",
    "category": {
      "name": "accountStatements",
      "label": "Account Statements"
    }
  },
  "account": {
    "name": "Personal Savings",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "******3210"
    }
  }
}

Document (v1.0.0)

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.

Links

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

Rel	Summary	Method
self	Fetch a representation of this document	GET
apiture:content	Return the raw content of the document	GET
apiture:account	Account associated with this document	GET
apiture:user	User associated with this document	GET
apiture:organization	Organization associated with this document	GET

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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	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	documentType The document type, which also includes the document's category.

documentCategories

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

Document Categories (v1.0.0)

Array of document categories.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
items	[documentCategory] An array containing document category items.

documentCategory

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

Document Category (v1.0.0)

Representation of document category resources.

Properties

Name	Description
name	string The name of this document category. This is an identifier. This corresponds to an item in the getDocumentCategories response. pattern: ^[a-z][a-zA-Z0-9_$]{1,48}$
label	string The human-presentable label of this document category.
context	documentContext The type of resource that documents in this category are associated with.

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:

Value	Description
account	Account: The document is associated with the account referenced by the apiture:account link.
organization	organization: The document is associated with an organization referenced by the apiture:organization link.
user	Account: 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
Enumerated values:
account
organization
user

documentType

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

Document Type (v1.0.0)

Representation of document type resources.

Properties

Name	Description
name	string The name of this document type. This corresponds to an item in the getDocumentTypes response. pattern: ^[a-z][a-zA-Z0-9_$]{1,48}$
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	documentCategory This document type's category.

documentTypes

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

Document Type Collection (v1.0.1)

An array of document types.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
items	[documentType] An array containing a page of document type items.

documents

{
  "_profile": "https://api.apiture.com/schemas/documents/documents/v1.0.1/profile.json",
  "name": "documents",
  "start": 10,
  "limit": 10,
  "count": 67,
  "_links": {
    "self": {
      "href": "/documents/documents?start=10&limit=10"
    },
    "first": {
      "href": "/documents/documents?start=0&limit=10"
    },
    "next": {
      "href": "/documents/documents?start=20&limit=10"
    },
    "collection": {
      "href": "/documents/documents"
    }
  },
  "_embedded": {
    "items": {
      "anyOf": [
        {
          "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
          "_profile": "https://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
            },
            "apiture:content": {
              "href": "/some/expiring/download/location"
            },
            "apiture:account": {
              "href": "/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://api.apiture.com/schemas/documents/document/v1.0.0/profile.json",
          "_links": {
            "self": {
              "href": "/documents/documents/83babc98-f0bf-4c14-b7d6-4cb1539e2b47"
            },
            "apiture:content": {
              "href": "/some/expiring/download/location"
            },
            "apiture:account": {
              "href": "/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.0.1)

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

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	documentsEmbeddedObjects Embedded objects.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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": [
    {
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "_profile": "https://api.apiture.com/schemas/documents/summaryDocument/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:content": {
          "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
        },
        "apiture:account": {
          "documents": "/accounts/accounts/{accountId}"
        }
      },
      "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.0.0)

Objects embedded in the documents collection.

Properties

Name	Description
items	[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.0.0)

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

Properties

Name	Description
message	string (required) A localized message string describing the error condition.
_id	string A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string. read-only
statusCode	integer The HTTP status code associate with this error. minimum: 100 maximum: 599
type	string An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt	string(date-time) An RFC 3339 UTC time stamp indicating when the error occurred.
attributes	attributes Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type.
remediation	string An optional localized string which provides hints for how the user or client can resolve the error.
errors	[error] An optional array of nested error objects. This property is not always present.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.0.0)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.

link

{
  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Applicant"
}

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.

Properties

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

links

{
  "property1": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  },
  "property2": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  }
}

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.

Properties

Name	Description
additionalProperties	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.

localizedLabel

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

Localized Label (v1.0.0)

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

Properties

Name	Description
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.0.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.

Properties

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

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.1/profile.json",
  "_links": {}
}

API Root (v2.0.1)

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

Properties

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
_id	string This API's unique ID. read-only
name	string This API's name.
apiVersion	string This API's version.

summaryDocument

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/documents/summaryDocument/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:content": {
      "href": "/documents/documents/0399abed-fd3d-4830-a88b-30f38b8a365c/content"
    },
    "apiture:account": {
      "documents": "/accounts/accounts/{accountId}"
    }
  },
  "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.0.0)

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

Name	Description
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_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.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
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	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