Check Deposits v0.13.0

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

The Check Deposits API allows bank customers to use their mobile or web applications to take photographs or scans of endorsed paper checks and submit them for deposit into an existing account.

A check deposit is a batch of one or more checks to be deposited to an account.

To deposit checks, a user can create a check deposit resource and add check resources to it. The apiture:uploadFrontImage and apiture:uploadBackImage links found on a check can be used to upload JPEG formatted check images. After a check is created and front and back images uploaded, the check must be processed to determine if it is eligible to submit. A check can be processed asyncronously using the apiture:process link on the check resource, or all checks with pending state in a check deposit can be processed asyncronously by using the apiture:process link on the check deposit resource. When processing completes, each check may contain risk warnings, risk errors, or risk rejections.

• riskWarnings are not required to be resolved, but may be useful to resolve potential issues.
• riskErrors must be resolved in order to submit the check deposit. Errors may be fixed by reuploading images or correcting check data.
• riskRejections indicate the check is not suitable for deposit, and the check must be removed from the check deposit.

All checks in a check deposit must finish processing with valid state in order to submit the check deposit.

The Check Deposit state may be one of the following:

• pending In creation, not yet submitted for deposit. The user can add checks and make modifications to the check deposit.
• processing One or more checks in the check deposit are processing.
• valid The check deposit is eligible to submit.
• invalid The check deposit is not eligible to submit. It has one or more checks that must be corrected.
• submitted Submitted and is awaiting FI (Financial Institution) judgement. A submitted check deposit is read only.
• accepted All checks were accepted by the FI and processed for deposit. An accepted check deposit is read only.
• acceptedAdjustedDown All checks were accepted by the FI and processed for deposit with an amount that was adjusted down. An acceptedAdjustedDown check deposit is read only.
• acceptedAdjustedUp All checks were accepted by the FI and processed for deposit with an amount that was adjusted up. An acceptedAdjustedUp check deposit is read only.
• rejected All checks were rejected by the FI and not processed for deposit. A rejected check deposit is read only.
• acceptedWithRejections One or more checks in the check deposit were accepted for deposit, but one or more were rejected. An acceptedWithRejections check deposit is read only.

The Check state may be one of the following:

• pending In creation, not submitted yet.
• processing Uploaded, awaiting image processing.
• valid Check has finished processing and is eligible to submit. The check may contain warnings.
• invalid Check has finished processing and is not eligible to submit. It has one or more errors that must be corrected before becoming eligible to submit.
• submitted Check was submitted and is awaiting FI judgement before deposit. A submitted check is read only.
• accepted Check was accepted by the FI and deposited. Terminal. An accepted check is read only.
• acceptedAdjustedDown Check was accepted by the FI and deposited with the amount adjusted down. Terminal. An acceptedAdjustedDown check is read only.
• acceptedAdjustedUp Check was accepted by the FI and deposited with the amount adjusted up. Terminal. An acceptedAdjustedUp check is read only.
• rejected Check was rejected by the FI and not deposited. Terminal. A rejected check is read only.

If a check deposit is eligible to submit, the apiture:submit link can be used to submit the batch of checks for deposit. The checks are reviewed by the FI, either through an automated system or an admin. If the FI accepts a check, it is deposited and set to accepted state. If the FI rejects a check, it is not deposited and is set to rejected state.

Error Types

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

checkImageNotFound

Description: No image was found for the specified checkId and image type.
Remediation: Check to make sure the check image has completed uploading and/or processing.

emptyRequestBody

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

groupNotFound

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

inProgressCheckDeposit

Description: The user has a check deposit in progress and is not allowed to create another.
Remediation: Submit or cancel the existing check deposit and try again.

invalidAccount

Description: The supplied account reference was malformed.
Remediation: Check to make sure that the supplied account parameter corresponds to an Apiture account resource.

invalidCheckDepositState

Description: Actions on check deposits may only be performed if they are in a valid state.
Remediation: Check the state of the check deposit and the allowable states for the requested operation.

invalidCheckId

Description: No Checks were found for the specified checkId.
Remediation: Check to make sure that the supplied checkId corresponds to an apiture check resource.

invalidCheckState

Description: Actions on checks may only be performed if they are in a valid state.
Remediation: Check the state of the check and the allowable states for the requested operation.

invalidChecks

Description: One or more checks are invalid to perform the requested operation.
Remediation: Verify all of the checks are valid and do not contain errors.

invalidDepositId

Description: No Deposits were found for the specified depositId.
Remediation: Check to make sure that the supplied depositId corresponds to an apiture deposit resource.

valueNotFound

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

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/checkDeposits

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each thing 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 things
banking/write	Write (update) access to things
banking/delete	Delete access to things
banking/full	Full access to things

Check Deposits

Deposit checks into a Bank Account

getCheckDeposits

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of check deposits

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits

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

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first check deposit item to include in this page. The default 0 denotes the beginning of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of check deposit representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2. This collection may be sorted by the following properties: • state • createdAt.
state in: query	string Subset of the check deposit collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending matches only items whose state is pending; ?state=pending|submitted matches items whose state is pending or submitted. This is combined with an implicit and with other filters if they are used. See filtering. enum values: pending, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected, acceptedWithRejections
filter in: query	string Optional filter criteria. See filtering. This collection may be filtered by the following properties and functions: • Property state using functions eq, ne, in • Property createdAt using functions eq, ne, in.
q in: query	string Optional search string. See searching.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposits/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits?start=0&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits?start=10&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits"
    }
  },
  "start": 0,
  "limit": 10,
  "count": 1,
  "name": "check deposits",
  "_embedded": {
    "items": [
      {
        "_id": "f6c321e6-419a",
        "_profile": "https://production.api.apiture.com/schemas/checkDeposits/summaryCheckDeposit/v1.2.1/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
          },
          "apiture:target": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          }
        },
        "state": "pending",
        "createdAt": "2019-01-20T05:54:52.375Z",
        "description": "bake sale checks",
        "enteredAmount": "103.22",
        "checkCount": 3
      }
    ]
  }
}

Responses

createCheckDeposit

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/createCheckDeposit/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "enteredAmount": "215.10",
  "description": "bake sale checks",
  "device": {
    "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
    "type": "iPhone",
    "operatingSystem": "iOS",
    "operatingSystemVersion": "13.2.1",
    "make": "Apple",
    "model": "iPhoneXs"
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Create a new check deposit

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits

Create a new check deposit to add checks and submit a deposit. A check deposit must be used to submit a deposit, individual check resources can't be submitted.

The new check deposit representation contains the eligible target accounts in _embedded.eligibleAccounts.

The apiture:target link specifies the account resource where the check deposit is deposited. The user can provide an optional enteredAmount when creating a check deposit. This is the expected total batch amount of all checks, and can be used as verification against the check amounts later scanned by OCR (optical character recognition).

Device data may be provided to identify the client device and aid the deposit verification process. It is recommended to provide as much device data as possible.

After creating a check deposit, use the createCheck operation (the apiture:createCheck link) to add checks to it, then use the processCheckDeposit operation (the apiture:process link) to process the checks to verify the check contents. If all the checks are valid, follow that with the submitCheckDeposit (the apiture:process link) operation to submit the valid checks for deposit.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/createCheckDeposit/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "enteredAmount": "215.10",
  "description": "bake sale checks",
  "device": {
    "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
    "type": "iPhone",
    "operatingSystem": "iOS",
    "operatingSystemVersion": "13.2.1",
    "make": "Apple",
    "model": "iPhoneXs"
  }
}

Parameters

Parameter	Description
continueSession in: query	boolean If true, the service will attempt to reuse the user's check deposit provider session. default: false
body	createCheckDeposit (required) The data necessary to create a new check deposit.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Responses

getCheckDeposit

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}',
{
  method: 'GET',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a check deposit

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}

Return a HAL representation of this check deposit resource.

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Responses

patchCheckDeposit

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Modify this check deposit resource

PATCH https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}

Modify this check deposit. The apiture:target link, description, and enteredAmount are the only editable fields. The check deposit must have state pending, processing, valid, or invalid.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Parameters

Parameter	Description
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
body	checkDeposit (required) The data necessary to update the check deposit, the apiture:target link, description, and enteredAmount are the only editable fields.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Responses

deleteCheckDeposit

Code samples

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

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

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}',
{
  method: 'DELETE',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Delete this check deposit resource

DELETE https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}

Delete this check deposit resource and any resources that are owned by it. This operation deletes any checks included in the check deposit. The check deposit must have state pending, processing, valid, or invalid.

Parameters

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

Example responses

404 Response

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

Responses

submitCheckDeposit

Code samples

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

