Check Deposits v0.0.1

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

The Check Deposits API allow 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 any number of Check resources to it. The apiture:uploadFrontImage and apiture:uploadBackImage _links found on a check can be used to upload check images. After a Check is created and front and back images uploaded, the check may be processed asyncronously using the apiture:process link. When processing completes, the check may contain risk factor warnings, errors, or rejections. Warnings are not required to be resolved. Errors must be resolved in order to submit the Check Deposit. Errors may be fixable by reuploading images or correcting Check data. Rejections indicate the Check is not suitable for deposit, and the check must be removed from the Check Deposit. It is strongly recommended, but not required, to process all Checks prior to submitting a Check Deposit in order to catch potential issues and allow the user to resolve.

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. Only pending Check Deposits can be modified or deleted.
• expired Expired and not available for use. Terminal.
• submitted Submitted for deposit.
• approved Approved for deposit. Terminal.
• rejected The entire Check Deposit was rejected. Terminal.
• split The Check Deposit was partially rejected. Terminal.

The Check state may be one of the following:

• pending In creation, not submitted yet.
• processing Uploaded, awaiting image processing.
• removed Check was removed from the Check Deposit. Terminal. A removed check is read only.
• submitted Check was submitted for deposit. Terminal. A submitted check is read only.
• rejected Check was rejected and not deposited. Terminal. A rejected check is read only.
• accepted Check was accepted and deposited. Terminal. An accepted check is read only.

A Check Deposit can be submitted if it contains one or more Checks that have been successfully processed with no errors or rejections.

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.apiture.com/oauth2/authorize
  • Token URL = http://auth.apiture.com/auth/oauth2/token

API

Endpoints which describe this API.

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

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

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

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 /

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

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

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

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

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

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 /apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

Check Deposit

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

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

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

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 /checkDeposits

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

Parameters

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/checkDeposits/checkDeposits/v1.0.0/profile.json",
  "start": 0,
  "limit": 10,
  "count": 1,
  "name": "check deposits",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits?start=0&limit=10"
    },
    "first": {
      "href": "/checkDeposits/checkDeposits?start=0&limit=10"
    },
    "next": {
      "href": "/checkDeposits/checkDeposits?start=10&limit=10"
    },
    "collection": {
      "href": "/checkDeposits/checkDeposits"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "f6c321e6-c628-419a-879e-ebcbc56b57fc",
        "_profile": "https://api.apiture.com/schemas/checkDeposits/summaryCheckDeposit/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc"
          },
          "apiture:target": {
            "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
          }
        },
        "state": "pending",
        "createdAt": "2019-01-20T05:54:52.375Z",
        "description": "bake sale checks",
        "amount": 1023.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

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

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "userAmount": 215.1,
  "description": "bake sale checks",
  "ipAddress": "165.166.177.74",
  "deviceUUID": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
  "deviceType": "iPhone",
  "deviceOS": "iOS",
  "deviceOSVersion": "13.2.1",
  "deviceMake": "Apple",
  "deviceModel": "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);
});

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 batch of checks to deposit

POST /checkDeposits

Create a batch of checks to deposit. A batch must be created before checks can be added or submitted. Creating the batch will return a batch id to be used in

Body parameter