POST https://api.devbank.apiture.com/checkDeposits/submittedCheckDeposits HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/submittedCheckDeposits',
{
  method: 'POST',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Submit a check deposit

POST https://api.devbank.apiture.com/checkDeposits/submittedCheckDeposits

Submit a check deposit that is eligible to be submitted. This operation is invoked from the apiture:submit link on a check deposit, which only exists if the action is allowed. If successful, this changes the state to submitted.

The apiture:target link in the referenced check deposit must be a valid account resource URI; it names the account where the checks are deposited. A check deposit can only be submitted to a single target account.

Parameters

Parameter	Description
depositId in: query	string The unique identifier of this deposit. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Responses

processCheckDeposit

Code samples

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

POST https://api.devbank.apiture.com/checkDeposits/processedCheckDeposits HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/processedCheckDeposits',
{
  method: 'POST',

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Process checks in a check deposit

POST https://api.devbank.apiture.com/checkDeposits/processedCheckDeposits

Process all checks in a check deposit which have state pending.

This operation is invoked from the apiture:process link on a check deposit. All checks with pending state on the check deposit are processed asyncronously. Checks which are currently being processed or have finished processing with state valid or invalid are ignored.

If any checks have not been processed yet, this returns 202 Accepted and no response body. The response includes a Retry-After response header with a recommended retry interval in seconds. If all checks have finished processing, the operations returns 200 OK and the response body is the updated check deposit resource.

Parameters

Parameter	Description
depositId in: query	string The unique identifier of this deposit. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Responses

Checks

Checks included in a Check Deposit batch

createCheck

Code samples

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

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "enteredAmount": "43.11",
  "description": "from jim",
  "device": {
    "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
    "type": "iPhone",
    "operatingSystem": "iOS",
    "operatingSystemVersion": "13.2.1",
    "make": "Apple",
    "model": "iPhoneXs"
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Add a check to the check deposit batch

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks

Create a new check in the check deposit. A check must reside inside a check deposit resource. Checks can only be added to check deposits that have state pending, processing, valid, or invalid. Device data may be provided to identify the client device. The device data for each check may be compared to the device data for other checks or the parent check deposit to aid verification. It is recommended to provide as much device data as possible.

The check in the response body includes apiture:uploadFrontImage and apiture:uploadBackImage links which the client should use to upload check images. Images must be uploaded in JPEG format.

After images have been successfully uploaded, apiture:frontImageContent and apiture:backImageContent links can be used to download image contents.

A check must be processed by using the apiture:process link before it can be submitted. The check must have successfully uploaded front and back images in order to be processed.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "enteredAmount": "43.11",
  "description": "from jim",
  "device": {
    "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
    "type": "iPhone",
    "operatingSystem": "iOS",
    "operatingSystemVersion": "13.2.1",
    "make": "Apple",
    "model": "iPhoneXs"
  }
}

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
body	createCheck (required) The data necessary to create a new check.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Responses

getCheck

Code samples

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

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a check

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}

Fetch a HAL representation of this check resource.

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: path	string (required) The unique identifier of this check. This is an opaque string.
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Responses

patchCheck

Code samples

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

PATCH https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
  method: 'patch',

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

require 'rest-client'
require 'json'

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

result = RestClient.patch 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.patch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Modify a check in the deposit

PATCH https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}

Modify check data. enteredAmount and description are the only editable fields.

Checks may not be modified if they have state submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, or rejected.

If a check has state processing, valid, or invalid, modifying the check enteredAmount invalidates the image analysis, resets the check to pending, and must be processed again.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: path	string (required) The unique identifier of this check. This is an opaque string.
If-Match in: header	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body	check (required) The data to modify a check

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Responses

deleteCheck

Code samples

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

DELETE https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
{
  method: 'DELETE',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
  method: 'delete',

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

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.delete('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Remove a check from the check deposit

DELETE https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}

Removes the check from the check deposit batch. Checks may not be deleted if they have state submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, or rejected.

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: path	string (required) The unique identifier of this check. This is an opaque string.

Example responses

404 Response

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

Responses

getCheckImage

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side} \
  -H 'Accept: */*' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side} HTTP/1.1
Host: api.devbank.apiture.com
Accept: */*
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}");
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{"*/*"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return the check side image metadata

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}

Return metadata of the image file. Valid check side values:

• front
• back

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: path	string (required) The unique identifier of this check. This is an opaque string.
side in: path	string (required) The side of the check. Valid check side values: front back
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

404 Response

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

Responses

createCheckImageUpload

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side} \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}',
{
  method: 'POST',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}',
  method: 'post',

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}", data)
    req.Header = headers

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

Create a new upload uri for the check side image

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}

Create a new upload uri for the check side image. This operation is used if the client needs to replace an uploaded image side, it is not needed for new checks. Upload uris may not be issued if the check has state submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, or rejected. The response body includes a apiture:uploadUri link which is used to POST the file content and upload an image. This replaces any existing image. The Content-Type header (or the Content-Type in the multipart form data) must match the contentType of the file resource. JPEG is the only supported image format.

If a check has state processing, valid, or invalid, creating a new image upload uri invalidates the image analysis, resets the check to pending, and the check must be processed again. Valid check side values:

• front
• back

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: path	string (required) The unique identifier of this check. This is an opaque string.
side in: path	string (required) The side of the check. Valid check side values: front back

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkImage/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:content": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "frontImage.jpeg",
  "contentType": "image/jpeg",
  "description": "Front check image captured and uploaded from an iPhoneX.",
  "sizeBytes": 112800,
  "createdAt": "2019-01-04T07:00:49.375Z"
}

Responses

getCheckImageContent

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content \
  -H 'Accept: */*' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content HTTP/1.1
Host: api.devbank.apiture.com
Accept: */*
If-None-Match: string

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content',
  method: 'get',

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/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{"*/*"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content", data)
    req.Header = headers

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

Return the raw content of the check image side

GET https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/{side}/content

Return the raw content of the image file 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. Valid check side values:

• front
• back

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: path	string (required) The unique identifier of this check. This is an opaque string.
side in: path	string (required) The side of the check. Valid check side values: front back
If-None-Match in: header	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET returns 304 (Not Modified) and no response body, else the resource representation is returned.

Example responses

200 Response

404 Response

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

Responses

processCheck

Code samples

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

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/processedChecks?checkId=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/processedChecks?checkId=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/processedChecks',
  params: {
  'checkId' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/processedChecks', params={
  'checkId': 'string'
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Process a check

POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/processedChecks

Process a Check to validate data, perform image analysis, and return risk factors. This operation is invoked from the apiture:process link on a check. Each check in a check deposit must be processed before the batch can be submitted. Checks may not be processed if they have state submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, or rejected.

If the check has not been processed, this returns 202 Accepted and no response body. The response includes a Retry-After response header with a recommended retry interval in seconds. If the check has finished processing, the operations returns 200 OK and the response body is the updated check resource.

riskRejections, riskErrors, riskWarnings, and riskInfo may contain risk factors after a check has completed processing. Risk factors include diagnostic information about the check, check images, or end user, which indicate if the check is acceptable for deposit.

• riskWarnings are not required to be resolved, but may be useful to resolve potential issues.
• riskErrors must be resolved in order to submit the check deposit. Errors may be fixed by reuploading images or correcting check data.
• riskRejections indicate the check is not suitable for deposit, and the check must be removed from the check deposit.
• riskInfo includes additional diagnostic information about the check.

If a check has finished processing and contains no risk factors, it indicates the check has a high chance of being accepted for deposit.

Parameters

Parameter	Description
depositId in: path	string (required) The unique identifier of this deposit. This is an opaque string.
checkId in: query	string (required) The unique identifier of this check. This is an opaque string.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Responses

rejectCheck

Code samples

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

POST https://api.devbank.apiture.com/checkDeposits/rejectedChecks?check=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/rejectedChecks?check=string',
{
  method: 'POST',

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

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

};

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkDeposits/rejectedChecks',
  params: {
  'check' => 'string'
}, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/checkDeposits/rejectedChecks', params={
  'check': 'string'
}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Reject a check

POST https://api.devbank.apiture.com/checkDeposits/rejectedChecks

Reject a check if it is eligible to be rejected. This operation is invoked from the apiture:reject link on a check. The link is only be returned for admins, and only admins can reject a check. There is no request body in this method. Rejecting a check also reverses the core transaction.

Parameters

Parameter	Description
check in: query	string (required) A server-generated key which identifies an existing check resource.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Responses

Configuration

Check Deposits Service Configuration

getConfigurationGroups

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return a collection of configuration groups

GET https://api.devbank.apiture.com/checkDeposits/configurations/groups

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

Parameters

Parameter	Description
start in: query	integer(int64) The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection. format: int64 default: 0
limit in: query	integer(int32) The maximum number of configuration group representations to return in this page. format: int32 default: 100
sortBy in: query	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter in: query	string Optional filter criteria. See filtering.
q in: query	string Optional search string. See searching.

Example responses

200 Response

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

Responses

getConfigurationGroup

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a representation of this configuration group

GET https://api.devbank.apiture.com/checkDeposits/configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

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

Example responses

200 Response

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

Responses

getConfigurationGroupSchema

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch the schema for this configuration group

GET https://api.devbank.apiture.com/checkDeposits/configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

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

Example responses

200 Response

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

Responses

getConfigurationGroupValues

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch the values for the specified configuration group

GET https://api.devbank.apiture.com/checkDeposits/configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

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

Example responses

200 Response

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

Responses

updateConfigurationGroupValues

Code samples

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

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

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

};

fetch('https://api.devbank.apiture.com/checkDeposits/configurations/groups/{groupName}/values',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Update the values for the specified configuration group

PUT https://api.devbank.apiture.com/checkDeposits/configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

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

Parameters

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

Example responses

200 Response

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

Responses

getConfigurationGroupValue

Code samples

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

GET https://api.devbank.apiture.com/checkDeposits/configurations/groups/{groupName}/values/{valueName} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Fetch a single value associated with the specified configuration group

GET https://api.devbank.apiture.com/checkDeposits/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 /configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

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

Example responses

200 Response

"string"

Responses

updateConfigurationGroupValue

Code samples

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

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

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

};

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Update a single value associated with the specified configuration group

PUT https://api.devbank.apiture.com/checkDeposits/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 /configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

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

Example responses

200 Response

"string"

Responses

Limits

Limits on the Amount or Number of check Deposits

getLimits

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return the mobile check deposit limits

GET https://api.devbank.apiture.com/checkDeposits/limits

Return the mobile check deposit limits. The response shows the check deposit limits and amounts for the previous 30 days.

Parameters

Parameter	Description
account in: query	string Return check deposit limits for the named account. This is the _id of the account resource. If omitted, the response contains only user limits.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDepositLimits/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "limits": [
    {
      "context": "user",
      "days": 30,
      "checkCounts": {
        "current": 100,
        "remaining": 30
      },
      "checkAmounts": {
        "current": "10000.00",
        "remaining": "2500.00",
        "currency": "USD"
      }
    }
  ]
}

Responses

API

Endpoints which describe this API.

getLabels

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Localized Labels

GET https://api.devbank.apiture.com/checkDeposits/labels

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

Parameters

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "firstGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Responses

getApi

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Top-level resources and operations in this API

GET https://api.devbank.apiture.com/checkDeposits/

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

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

getApiDoc

Code samples

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

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return API definition document

GET https://api.devbank.apiture.com/checkDeposits/apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Schemas

abstractRequest

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

Abstract Request (v2.0.0)

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

This schema was resolved from common/abstractRequest.

Properties

Name	Description
Abstract Request (v2.0.0)	object An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource. This schema was resolved from common/abstractRequest.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri

abstractResource

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

Abstract Resource (v2.1.0)

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

This schema was resolved from common/abstractResource.

Properties

Name	Description
Abstract Resource (v2.1.0)	object An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links. This schema was resolved from common/abstractResource.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

accountIdentification

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

Account Identification (v1.0.1)

Properties which identify a specific account.

This schema was resolved from accounts/accountIdentification.

Properties

Name	Description
Account Identification (v1.0.1)	object Properties which identify a specific account. This schema was resolved from accounts/accountIdentification.
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.1)

Different representations of an account number.

This schema was resolved from common/accountNumbers.

Properties

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

attributes

{}

Attributes (v2.1.0)

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

This schema was resolved from common/attributes.

Properties

Name	Description
Attributes (v2.1.0)	object An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from common/attributes. Additional Properties: true

balance

{
  "current": "3450.30",
  "available": "2850.30",
  "hold": "500.00",
  "reserve": "100.00",
  "currency": "USD",
  "primary": "3450.30",
  "primaryLabel": "Current Balance",
  "primaryDescription": "Current balance includes deposits that have posted but are not yet available. Pending debits are not deducted from this amount."
}

Account Balance (v1.2.0)

The balance of the account. This is derived data and not mutable through the API. Balances may be negative, indicating a deficit or loan balance.

This schema was resolved from accounts/balance.

Properties

Name	Description
Account Balance (v1.2.0)	object The balance of the account. This is derived data and not mutable through the API. Balances may be negative, indicating a deficit or loan balance. This schema was resolved from accounts/balance.
current	string The current balance is the available balance plus all pending credits and minus all pending debits. read-only
available	string The string representation of the exact decimal available balance. For deposit accounts, this reflects the amount that may be used for withdrawals or transfers. This field does not apply to debit accounts such as loans. read-only
hold	string The hold balance is the total amount of funds held due to holds placed on individual transactions. Transaction holds reduce the available balance until expiration. read-only
reserve	string A reserve balance is the amount placed on hold by the financial institution. A reserve balance reduces the available balance. read-only
pendingCredits	string The string representation of the total of all pending credits against this account. This contributes to the current balance but not the available balance. read-only
pendingDebits	string The string representation of the total of all pending debits against this account. This contributes to the current balance but not the available balance. read-only
original	string For loan accounts, this is the original loan amount. This property is not set for deposit accounts. read-only
primary	string The balance that the financial institution has configured as the primary balance. For deposit accounts, this is normally mapped to the current or available balance. For loan accounts, the primary balance is normally the current, available, or original balance. This may also be the value of a custom field. (The value is set by the service based on the primaryBalanceProperties configuration group.) read-only
primaryLabel	string The label for the primary balance, derived from the primary balance configuration. This may be localized based on the Accept-Language request header. read-only
primaryLabelDescription	string The more detailed description of the primary balance, derived from the primary balance configuration. This may be localized based on the Accept-Language request header. read-only
currency	string The ISO 4217 currency code for this balance. read-only

cd

{
  "maturesAt": "2019-10-30T08:16:00.000Z",
  "apyBumpedAt": "2019-10-30T08:16:00.000Z",
  "term": "P6M",
  "maturityPolicy": "transferPrincipalAndInterest",
  "transferAccount": {
    "name": "My Premiere Savings",
    "title": "John Smith",
    "institutionName": "3rd Party Bank",
    "routingNumber": "021000021",
    "accountNumbers": {
      "masked": "*************3210",
      "full": "9876543210"
    }
  },
  "inDebitGracePeriod": true,
  "inCreditGracePeriod": true,
  "gracePeriodDebitEndsAt": "2020-07-30T04:59:59.000Z",
  "gracePeriodCreditEndsAt": "2020-07-30T04:59:59.000Z"
}

Certificate of Deposit (CD) Properties (v1.4.1)

Properties of a Certificate of Deposit (CD, a.k.a. Time Deposit) account.

This schema was resolved from accounts/cd.

Properties

Name	Description
Certificate of Deposit (CD) Properties (v1.4.1)	object Properties of a Certificate of Deposit (CD, a.k.a. Time Deposit) account. This schema was resolved from accounts/cd.
maturesAt	string(date-time) The date-time that this account will mature. The account matures on the date which is derived by adding the duration of the term to the opening date-time. The date-time is a string in RFC 3339 UTF format: YYYY-MM-DDThh:mm:ss.sssZ. read-only format: date-time
apyBumpedAt	string(date-time) The date-time that the user bumped the rate after the financial institution offered a higher rate. This property only exists if the user elected to bump the APY rate during this account's current term. If the account is rolled over to a new account, this property does not exist (even if the rollover has the same account number). See the bumpApyRate operation. The date-time is a string in RFC 3339 UTF format: YYYY-MM-DDThh:mm:ss.sssZ. read-only format: date-time
term	string(period) The maturity term. The account matures on the date which is derived by adding the duration of the term to the opening date-time. This value is an ISO 8601 duration string of the form P[n]Y[n]M[n]D to specify the term in the number of years/months/days. For example, the values P30D, P6M, P2Y indicate a term of 30 days, six months, and two years, respectively. read-only format: period
maturityPolicy	maturityPolicy What happens to the account upon maturity. enum values: rolloverPrincipalAndInterest, transferPrincipalAndInterest, rolloverPrincipalAndTransferInterest, holdPrincipalAndInterest, partialTransfer
rolloverProductName	string If this account rolls over into a new product at maturity, this is the name of the banking product for the rollover account. The product is defined in the apiture:rolloverProduct in the account's _links. read-only
transferAccount	cdTransferAccount Details of the existing internal or external account where interest and/or balance are transferred at CD maturity, depending on the settings in maturityPolicy. This object only exists if the maturity policy specifies transferring. This object and the properties are derived from the account referenced by the apiture:transferTargetAccount link that is used in createAccount or updateAccount. read-only
inDebitGracePeriod	boolean If this account is within the debit grace period, then it is eligible to withdraw funds without being assessed a penalty. If true the account is in the grace period in which debits are allowed. read-only
inCreditGracePeriod	boolean If this account is within the credit grace period, then it is eligible to add funds without being assessed a penalty. If true the account is in the grace period in which credits are allowed. read-only
gracePeriodDebitEndsAt	string(date-time) If the account is in a debit-eligible grace period, this is the date the grace period ends for debits in RFC 3339 date-time format, YYYY-MM-DDThh:mm:ssZ. Otherwise, this field is omitted. read-only format: date-time
gracePeriodCreditEndsAt	string(date-time) If the account is in a credit-eligible grace period, this is the date the grace period ends for credits in RFC 3339 date format, YYYY-MM-DDThh:mm:ssZ. Otherwise, this field is omitted. read-only format: date-time
beneficialOwnersConfirmed	boolean When updating the maturity settings for a business CD account, a true value indicates the user has confirmed the existing beneficial owners on the account. This property exists only in patchAccount request operations and is not present in responses. Note: The beneficial owners are part of the owning organization for business accounts; see the Organization's API.

cdTransferAccount

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

CD Transfer Account (v1.0.1)

Properties of the target account for transferring funds from a maturing CD account.

This schema was resolved from accounts/cdTransferAccount.

Properties

Name	Description
CD Transfer Account (v1.0.1)	object Properties of the target account for transferring funds from a maturing CD account. This schema was resolved from accounts/cdTransferAccount.
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

check

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
    },
    "apiture:reject": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/rejectedChecks?checkId=999a1163-47fd"
    },
    "apiture:uploadFrontImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:frontImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    },
    "apiture:frontImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:uploadBackImage": {
      "href": "https://api.devbank.apiture.com/uploadUri"
    },
    "apiture:backImageContent": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
    },
    "apiture:backImage": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
    }
  },
  "_id": "999a1163-47fd",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "enteredAmount": "55.10",
  "scannedAmount": "55.10",
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": "902810",
  "riskWarnings": [
    {
      "type": "payeeAccountHolderMismatch",
      "label": "Payee name does not match Account owner",
      "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
    }
  ]
}

Check (v1.3.1)

Check resource. The apiture:reject link invokes the rejectCheck operation to reject an invalid check (POST); it is present if the rejectCheck operation is available for the check.