{
  "_links": {
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "userAmount": 215.1,
  "description": "bake sale checks",
  "ipAddress": "165.166.177.74",
  "deviceUUID": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
  "deviceType": "iPhone",
  "deviceOS": "iOS",
  "deviceOSVersion": "13.2.1",
  "deviceMake": "Apple",
  "deviceModel": "iPhoneXs"
}

Parameters

Example responses

201 Response

{
  "_id": "f6c321e6-c628-419a-879e-ebcbc56b57fc",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/checkDeposit/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:submit": {
      "href": "/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-c628-419a-879e-ebcbc56b57fc"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "amount": 125.2,
  "checkCount": 2,
  "userAmount": 125.1,
  "scannedAmount": 125.2,
  "checks": [
    {
      "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "userAmount": 55.1,
      "scannedAmount": 55.1,
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "warnings": [
          {
            "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": "382778f4-48e6-4121-b6d9-1437cacaed9a",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Susan",
      "userAmount": 70,
      "scannedAmount": 70.1,
      "scannedAmountConfidence": 0.4,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "errors": [
          {
            "type": "scannedAmountMismatch",
            "label": "Scanned amount does not match user provided amount",
            "description": "The scanned check amount does not match the user provided input. Please correct or confirm the provided amount."
          }
        ]
      }
    }
  ]
}

Responses

Response Headers

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

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

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

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

Get the deposit

GET /checkDeposits/{depositId}

Get the deposit.

Parameters

Example responses

200 Response

{
  "_id": "f6c321e6-c628-419a-879e-ebcbc56b57fc",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/checkDeposit/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:submit": {
      "href": "/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-c628-419a-879e-ebcbc56b57fc"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "amount": 125.2,
  "checkCount": 2,
  "userAmount": 125.1,
  "scannedAmount": 125.2,
  "checks": [
    {
      "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "userAmount": 55.1,
      "scannedAmount": 55.1,
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "warnings": [
          {
            "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": "382778f4-48e6-4121-b6d9-1437cacaed9a",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Susan",
      "userAmount": 70,
      "scannedAmount": 70.1,
      "scannedAmountConfidence": 0.4,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "errors": [
          {
            "type": "scannedAmountMismatch",
            "label": "Scanned amount does not match user provided amount",
            "description": "The scanned check amount does not match the user provided input. Please correct or confirm the provided amount."
          }
        ]
      }
    }
  ]
}

Responses

Response Headers

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

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

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

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 deposit resource

DELETE /checkDeposits/{depositId}

Delete this Check Deposit resource and any resources that are owned by it. The Check Deposit must have state 'pending'.

Parameters

Example responses

404 Response

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

Responses

submitCheckDeposit

Code samples

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

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

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/submitted',
  params: {
  'depositId' => '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/submitted', params={
  'depositId': 'string'
}, headers = headers)

print r.json()

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

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

Submit a Check Deposit

POST /checkDeposits/submitted

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 from pending to submitted.

Parameters

Example responses

200 Response

{
  "_id": "f6c321e6-c628-419a-879e-ebcbc56b57fc",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/checkDeposit/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:submit": {
      "href": "/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-c628-419a-879e-ebcbc56b57fc"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "amount": 125.2,
  "checkCount": 2,
  "userAmount": 125.1,
  "scannedAmount": 125.2,
  "checks": [
    {
      "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "userAmount": 55.1,
      "scannedAmount": 55.1,
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "warnings": [
          {
            "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": "382778f4-48e6-4121-b6d9-1437cacaed9a",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Susan",
      "userAmount": 70,
      "scannedAmount": 70.1,
      "scannedAmountConfidence": 0.4,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "errors": [
          {
            "type": "scannedAmountMismatch",
            "label": "Scanned amount does not match user provided amount",
            "description": "The scanned check amount does not match the user provided input. Please correct or confirm the provided amount."
          }
        ]
      }
    }
  ]
}

Responses

Check

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "userAmount": 43.11,
  "description": "from jim"
}';
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);
});

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 deposit batch

POST /checkDeposits/{depositId}/checks

Create a new Check in the deposit batch.

Body parameter

{
  "userAmount": 43.11,
  "description": "from jim"
}

Parameters

Example responses

201 Response