Links

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

Rel	Summary	Method
this	Fetch a check deposit	GET
apiture:target	Target account where the checks are deposited'	GET
apiture:uploadFrontImage	Upload check front image	GET
apiture:uploadBackImage	Upload check check image	GET
apiture:frontImage	Get check front image metadata	GET
apiture:frontImageContent	Get check fron image file	GET
apiture:backImage	Get check back image metadata	GET
apiture:backImageContent	Get check back image file	GET
apiture:reject	Reject a check	POST
apiture:process	Process a check	POST

Properties

Name	Description
Check (v1.3.1)	object Check resource. The apiture:reject link invokes the rejectCheck operation to reject an invalid check (POST); it is present if the rejectCheck operation is available for the check. Links Response and request bodies using this check schema may contain the following links: Rel Summary Method this Fetch a check deposit GET apiture:target Target account where the checks are deposited' GET apiture:uploadFrontImage Upload check front image GET apiture:uploadBackImage Upload check check image GET apiture:frontImage Get check front image metadata GET apiture:frontImageContent Get check fron image file GET apiture:backImage Get check back image metadata GET apiture:backImageContent Get check back image file GET apiture:reject Reject a check POST apiture:process Process a check POST
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string The unique identifier for this check deposit resource. This is an immutable opaque string. read-only
description	string Description for the check.
state	checkState The state of the check. This field is immutable and derived. checkState strings may have one of the following enumerated values: Value Description pending Pending processing Processing valid Valid invalid Invalid submitted Submitted accepted Accepted acceptedAdjustedDown Accepted Adjusted Down acceptedAdjustedUp Accepted Adjusted Up rejected Rejected These enumeration values are further described by the label group named checkState in the response from the getLabels operation. read-only enum values: pending, processing, valid, invalid, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected
riskRejections	array: [riskFactor] Risk factors indicating the check has been rejected and can't be corrected. If a check contains any rejection risk factors, the check must be removed from the check deposit. A check deposit can't be submitted if any of its checks contain rejection risk factors. items: object
rejectReason	checkDepositRejectReason The reason that a check was rejected after being submitted. The value is defined by the check deposit provider and it is immutable. It is only returned if the state of the check is rejected. checkDepositRejectReason strings may have one of the following enumerated values: Value Description notApplicable Not Applicable / Other notSufficientFunds NSF - Not Sufficient Funds uncollectedFundsHold UCF - Uncollected Funds Hold stopPayment Stop Payment closedAccount Closed Account unableToLocateAccount UTLA - Unable to Locate Account frozenBlockedAccount Frozen/Blocked Account staleDated Stale Dated postDated Post Dated endorsementMissing Endorsement Missing endorsementIrregular Endorsement Irregular signatureMissing Signature(s) Missing signatureIrregular Signature(s) Irregular nonCashItem Non-Cash Item (Non Negotiable) alteredFictitiousItem Altered/Fictitious Item unableToProcess Unable to process (e.g. Mutilated Item) itemExceedsDollarLimit Item Exceeds Dollar Limit notAuthorized Not Authorized branchAccountSold Branch/Account Sold (Wrong Bank) referToMaker Refer to Maker stopPaymentSuspect Stop Payment Suspect unusableImage Unusable Image imageFailsSecurityCheck Image Fails Security Check cannotDetermineAccount Cannot Determine Account irdUserDefined IRD User Defined-See Return Text Overlay depositProhibitedItem My Deposit Prohibited Item numericAndWrittenAmountsDifferent Numeric and written amounts different fiProhibitedItem FI Prohibited Item missingForMobileDepositOnly Missing 'For Mobile Deposit Only' with endorsement These enumeration values are further described by the label group named rejectReason in the response from the getLabels operation. read-only enum values: notApplicable, notSufficientFunds, uncollectedFundsHold, stopPayment, closedAccount, unableToLocateAccount, frozenBlockedAccount, staleDated, postDated, endorsementMissing, endorsementIrregular, signatureMissing, signatureIrregular, nonCashItem, alteredFictitiousItem, unableToProcess, itemExceedsDollarLimit, notAuthorized, branchAccountSold, referToMaker, stopPaymentSuspect, unusableImage, imageFailsSecurityCheck, cannotDetermineAccount, irdUserDefined, depositProhibitedItem, numericAndWrittenAmountsDifferent, fiProhibitedItem, missingForMobileDepositOnly
riskErrors	array: [riskFactor] Risk factors indicating the check has errors which must be corrected before the check deposit can be submitted. Modifying the check data and re-processing may resolve errors. A check deposit can't be submitted if any of its checks contain error risk factors. items: object
riskWarnings	array: [riskFactor] Risk factors indicating the check has warnings. Warnings do not prevent a check from being deposited, but are helpful to show the user to catch any potential issues before submission. A check deposit can still be submitted if checks contain warnings. items: object
riskInfo	array: [riskFactor] Various additional diagnostic information about the check. items: object
enteredAmount	string The USD amount of the check entered by the user. The numeric value is represented as a string so that it can be exact with no loss of precision.
scannedAmount	string The USD amount of the check read by OCR. This value may only be available after processing is complete. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
scannedAmountConfidence	number Indicates the confidence in the accuracy of the scannedAmount value, from lowest confidence 0.0 to highest confidence, 1.0. read-only minimum: 0 maximum: 1
scannedMicr	string The scanned magnetic ink character recognition (MICR) number from the check image. This value encodes the routing number, account number, check number, check amount, and other data from the check. This value is only be available after processing is complete. read-only
scannedCheckNumber	string The number of the check read by OCR. This value may only be available after processing is complete. read-only
attributes	attributes An optional map of name/value pairs which contains additional dynamic data about the resource. This schema was resolved from common/attributes. Additional Properties: true

checkAmounts

{
  "current": "string",
  "remaining": "string",
  "currency": "string"
}

Check Amount Limits (v1.0.1)

The limits on check deposit amounts in this time period.

Properties

Name	Description
Check Amount Limits (v1.0.1)	object The limits on check deposit amounts in this time period.
current	string(decimal) The current total check deposit amount in this time period. read-only format: decimal
remaining	string(decimal) The remaining check deposit amount. read-only format: decimal
currency	string The ISO 4217 currency code for this balance. read-only

checkCounts

{
  "current": 0,
  "remaining": 0
}

Check Count Limits (v1.0.1)

The limits on the number of check deposit in this time period.

Properties

Name	Description
Check Count Limits (v1.0.1)	object The limits on the number of check deposit in this time period.
current	integer The current number of mobile check deposits in this time period read-only
remaining	integer The number of check deposits remaining. read-only

checkDeposit

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Check Deposit (v1.3.1)

Check deposit resource. Checks are added to this before being deposited. The apiture:target link contains the URI of the target account where the checks are deposited. The apiture:process link invokes the processCheckDeposit operation to process the checks to verify the check contents (POST); the link is present if that operation is available for the check deposit. The apiture:submit link invokes the submitCheckDeposit operation to submit the valid checks for deposit (POST); the link is present if that operation is available for the check deposit.

Links

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

Rel	Summary	Method
this	Fetch a check deposit	GET
apiture:target	Target account where the checks are deposited	GET
apiture:createCheck	Add a check to the check deposit batch	POST
apiture:submit	Submit a check deposit	POST
apiture:process	Process checks in a check deposit	POST

Properties

Name	Description
Check Deposit (v1.3.1)	object Check deposit resource. Checks are added to this before being deposited. The apiture:target link contains the URI of the target account where the checks are deposited. The apiture:process link invokes the processCheckDeposit operation to process the checks to verify the check contents (POST); the link is present if that operation is available for the check deposit. The apiture:submit link invokes the submitCheckDeposit operation to submit the valid checks for deposit (POST); the link is present if that operation is available for the check deposit. Links Response and request bodies using this checkDeposit schema may contain the following links: Rel Summary Method this Fetch a check deposit GET apiture:target Target account where the checks are deposited GET apiture:createCheck Add a check to the check deposit batch POST apiture:submit Submit a check deposit POST apiture:process Process checks in a check deposit POST
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string The unique identifier for this account resource. This is an immutable opaque string. read-only
state	checkDepositState The state of the check deposit. This field is immutable and derived. checkDepositState strings may have one of the following enumerated values: Value Description pending Pending processing Processing valid Valid invalid Invalid submitted Submitted accepted Accepted acceptedAdjustedDown Accepted Adjusted Down acceptedAdjustedUp Accepted Adjusted Up rejected Rejected acceptedWithRejections Accepted with Rejections These enumeration values are further described by the label group named checkDepositState in the response from the getLabels operation. read-only enum values: pending, processing, valid, invalid, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected, acceptedWithRejections
description	string Description for the deposit.
depositedAmount	string The total USD amount of the check deposit after it was successfully deposited. This number is immutable and only available after the check deposit was accepted by the FI and has state 'accepted', acceptedAdjustedDown, acceptedAdjustedUp, or 'acceptedWithRejections'. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
enteredAmount	string The USD amount of the deposit entered by the user. The numeric value is represented as a string so that it can be exact with no loss of precision.
scannedAmount	string The total USD amount of the deposit read by OCR. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
checkCount	number The current count of checks in the deposit batch. read-only
createdAt	string(date-time) The date-time the check deposit was created. This is an RFC 3339 UTC time stamp. read-only format: date-time
submittedAt	string(date-time) The date-time the check deposit was submitted. This is an RFC 3339 UTC time stamp. read-only format: date-time
acceptedAt	string(date-time) The date-time the check deposit was accepted. This does not mean the checks have cleared, only that the deposit has been posted. This is an RFC 3339 UTC time stamp. read-only format: date-time
checks	array: [check] Checks included in the Check Deposit. read-only items: object
confirmationId	string The confirmation id that the deposit request was received for processing. read-only

checkDepositEmbeddedObjects

{
  "eligibleAccounts": [
    {
      "_profile": "https://production.api.apiture.com/schemas/accounts/summaryAccount/v2.12.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:product": {
          "href": "https://api.devbank.apiture.com/products/products/0aba4bae-f18b-4c12-af99-5f8dbd682ae3"
        }
      },
      "name": "My savings",
      "description": "My Basic savings account",
      "interestPolicy": "capitalize",
      "usageAnswers": {
        "primaryAccount": true,
        "accountPurpose": "college savings",
        "primarySourceOfDeposits": "transfers from savings"
      },
      "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
      "routingNumber": "021000021",
      "institutionName": "Canapi Bank",
      "state": "active",
      "title": "John Smith",
      "ifxType": "SDA",
      "allowsTransfers": true,
      "accountNumbers": {
        "full": "9876543210",
        "masked": "*************3210"
      },
      "balance": {
        "current": "3450.30",
        "available": "3450.30",
        "currency": "USD",
        "primary": "3450.30",
        "primaryLabel": "Current Balance",
        "primaryDescription": "Current balance includes deposits that have posted but are not yet available. Pending debits are not deducted from this amount."
      },
      "openedAt": "2019-04-30T10:01:07.375Z",
      "paymentsEnabled": false,
      "checkOrderingEnabled": false,
      "regDEnabled": false
    }
  ]
}

Check Deposit Embedded Objects (v1.1.0)

Objects embedded in the response from creating a new check deposit resource.

Properties

Name	Description
Check Deposit Embedded Objects (v1.1.0)	object Objects embedded in the response from creating a new check deposit resource.
eligibleAccounts	array: [summaryAccount] (required) A list of account summaries of accounts eligble for check deposits. items: object

checkDepositLimit

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

Check Deposit Limit (v1.1.1)

List of check deposit limits and the remaining amounts.

Properties

Name	Description
Check Deposit Limit (v1.1.1)	object List of check deposit limits and the remaining amounts.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
context	checkDepositLimitContext Defines the context of this check deposit limit. enum values: user, account
days	integer The number of days covered this limit response, backwards from the today. minimum: 1
checkCounts	checkCounts Limits on the number of check deposit.
checkAmounts	checkAmounts Limits on check deposit amounts.

checkDepositLimitContext

"user"

Check Deposit Limit Context (v1.0.0)

The context of a check deposit limit.

checkDepositLimitContext strings may have one of the following enumerated values:

Value	Description
user	User: User-level check deposit limits.
account	Account-level check deposit limits.

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

type: string

enum values: user, account

checkDepositLimits

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDepositLimits/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "limits": [
    {
      "context": "user",
      "days": 30,
      "checkCounts": {
        "current": 100,
        "remaining": 30
      },
      "checkAmounts": {
        "current": "10000.00",
        "remaining": "2500.00",
        "currency": "USD"
      }
    }
  ]
}

Check Deposit Limits (v1.1.1)

Collection of check deposit limits and the remaining amounts.

Properties

Name	Description
Check Deposit Limits (v1.1.1)	object Collection of check deposit limits and the remaining amounts.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
limits	array: [checkDepositLimit] An array containing the limits. items: object

checkDepositRejectReason

"notApplicable"

Check Deposit Reject Reason (v1.0.0)

The reason that a check was rejected after being submitted. The value is defined by the check deposit provider and it is immutable. It is only returned if the state of the check is rejected.

checkDepositRejectReason strings may have one of the following enumerated values:

Value	Description
notApplicable	Not Applicable / Other
notSufficientFunds	NSF - Not Sufficient Funds
uncollectedFundsHold	UCF - Uncollected Funds Hold
stopPayment	Stop Payment
closedAccount	Closed Account
unableToLocateAccount	UTLA - Unable to Locate Account
frozenBlockedAccount	Frozen/Blocked Account
staleDated	Stale Dated
postDated	Post Dated
endorsementMissing	Endorsement Missing
endorsementIrregular	Endorsement Irregular
signatureMissing	Signature(s) Missing
signatureIrregular	Signature(s) Irregular
nonCashItem	Non-Cash Item (Non Negotiable)
alteredFictitiousItem	Altered/Fictitious Item
unableToProcess	Unable to process (e.g. Mutilated Item)
itemExceedsDollarLimit	Item Exceeds Dollar Limit
notAuthorized	Not Authorized
branchAccountSold	Branch/Account Sold (Wrong Bank)
referToMaker	Refer to Maker
stopPaymentSuspect	Stop Payment Suspect
unusableImage	Unusable Image
imageFailsSecurityCheck	Image Fails Security Check
cannotDetermineAccount	Cannot Determine Account
irdUserDefined	IRD User Defined-See Return Text Overlay
depositProhibitedItem	My Deposit Prohibited Item
numericAndWrittenAmountsDifferent	Numeric and written amounts different
fiProhibitedItem	FI Prohibited Item
missingForMobileDepositOnly	Missing 'For Mobile Deposit Only' with endorsement

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

type: string

read-only
enum values: notApplicable, notSufficientFunds, uncollectedFundsHold, stopPayment, closedAccount, unableToLocateAccount, frozenBlockedAccount, staleDated, postDated, endorsementMissing, endorsementIrregular, signatureMissing, signatureIrregular, nonCashItem, alteredFictitiousItem, unableToProcess, itemExceedsDollarLimit, notAuthorized, branchAccountSold, referToMaker, stopPaymentSuspect, unusableImage, imageFailsSecurityCheck, cannotDetermineAccount, irdUserDefined, depositProhibitedItem, numericAndWrittenAmountsDifferent, fiProhibitedItem, missingForMobileDepositOnly

checkDepositState

"submitted"

Check Deposit State (v1.1.0)

The state of the check deposit. This field is immutable and derived.

checkDepositState strings may have one of the following enumerated values:

Value	Description
pending	Pending
processing	Processing
valid	Valid
invalid	Invalid
submitted	Submitted
accepted	Accepted
acceptedAdjustedDown	Accepted Adjusted Down
acceptedAdjustedUp	Accepted Adjusted Up
rejected	Rejected
acceptedWithRejections	Accepted with Rejections

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

type: string

read-only
enum values: pending, processing, valid, invalid, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected, acceptedWithRejections

checkDepositWithEligibleAccounts

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposit/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
    },
    "apiture:target": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:createCheck": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks"
    },
    "apiture:submit": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-419a"
    },
    "apiture:process": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/processedCheckDeposits?depositId=f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "submitted",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "125.10",
  "checkCount": 2,
  "depositedAmount": "125.20",
  "scannedAmount": "125.20",
  "checks": [
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/uploadUri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    },
    {
      "_id": "999a1163-47fd",
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/check/v1.3.1/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd"
        },
        "apiture:process": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/processedChecks?checkId=999a1163-47fd"
        },
        "apiture:uploadFrontImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:frontImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
        },
        "apiture:frontImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
        },
        "apiture:uploadBackImage": {
          "href": "https://api.devbank.apiture.com/some-upload-uri"
        },
        "apiture:backImageContent": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back/content"
        },
        "apiture:backImage": {
          "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "enteredAmount": "55.10",
      "scannedAmount": "55.10",
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": "902810",
      "riskWarnings": [
        {
          "type": "payeeAccountHolderMismatch",
          "label": "Payee name does not match Account owner",
          "description": "The payee name of the check does not match the name of the owner of the account to deposit into."
        }
      ]
    }
  ]
}

Check Deposit with Eligble Accounts (v1.4.0)

Check deposit resource. Checks are added to this before being deposited. This response also include a list of eligble check deposit target accounts in _embedded.eligbleAccounts. This schema is the existing checkDeposit schema, with the added _embedded objects found only in this response.

Properties

Name	Description
Check Deposit with Eligble Accounts (v1.4.0)	object Check deposit resource. Checks are added to this before being deposited. This response also include a list of eligble check deposit target accounts in _embedded.eligbleAccounts. This schema is the existing checkDeposit schema, with the added _embedded objects found only in this response.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	checkDepositEmbeddedObjects Embedded objects.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string The unique identifier for this account resource. This is an immutable opaque string. read-only
state	checkDepositState The state of the check deposit. This field is immutable and derived. checkDepositState strings may have one of the following enumerated values: Value Description pending Pending processing Processing valid Valid invalid Invalid submitted Submitted accepted Accepted acceptedAdjustedDown Accepted Adjusted Down acceptedAdjustedUp Accepted Adjusted Up rejected Rejected acceptedWithRejections Accepted with Rejections These enumeration values are further described by the label group named checkDepositState in the response from the getLabels operation. read-only enum values: pending, processing, valid, invalid, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected, acceptedWithRejections
description	string Description for the deposit.
depositedAmount	string The total USD amount of the check deposit after it was successfully deposited. This number is immutable and only available after the check deposit was accepted by the FI and has state 'accepted', acceptedAdjustedDown, acceptedAdjustedUp, or 'acceptedWithRejections'. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
enteredAmount	string The USD amount of the deposit entered by the user. The numeric value is represented as a string so that it can be exact with no loss of precision.
scannedAmount	string The total USD amount of the deposit read by OCR. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
checkCount	number The current count of checks in the deposit batch. read-only
createdAt	string(date-time) The date-time the check deposit was created. This is an RFC 3339 UTC time stamp. read-only format: date-time
submittedAt	string(date-time) The date-time the check deposit was submitted. This is an RFC 3339 UTC time stamp. read-only format: date-time
acceptedAt	string(date-time) The date-time the check deposit was accepted. This does not mean the checks have cleared, only that the deposit has been posted. This is an RFC 3339 UTC time stamp. read-only format: date-time
checks	array: [check] Checks included in the Check Deposit. read-only items: object
confirmationId	string The confirmation id that the deposit request was received for processing. read-only