{
  "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:process": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:frontImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
    },
    "apiture:backImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "userAmount": 55.1,
  "scannedAmount": 55.1,
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": 902810,
  "riskFactors": {
    "warnings": [
      {
        "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

Response Headers

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:process": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:frontImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
    },
    "apiture:backImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "userAmount": 55.1,
  "scannedAmount": 55.1,
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": 902810,
  "riskFactors": {
    "warnings": [
      {
        "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);
});

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 /checkDeposits/{depositId}/checks/{checkId}

Modify Check data. userAmount and description are the only editable fields. The Check must have state pending.

Body parameter

{
  "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:process": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:frontImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
    },
    "apiture:backImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "userAmount": 55.1,
  "scannedAmount": 55.1,
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": 902810,
  "riskFactors": {
    "warnings": [
      {
        "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

Example responses

200 Response

{
  "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:process": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:frontImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
    },
    "apiture:backImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "userAmount": 55.1,
  "scannedAmount": 55.1,
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": 902810,
  "riskFactors": {
    "warnings": [
      {
        "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

Response Headers

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

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

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

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 /checkDeposits/{depositId}/checks/{checkId}

Removes the check from the Check Deposit batch. The Check must have state 'pending'.

Parameters

Example responses

404 Response

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

Responses

getCheckImageFront

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/front',
  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/{depositId}/checks/{checkId}/images/front', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/front");
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/{depositId}/checks/{checkId}/images/front", data)
    req.Header = headers

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

Get the front image

GET /checkDeposits/{depositId}/checks/{checkId}/images/front

Get the check's front image. This operation will return single use url which can be used to download the image file. Two different version of the image can exist. Use the optional imageType query parameter if a specific version is needed. By default, the processed image type will be returned if available. If the processed version is not available, the original version will be returned.

Parameters

Example responses

200 Response

{
  "href": "https://myDownloadLocation.com/fileId"
}

Responses

getCheckImageBack

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/back',
  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/{depositId}/checks/{checkId}/images/back', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/{checkId}/images/back");
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/{depositId}/checks/{checkId}/images/back", data)
    req.Header = headers

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

Get the back image

GET /checkDeposits/{depositId}/checks/{checkId}/images/back

Get the check's front image. This operation will return single use url which can be used to download the image file. Two different version of the image can exist. Use the optional imageType query parameter if a specific version is needed. By default, the processed image type will be returned if available. If the processed version is not available, the original version will be returned.

Parameters

Example responses

200 Response

{
  "href": "https://myDownloadLocation.com/fileId"
}

Responses

processChecks

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/processed?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}/checks/processed?checkId=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

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

};

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

result = RestClient.post 'https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/processed',
  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}/checks/processed', params={
  'checkId': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/checkDeposits/checkDeposits/{depositId}/checks/processed?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}/checks/processed", data)
    req.Header = headers

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

Process a Check

POST /checkDeposits/{depositId}/checks/processed

Process a Check to validate data, perform image analysis, and return risk factors. This operation is invoked from the apiture:submit link on a Check. It is recommended to process each check prior to submitting a check deposit. A check can only be processed when in pending state. Due to the async nature of image analysis, when a check is processed it will transition to state processing until complete, then transition back to pending.

Parameters

Example responses

200 Response

{
  "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:process": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:frontImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
    },
    "apiture:backImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "userAmount": 55.1,
  "scannedAmount": 55.1,
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": 902810,
  "riskFactors": {
    "warnings": [
      {
        "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

Schemas

checkDeposits

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

Check Deposits Collection

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

summaryCheckDeposit

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

Check Deposit Summary

Summary representation of check deposit resource in collections.

Properties

createCheckDeposit

{
  "_links": {
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    }
  },
  "userAmount": 215.1,
  "description": "bake sale checks",
  "ipAddress": "165.166.177.74",
  "deviceUUID": "8b1e09ee-49cd-47c1-bd72-837432296e3c",
  "deviceType": "iPhone",
  "deviceOS": "iOS",
  "deviceOSVersion": "13.2.1",
  "deviceMake": "Apple",
  "deviceModel": "iPhoneXs"
}

Create Check Deposit Fields

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

Properties

createCheck

{
  "userAmount": 43.11,
  "description": "from jim"
}

Create Check Fields

Create a new check.

Properties

checkDeposit

{
  "_id": "f6c321e6-c628-419a-879e-ebcbc56b57fc",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/checkDeposit/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc"
    },
    "apiture:target": {
      "href": "/accounts/accounts/599b8ab5-6925-4f58-90c5-f6aa5b05f9d9"
    },
    "apiture:submit": {
      "href": "/checkDeposits/checkDeposits/submitted?depositId=f6c321e6-c628-419a-879e-ebcbc56b57fc"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "bake sale checks",
  "amount": 125.2,
  "checkCount": 2,
  "userAmount": 125.1,
  "scannedAmount": 125.2,
  "checks": [
    {
      "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Jim",
      "userAmount": 55.1,
      "scannedAmount": 55.1,
      "scannedAmountConfidence": 0.92,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "warnings": [
          {
            "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": "382778f4-48e6-4121-b6d9-1437cacaed9a",
      "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
      "_links": {
        "self": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:uploadFrontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front/content"
        },
        "apiture:uploadBackImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back/content"
        },
        "apiture:process": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=382778f4-48e6-4121-b6d9-1437cacaed9a"
        },
        "apiture:frontImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/front"
        },
        "apiture:backImage": {
          "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/382778f4-48e6-4121-b6d9-1437cacaed9a/images/back"
        }
      },
      "state": "pending",
      "createdAt": "2019-01-20T05:54:52.375Z",
      "description": "check from Susan",
      "userAmount": 70,
      "scannedAmount": 70.1,
      "scannedAmountConfidence": 0.4,
      "scannedMicr": "V902810V T121143260T333222444V",
      "scannedCheckNumber": 902810,
      "riskFactors": {
        "errors": [
          {
            "type": "scannedAmountMismatch",
            "label": "Scanned amount does not match user provided amount",
            "description": "The scanned check amount does not match the user provided input. Please correct or confirm the provided amount."
          }
        ]
      }
    }
  ]
}

Check Deposit

Check deposit resource. Checks are added to this before being deposited. The URI of the account to deposit into will be included in _links apiture:target

Properties

check

{
  "_id": "999a1163-6e32-47fd-b9b8-085e198729b2",
  "_profile": "https://api.apiture.com/schemas/checkDeposits/check/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:process": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/processed?checkId=999a1163-6e32-47fd-b9b8-085e198729b2"
    },
    "apiture:frontImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/front"
    },
    "apiture:backImage": {
      "href": "/checkDeposits/checkDeposits/f6c321e6-c628-419a-879e-ebcbc56b57fc/checks/999a1163-6e32-47fd-b9b8-085e198729b2/images/back"
    }
  },
  "state": "pending",
  "createdAt": "2019-01-20T05:54:52.375Z",
  "description": "check from Jim",
  "userAmount": 55.1,
  "scannedAmount": 55.1,
  "scannedAmountConfidence": 0.92,
  "scannedMicr": "V902810V T121143260T333222444V",
  "scannedCheckNumber": 902810,
  "riskFactors": {
    "warnings": [
      {
        "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

Check resource.

Properties

riskFactor

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

Risk Factor

Diagnostic information about the check.

Properties

fileLink

{
  "href": "https://myDownloadLocation.com/fileId"
}

File Link

A link to a file location to upload or download.

Properties

checkDepositState

"submitted"

Check Deposit State

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

Type: string
Enumerated values:
pending
processing
expired
submitted
approved
rejected
split

checkState

"processing"

Check State

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

Type: string
Enumerated values:
pending
processing
removed
submitted
accepted
rejected

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

API Root

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

Properties

errorResponse

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

Error Response

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

Properties

collection

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://developer.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection

A collection of resources.

Properties