checkDeposits

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkDeposits/v1.3.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits?start=0&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits?start=10&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits"
    }
  },
  "start": 0,
  "limit": 10,
  "count": 1,
  "name": "check deposits",
  "_embedded": {
    "items": [
      {
        "_id": "f6c321e6-419a",
        "_profile": "https://production.api.apiture.com/schemas/checkDeposits/summaryCheckDeposit/v1.2.1/profile.json",
        "_links": {
          "self": {
            "href": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/f6c321e6-419a"
          },
          "apiture:target": {
            "href": "https://api.devbank.apiture.com/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          }
        },
        "state": "pending",
        "createdAt": "2019-01-20T05:54:52.375Z",
        "description": "bake sale checks",
        "enteredAmount": "103.22",
        "checkCount": 3
      }
    ]
  }
}

Check Deposits Collection (v1.3.1)

Collection of check deposits. 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
Check Deposits Collection (v1.3.1)	object Collection of check deposits. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	checkDepositsEmbeddedObjects Embedded objects.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

checkDepositsEmbeddedObjects

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/checkDeposits/summaryCheckDeposit/v1.2.1/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-419a"
        }
      },
      "_id": "f6c321e6-419a",
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "bake sale checks",
      "enteredAmount": "1023.22",
      "checkCount": 3
    }
  ]
}

Check Deposits Embedded Objects (v1.2.1)

Objects embedded in the checkDeposits collection's items.

Properties

Name	Description
Check Deposits Embedded Objects (v1.2.1)	object Objects embedded in the checkDeposits collection's items.
items	array: [summaryCheckDeposit] An array containing a page of check deposit items. items: object

checkImage

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/checkImage/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front"
    },
    "apiture:content": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-419a/checks/999a1163-47fd/images/front/content"
    }
  },
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "name": "frontImage.jpeg",
  "contentType": "image/jpeg",
  "description": "Front check image captured and uploaded from an iPhoneX.",
  "sizeBytes": 112800,
  "createdAt": "2019-01-04T07:00:49.375Z"
}

Check Image (v1.1.1)

Representation of a check image file. The image may contain an apiture:uploadUrl link within the item's _links. The client should next PUT the file content to the upload URLs. The file must be an image with JPEG format. If file content has been uploaded, the image may have an apiture:content link to access the direct URI of the file's content.

Properties

Name	Description
Check Image (v1.1.1)	object Representation of a check image file. The image may contain an apiture:uploadUrl link within the item's _links. The client should next PUT the file content to the upload URLs. The file must be an image with JPEG format. If file content has been uploaded, the image may have an apiture:content link to access the direct URI of the file's content.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The file name, for identification purposes. File names may include file extensions such as .jpeg for JPEG images, although the system does not validate or ensure that extensions match the file content type. This is limited to 64 characters and may not contain certain special characters such as / or \. If omitted, the system will assign a name. maxLength: 64
description	string A description of this file and its contents. maxLength: 4096
contentType	string The media type for this file.
sizeBytes	number The file size in bytes. This is a derived property and cannot be modified in updates. read-only
createdAt	string(date-time) The date-time when the image was created or uploaded. read-only format: date-time

checkState

"processing"

Check State (v1.1.0)

The state of the check. This field is immutable and derived.

checkState strings may have one of the following enumerated values:

Value	Description
pending	Pending
processing	Processing
valid	Valid
invalid	Invalid
submitted	Submitted
accepted	Accepted
acceptedAdjustedDown	Accepted Adjusted Down
acceptedAdjustedUp	Accepted Adjusted Up
rejected	Rejected

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

type: string

read-only
enum values: pending, processing, valid, invalid, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected

collection

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

Collection (v2.1.1)

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

This schema was resolved from common/collection.

Properties

Name	Description
Collection (v2.1.1)	object A collection of resources. This is an abstract model schema which is extended to define specific resource collections. This schema was resolved from common/collection.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

configurationGroup

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

Configuration Group (v2.1.1)

Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

Properties

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

configurationGroupSummary

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

Configuration Group Summary (v2.1.1)

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

This schema was resolved from configurations/configurationGroupSummary.

Properties

Name	Description
Configuration Group Summary (v2.1.1)	object A summary of the data contained within a configuration group resource. This schema was resolved from configurations/configurationGroupSummary.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The name of this configuration group, must be unique within the set of all resources of this type. minLength: 1 maxLength: 48 pattern: "[a-zA-Z][-\\w_]*"
label	string The text label for this resource, suitable for presentation to the client. minLength: 1 maxLength: 128
description	string The full description for this resource, suitable for presentation to the client. minLength: 1 maxLength: 4096

configurationGroups

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

Configuration Group Collection (v2.1.1)

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

This schema was resolved from configurations/configurationGroups.

Properties

Name	Description
Configuration Group Collection (v2.1.1)	object Collection of configuration groups. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection). This schema was resolved from configurations/configurationGroups.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	configurationGroupsEmbedded Embedded objects.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
count	integer The number of items in the collection. This value is optional and may be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

configurationGroupsEmbedded

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

Configuration Groups Embedded Objects (v1.1.1)

Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

Properties

Name	Description
Configuration Groups Embedded Objects (v1.1.1)	object Objects embedded in the configurationGroupscollection. This schema was resolved from configurations/configurationGroupsEmbedded.
items	array: [configurationGroupSummary] An array containing a page of configuration group items. items: object

configurationSchema

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

Configuration Schema (v2.1.0)

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

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

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

This schema was resolved from configurations/configurationSchema.

Properties

Name	Description
Configuration Schema (v2.1.0)	object The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*. This is implicitly a schema for type: object and contains the properties. The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0. This schema was resolved from configurations/configurationSchema.
Configuration Schema Value (v2.0.0)	configurationSchemaValue The data associated with this configuration schema. This schema was resolved from configurations/configurationSchemaValue.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

Properties

Name	Description
Configuration Schema Value (v2.0.0)	object The data associated with this configuration schema. This schema was resolved from configurations/configurationSchemaValue.

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

Name	Description
Configuration Value (v2.0.0)	object The data associated with this configuration. This schema was resolved from configurations/configurationValue.

configurationValues

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

Configuration Values (v2.0.0)

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

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

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

This schema was resolved from configurations/configurationValues.

Properties

Name	Description
Configuration Values (v2.0.0)	object The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema. Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values. For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema. This schema was resolved from configurations/configurationValues.
Configuration Value (v2.0.0)	configurationValue The data associated with this configuration. This schema was resolved from configurations/configurationValue.

createCheck

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "enteredAmount": "43.11",
  "description": "from jim",
  "device": {
    "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
    "type": "iPhone",
    "operatingSystem": "iOS",
    "operatingSystemVersion": "13.2.1",
    "make": "Apple",
    "model": "iPhoneXs"
  }
}

Create Check Fields (v1.0.1)

Create a new check.

Properties

Name	Description
Create Check Fields (v1.0.1)	object Create a new check.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
enteredAmount	string The USD amount of the deposit entered by the user. The numeric value is represented as a string so that it can be exact with no loss of precision.
description	string Description for the deposit.
device	device Diagnostic information about the client device.

createCheckDeposit

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/createCheckDeposit/v1.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "enteredAmount": "215.10",
  "description": "bake sale checks",
  "device": {
    "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
    "type": "iPhone",
    "operatingSystem": "iOS",
    "operatingSystemVersion": "13.2.1",
    "make": "Apple",
    "model": "iPhoneXs"
  }
}

Create Check Deposit Fields (v1.1.1)

Create a new check deposit. Account URI to deposit into should be included in _links 'apiture:target'.

Links

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

Rel	Summary	Method
apiture:target	Target account where the checks are deposited	GET

Properties

Name	Description
Create Check Deposit Fields (v1.1.1)	object Create a new check deposit. Account URI to deposit into should be included in _links 'apiture:target'. Links Response and request bodies using this createCheckDeposit schema may contain the following links: Rel Summary Method apiture:target Target account where the checks are deposited GET
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
enteredAmount	string The total USD amount of the deposit entered by the user. The numeric value is represented as a string so that it can be exact with no loss of precision.
description	string Description for the deposit.
device	device Diagnostic information about the client device.

device

{
  "id": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
  "type": "iPhone",
  "operatingSystem": "iOS",
  "operatingSystemVersion": "13.2.1",
  "make": "Apple",
  "model": "iPhoneXs"
}

Device Data (v1.0.0)

Diagnostic information about the client device.

Properties

Name	Description
Device Data (v1.0.0)	object Diagnostic information about the client device.
id	string Unique identifier of the device originating the request. This can be any unique value to identify the client device.
type	string The type of device originating the request. This is a high level indicator for the type of the client device. iPhone, Android, Web Browser are examples.
operatingSystem	string The operating system of the device originating the request. iOS, Android, macOS, Windows, Linux are examples.
operatingSystemVersion	string The version of the operating system of the device originating the request.
make	string The make of the device originating the request. Apple, Google, Motorola, Dell are examples.
model	string The model of the device originating the request. iPhoneXs, Pixel3, G2qx, MacbookPro13 are examples.

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.1.0)

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

This schema was resolved from common/error.

Properties

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

errorResponse

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

Error Response (v2.1.1)

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

This schema was resolved from common/errorResponse.

Properties

Name	Description
Error Response (v2.1.1)	object Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details. This schema was resolved from common/errorResponse.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only

ifxType

"CCA"

IFX Account Type (v1.0.1)

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

ifxType strings may have one of the following enumerated values:

Value	Description
CCA	Credit card account
CDA	Certificate of deposit account (CD)
CLA	Commercial loan account
CMA	Cash management account
DDA	Demand deposit account
EQU	Home equity loan
GLA	General ledger account
ILA	Installment loan account
INV	Investment account
IRA	Individual retirement account
IRL	Accounts held in Ireland
LOC	Consumer line of credit
MLA	Military Lending Account: Credit facility held by former US service member
MMA	Money market account
PBA	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
PPA	Private pension administrator
RWD	Reward accounts
SDA	Savings deposit account

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

This schema was resolved from products/ifxType.

type: string

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

interest

{
  "yearToDate": "3.12",
  "sinceOpening": "34.62",
  "priorYear": "87.60"
}

Interest (v1.1.0)

The account's accrued interest. The values are in the currency associated with the account.

This schema was resolved from accounts/interest.

Properties

Name	Description
Interest (v1.1.0)	object The account's accrued interest. The values are in the currency associated with the account. This schema was resolved from accounts/interest.
yearToDate	string The interest earned to date since the beginning of the year. read-only
sinceOpening	string The interest earned since the account was opened. read-only
priorYear	string The interest earned in the prior year. If the account was not yet open in that year, the value is "0.00". read-only

interestPolicy

"none"

Account Interest Policy (v1.0.0)

How interest credits on the account (if any) are disbursed.

interestPolicy strings may have one of the following enumerated values:

Value	Description
none	None: This account does not earn interest.
capitalize	Capitalize: When interest is posted, it is deposited back into the account.
transfer	Transfer: When interest is posted, it is transferred to another account.

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

This schema was resolved from accounts/interestPolicy.

type: string

enum values: none, capitalize, transfer

internalAccountState

"active"

Internal Account State (v1.0.0)

The state of the account. This field is immutable and derived.

To change the state of an account, POST the account ID to the corresponding resource endpoints, using the corresponding link on the account resource:

• To activate an account, use the apiture:activate link to POST to /accounts/activeAccounts. * To deactivate an account, use the apiture:deactivate link to POST to /accounts/inactiveAccounts. * To freeze an account, use the apiture:freeze link to POST to /accounts/frozenAccounts. * To close an account, use the apiture:close link to POST to /accounts/closedAccounts.

internalAccountState strings may have one of the following enumerated values:

Value	Description
pending	Pending: A new account resource has been created but its data has not been verified and the account is not active.
active	Active: The account has been created and is now active and available for transactions as determined by the account's banking product.
inactive	Inactive: An account which is marked inactive and not available for new transactions. Financial institution administrators can change inactive accounts back to active.
frozen	frozen: An account which is frozen and not eligible for new transactions. This is typically the result of suspicious activity or fraud detection. The user must contact their financial institution to unfreeze the account (by changing the state back to active) or the financial institution may opt to close the account.
closed	Closed: An account that is closed and removed from use. Closed accounts are not eligble for transactions or to become active. Such accounts are retained for historical purposes because some transactions may refer to it. Users do not see closed accounts when they view their accounts.

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

This schema was resolved from accounts/internalAccountState.

type: string

enum values: pending, active, inactive, frozen, closed

labelGroup

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

Label Group (v1.0.3)

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

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

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

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

This schema was resolved from common/labelGroup.

Properties

Name	Description
Label Group (v1.0.3)	object A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00). This allows the client to let the user select a value from a list, such as the following derived from the labels in the example: Unknown Under $1M $1M to $10M $10M to $100M $100M or more Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }. This schema was resolved from common/labelGroup.
Label Item (v1.0.2)	labelItem An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from common/labelItem.

labelGroups

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.3/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "firstGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Label Groups (v1.1.3)

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

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

This schema was resolved from common/labelGroups.

Properties

Name	Description
Label Groups (v1.1.3)	object A set of named groups of labels, each of which contains multiple item labels. The abbreviated example shows two groups, one named structure and one named estimatedAnnualRevenue. The first has items with names such as corporation, llc and soleProprietorship, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million has the label "$1M to $10M" and the range [1000000.00,10000000.00). This schema was resolved from common/labelGroups.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
groups	object Groups of localized labels. This maps group names → a group of labels within that group.
» Label Group (v1.0.3)	labelGroup A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue, with options ranging under1Million, to over100Million. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}, and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00). This allows the client to let the user select a value from a list, such as the following derived from the labels in the example: Unknown Under $1M $1M to $10M $10M to $100M $100M or more Note that the other item is hidden from the selection list, as that item is marked as hidden. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }. This schema was resolved from common/labelGroup.

labelItem

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

Label Item (v1.0.2)

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

This schema was resolved from common/labelItem.

Properties

Name	Description
Label Item (v1.0.2)	object An item in a labelGroup, with a set of variants which contains different localized labels for the item. Each simpleLabel variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external systems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI. This schema was resolved from common/labelItem.
label	string (required) A label or title which may be used as labels or other UI controls which present a value.
description	string A more detailed localized description of a localizable label.
variants	object The language-specific variants of this label. The keys in this object are RFC 7231 language codes.
» Simple Label (v1.0.0)	simpleLabel A text label and optional description. This schema was resolved from common/simpleLabel.
code	string If the localized value is associated with an external standard or definition, this is a lookup code or key or URI for that value. minLength: 1
hidden	boolean If true, this item is normally hidden from the User Interface.
range	string The range of values, if the item describes a bounded numeric value. This is range notation such as [min,max], (exclusiveMin,max], [min,exclusiveMax), or (exclusiveMin,exclusiveMax). For example, [0,100) is the range greater than or equal to 0 and less than 100. If the min or max value are omitted, that end of the range is unbounded. For example, (,1000.00) means less than 1000.00 and [20000.00,] means 20000.00 or more. The ranges do not overlap or have gaps. pattern: "^[\\[\\(](-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?,(-?(0|[1-9][0-9]*)(\\.[0-9]+)?)?[\\]\\)]$"

link

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

Link (v1.0.0)

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

This schema was resolved from common/link.

Properties

Name	Description
Link (v1.0.0)	object Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property. This schema was resolved from common/link.
href	string(uri) (required) The URI or URI template for the resource/operation this link refers to. format: uri
type	string The media type for the resource.
templated	boolean If true, the link's href is a URI template.
title	string An optional human-readable localized title for the link.
deprecation	string(uri) If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation. format: uri
profile	string(uri) The URI of a profile document, a JSON document which describes the target resource/operation. format: uri

links

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

Links (v1.0.0)

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

This schema was resolved from common/links.

Properties

Name	Description
Links (v1.0.0)	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
Link (v1.0.0)	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property. This schema was resolved from common/link.

maturityPolicy

"rolloverPrincipalAndInterest"

Maturity Policy (v1.0.0)

Indicates how the principal and interest are processed upon maturity. The values indicate whether to rollover (to a time deposit account of the same rate and term), transfer funds to another (possibly new) deposit account, or simply hold the funds in the current account (which may no longer accrue interest). Labels and descriptions for the enumeration values are in the maturityPolicy key in the response of the getLabels operation.

maturityPolicy strings may have one of the following enumerated values:

Value	Description
rolloverPrincipalAndInterest	Rollover principal and interest to a new CD of the same product: Upon maturity, both principal and interest rollover into a specified banking product, such as a savings, checking, or other deposit account.
transferPrincipalAndInterest	Transfer principal and interest to a deposit account: Upon maturity, the principal an interest are both transferred to an existing or new deposit account.
rolloverPrincipalAndTransferInterest	Transfer interest to a new deposit account an rollover principal to a new CD of the same product: Upon maturity, the principal rolls over into a specified banking product and the interest is transferred to an existing deposit account.
holdPrincipalAndInterest	Hold principal and accued interest in the CD account until withdrawal: Upon maturity, the principal and interest are held in the current time deposit account. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.
partialTransfer	Partial Transfer: Upon maturity, any funds greater than the maturity threshold is transfered to an existing deposit account and the rest remains on deposit. The account may or may not accrue further interest, depending on the terms of the time deposit product. Funds may be withdrawn or transferred.

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

This schema was resolved from products/maturityPolicy.

type: string

enum values: rolloverPrincipalAndInterest, transferPrincipalAndInterest, rolloverPrincipalAndTransferInterest, holdPrincipalAndInterest, partialTransfer

riskFactor

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "help": {
      "href": "{uri of help website for risk factor}"
    }
  },
  "type": "payeeAccountHolderMismatch",
  "label": "Payee name does not match Account owner",
  "description": "The payee name of the check does not match the name of\n  the owner of the account to deposit into."
}

Risk Factor (v1.1.1)

Diagnostic information about the check.

Properties

Name	Description
Risk Factor (v1.1.1)	object Diagnostic information about the check.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
type	string The risk factor type.
label	string A short label identifying the risk factor.
description	string A longer description with information about the risk factor. This may include recovery options in the case of warnings or errors.
attributes	attributes Data attribute associated with the risk factor, such as values or constraints. Additional Properties: true

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

API Root (v2.1.1)

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

This schema was resolved from common/root.

Properties

Name	Description
API Root (v2.1.1)	object A HAL response, with hypermedia _links for the top-level resources and operations in API. This schema was resolved from common/root.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string This API's unique ID. read-only
name	string This API's name.
apiVersion	string This API's version.

simpleLabel

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

Simple Label (v1.0.0)

A text label and optional description.

This schema was resolved from common/simpleLabel.

Properties

Name	Description
Simple Label (v1.0.0)	object A text label and optional description. This schema was resolved from common/simpleLabel.
label	string (required) A label or title which may be used as labels or other UI controls which present a value.
description	string A more detailed localized description of a localizable label.

summaryAccount

{
  "_profile": "https://production.api.apiture.com/schemas/accounts/summaryAccount/v2.12.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/accounts/accounts/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:product": {
      "href": "https://api.devbank.apiture.com/products/products/0aba4bae-f18b-4c12-af99-5f8dbd682ae3"
    }
  },
  "name": "My savings",
  "description": "My Basic savings account",
  "interestPolicy": "capitalize",
  "usageAnswers": {
    "primaryAccount": true,
    "accountPurpose": "college savings",
    "primarySourceOfDeposits": "transfers from savings"
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "routingNumber": "021000021",
  "institutionName": "Canapi Bank",
  "state": "active",
  "title": "John Smith",
  "ifxType": "SDA",
  "allowsTransfers": true,
  "accountNumbers": {
    "full": "9876543210",
    "masked": "*************3210"
  },
  "balance": {
    "current": "3450.30",
    "available": "3450.30",
    "currency": "USD",
    "primary": "3450.30",
    "primaryLabel": "Current Balance",
    "primaryDescription": "Current balance includes deposits that have posted but are not yet available. Pending debits are not deducted from this amount."
  },
  "openedAt": "2019-04-30T10:01:07.375Z",
  "paymentsEnabled": false,
  "checkOrderingEnabled": false,
  "regDEnabled": false
}

Account Summary (v2.12.0)

Summary representation of an account resource in accounts 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.

By default, not all account fields are set when paging through accounts via the collection. The following fields are not set unless the collection request includes ?fields=*:

• balance
• interest
• cd

Additionally, the summaryAccount representation does not support the full set of links or the nested owners, beneficiaries, and authorized signers available in the account schema returned by the getAccount operation (GET /accounts/{accountId}).

Links

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

Rel	Summary	Method
self	Fetch a representation of this account	GET
apiture:product	Banking Product	GET
apiture:application	Account Application	GET

This schema was resolved from accounts/summaryAccount.

Properties

Name	Description
Account Summary (v2.12.0)	object Summary representation of an account resource in accounts 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. By default, not all account fields are set when paging through accounts via the collection. The following fields are not set unless the collection request includes ?fields=*: balance interest cd Additionally, the summaryAccount representation does not support the full set of links or the nested owners, beneficiaries, and authorized signers available in the account schema returned by the getAccount operation (GET /accounts/{accountId}). Links Response and request bodies using this summaryAccount schema may contain the following links: Rel Summary Method self Fetch a representation of this account GET apiture:product Banking Product GET apiture:application Account Application GET This schema was resolved from accounts/summaryAccount.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
name	string The user-assigned name of this account. minLength: 1 maxLength: 128
description	string The user-assigned description of this account. minLength: 1 maxLength: 4096
interestPolicy	interestPolicy How interest credits on the account (if any) are disbursed. This field is none for non-interest bearing accounts. If this is transfer, the apiture:interestTargetAccount link in the account's _link references the target account for the disbursements. This field applies if the account is a CD (Certificate of Deposit a.k.a. Time Deposit) account. enum values: none, capitalize, transfer
usageAnswers	usageAnswers Answers to the financial institution’s questions about how the user intends to use the account. This properties and values in this object is based on the financial institution's configuration. Additional Properties: true
_id	string The unique identifier for this account resource. This is an immutable opaque string. read-only
state	internalAccountState The state of the internal account. read-only enum values: pending, active, inactive, frozen, closed
title	string The name of the account holder. This is derived from the user resource. maxLength: 512
productName	string The name of the banking product that this account is an instance of. This is derived from the product resource. read-only minLength: 1 maxLength: 128
type	string The name of the banking product type. This is derived from the product resource. The subtype is more specific; type is a broad account category. read-only minLength: 1 maxLength: 128
subtype	string The name of the banking product sub type. This is derived from the product resource. This is more specific than the type. read-only minLength: 1 maxLength: 128
ifxType	ifxType A code which identifies the product type. This is one of the IFX AcctType values. enum values: CCA, CDA, CLA, CMA, DDA, EQU, GLA, ILA, INV, IRA, IRL, LOC, MLA, MMA, PBA, PPA, RWD, SDA
accountNumbers	accountNumbers Different representations of the account number.
balance	balance The account balance. read-only
allowsTransfers	boolean If true, the account is open to deposits and credits such as transfers or rollovers. read-only default: true
openedAt	string(date-time) The date-time the account was opened. This is an RFC 3339 UTC time stamp. read-only format: date-time
interest	interest Interest disbursement settings for the account.
cd	cd Certificate of Deposit properties for the account.
cycleWithdrawalCount	integer The number of withdrawals made against this account within the current statement cycle. For some deposit accounts such as savings accounts, this is limited to a maximum defined in the corresponding product's constraints. If exceeded over multiple statement cycles, the financial institution may convert the account to a demand deposit (checking) account. read-only minimum: 0
institutionName	string The name of the financial institution (FI), derived from the FI's configuration. read-only minLength: 2 maxLength: 128
routingNumber	string The account routing number which identifies the financial institution (FI). The full routing number is derived from the FI's configuration. read-only minLength: 9 maxLength: 9
paymentsEnabled	boolean If true, payments features such as bill pay are enabled and scheduled payments will debit from this account. The property paymentsEnabled was added on version 2.5.0 of the schema. The property paymentsEnabled was added on version 2.5.0 of the schema. read-only
checkOrderingEnabled	boolean If true, the user requesting this account resource may order checks for this account through the Check Orders API. The account state must be active and the associated product must also enable check ordering. The property checkOrderingEnabled was added on version 2.6.0 of the schema. The property checkOrderingEnabled was added on version 2.6.0 of the schema. read-only default: false
regDEnabled	boolean If true, the user requesting this account resource may potentially incur a fee on a transaction, with this account, that exceeds the configured transaction limit. The account state must be active and the associated product must also have RegD enabled. The property regDEnabled was added on version 2.7.0 of the schema. The property regDEnabled was added on version 2.7.0 of the schema. read-only

summaryCheckDeposit

{
  "_profile": "https://production.api.apiture.com/schemas/checkDeposits/summaryCheckDeposit/v1.2.1/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-419a"
    }
  },
  "_id": "f6c321e6-419a",
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "enteredAmount": "1023.22",
  "checkCount": 3
}

Check Deposit Summary (v1.2.1)

Summary representation of check deposit resource in collections.

Properties

Name	Description
Check Deposit Summary (v1.2.1)	object Summary representation of check deposit resource in collections.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations. This schema was resolved from common/links.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation. read-only format: uri
_error	error An object which describes an error. This value is omitted if the operation succeeded without error. read-only
_id	string The unique identifier for this account resource. This is an immutable opaque string. read-only
state	checkDepositState The state of the check deposit. This field is immutable and derived. checkDepositState strings may have one of the following enumerated values: Value Description pending Pending processing Processing valid Valid invalid Invalid submitted Submitted accepted Accepted acceptedAdjustedDown Accepted Adjusted Down acceptedAdjustedUp Accepted Adjusted Up rejected Rejected acceptedWithRejections Accepted with Rejections These enumeration values are further described by the label group named checkDepositState in the response from the getLabels operation. read-only enum values: pending, processing, valid, invalid, submitted, accepted, acceptedAdjustedDown, acceptedAdjustedUp, rejected, acceptedWithRejections
description	string Description for the deposit.
depositedAmount	string The total USD amount of the check deposit after it was successfully deposited. This number is immutable and only available after the check deposit was accepted by the FI and has state 'accepted', acceptedAdjustedDown, acceptedAdjustedUp, or 'acceptedWithRejections'. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
enteredAmount	string The USD amount of the deposit entered by the user. The numeric value is represented as a string so that it can be exact with no loss of precision.
scannedAmount	string The total USD amount of the deposit read by OCR. The numeric value is represented as a string so that it can be exact with no loss of precision. read-only
checkCount	number The current count of checks in the deposit batch. read-only
createdAt	string(date-time) The date-time the check deposit was created. This is an RFC 3339 UTC time stamp. read-only format: date-time
submittedAt	string(date-time) The date-time the check deposit was submitted. This is an RFC 3339 UTC time stamp. read-only format: date-time
acceptedAt	string(date-time) The date-time the check deposit was accepted. This does not mean the checks have cleared, only that the deposit has been posted. This is an RFC 3339 UTC time stamp. read-only format: date-time

usageAnswers

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

Usage Answers (v1.0.0)

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

This schema was resolved from accounts/usageAnswers.

Properties

Name	Description
Usage Answers (v1.0.0)	object Answers to financial institution questions on how the account is to be used. The questions correspond to the property names in questionsSchema in the configuration group accountUsageQuestions. This schema was resolved from accounts/usageAnswers. Additional Properties: true

---