Skip to content
Virtual Mail - API Documentation

Get Requested Check Deposits

GET
/inboxes/{inbox_id}/check-deposit-requests

Returns check deposit requests for the given inbox. Includes details about checks found, bank account, deposit slips, and shipment tracking.

Authorizations

Section titled “Authorizations”

Send your API key in the x-api-key header. See Authentication.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
inbox_id
required
string

Query Parameters

Section titled “Query Parameters ”
page
integer

The desired page from the result set. Defaults to 1.

per_page
integer

The number of items per page. Defaults to 100.

has_checks
integer

When set to 1, only returns deposit requests where checks were found.

sort_by
string

Field to sort results by. Allowed values: requested_at, extracted_at.

sort_direction
string

Sort order. Allowed values: asc, desc.

date_from
string format: date

Filter results to deposits created after this date.

date_to
string format: date

Filter results to deposits created before this date.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
total

Total number of items across all pages.

integer
15
per_page

Number of items per page.

integer
100
current_page

The current page number (1-based).

integer
1
last_page

The last available page number.

integer
1
from

The index of the first item on this page (1-based).

integer
1
to

The index of the last item on this page (1-based).

integer
15
data
Array<object>
object
id
integer
created_at
string format: date-time
updated_at
string format: date-time
operation_action
string
check-deposit
operation_status
string
tags
Array<string>
check_deposit_bank_account_id
integer | null
status

Opened while the request is in progress, then Shipped once the checks are on their way to the bank. Cancelled and Error end a request without a deposit.

string
Shipped
expedited

Whether overnight delivery to the bank was requested. See expedited in Request Check Deposit.

boolean
bank_account
object
id
integer
created_at
string format: date-time
updated_at
string format: date-time
inbox_id
integer | null
routing_number
string
121000248
check_processing_system_type
integer
account_number
string
********4510
account_display_name
string
Business Checking
account_type
string
checking
financial_institution
object
id
integer
name
string
First National Bank
routing_number
string
has_shipping_address
boolean
shipping_banking_institution_id
integer | null
expedited

When true, every deposit to this bank ships overnight at no extra cost, so there’s no need to request expedited.

boolean
shipping_addresses
Array<object>
object
id
integer
123456
created_at
string format: date-time
updated_at
string format: date-time
addressee
string
Molly Smith
address_line_1
string
1004 S Mt Olive St
address_line_2
string
locality
string
PHOENIX
region_abbreviation
string
AZ
region
string
Arizona
country_abbreviation
string
US
country
string
United States
postal_code
string
72761
phone
string
tags
Array<string>
[
  "domestic"
]
delivery_confidence_percent
number | null
inbox_id
integer | null
company
string | null
is_authorized
boolean | null
requires_hs_tariff_codes
boolean | null
requires_itn
boolean | null
rdc
boolean
rdcVerified
boolean
contact_name
string
contact_business
string
contact_address
string
contact_phone
string
rdc
boolean
resubmittable
boolean
checks
Array<object>
object
id
integer
amount_in_cents
integer
150000
check_number
string
008451
piece_id
integer
media
Array<object>
object
id
string
1_1_2_0_0
url
string
content_type
string
image/jpg
tags
Array<string>
[
  "color",
  "large",
  "enclosure",
  "front"
]
url_valid_until
string format: date-time
file_size_in_bytes
integer
shipment
One of:
object
id
integer | null
carrier
string
USPS
carrier_service
string
Priority
tracking_number
string
external_id
string | null
shipped_at
string format: date-time
expected_delivery_at
string format: date-time
delivered_at
string format: date-time
inbox_id
integer | null
post_operation_action
One of:
object
type
required

store keeps the piece, shred shreds it.

string
Allowed values: store shred
piece_id
integer
deposit_slips
Array<object>
object
id
string
1_1_2_0_0
url
string
content_type
string
image/jpg
tags
Array<string>
[
  "color",
  "large",
  "enclosure",
  "front"
]
url_valid_until
string format: date-time
file_size_in_bytes
integer
requested_at
string format: date-time
extracted_at
string format: date-time
check_processing_system_type
integer
validate_only
boolean
scan_page_number
integer
piece
One of:
object
id
integer
14460059
created_at
string format: date-time
updated_at
string format: date-time
inbox_id
integer
97599
barcode
string
0000000101 0016615290
license_plate
integer
433808312186
recipient
object
id
integer
122028
name
string
Bruce Wayne
inbox_id
integer | null
97599
type
string
mailbox_folder_id
integer
0
tags
Array<string>
[
  "unscanned",
  "read",
  "inbox",
  "stored"
]
attributes
Array<string>
[
  "unscanned",
  "read",
  "inbox",
  "stored"
]
sender
One of:
object
name
string
address
string
received_at
string format: date-time
date_arrived_in_mailbox
string format: date-time
weight_in_ounces
number
0.16
facility_name
string
page_count_estimate
integer
2
page_count_actual
integer | null
height_in_inches
number
3.9
depth_in_inches
number
0.1
length_in_inches
number
8.88
carrier
object
name
string
Unknown
class
string
Unknown
media
Array
object
id
string
1_1_2_0_0
url
string
content_type
string
image/jpg
tags
Array<string>
[
  "color",
  "large",
  "enclosure",
  "front"
]
url_valid_until
string format: date-time
file_size_in_bytes
integer
piece_id
integer | null
14460059
scan_id
integer | null
page_count
integer | null
1
sequence_number
integer | null
ocr_data
string
envelope_ocr_data
string
piece_type
string
mail
piece_sub_type
string
letter
insights
Array<object>
object
type
string
confidence
number
user_defined_tags
Array<object>
object
id
integer
3001
created_at
string format: date-time
updated_at
string format: date-time
label
string
Urgent
parent_tag_id
integer | null
piece_counts
integer | null
12
matched_by
Array<string>
operation_action
string | null
end_user_operation_status
string | null
storage_fee_amount_in_cents
integer
can_delete_scan_only
boolean
available_actions
Array<string>
name
string
detected_checks_count
integer | null
recipient_type
string
date_arrived_at
string format: date-time
deposit_slip_ids
Array<integer>
Example
{
  "current_page": 1,
  "data": [
    {
      "id": 100001,
      "created_at": "2020-05-10T10:00:00Z",
      "updated_at": "2020-05-15T12:00:00Z",
      "operation_action": "check-deposit",
      "operation_status": "complete",
      "status": "Shipped",
      "check_deposit_bank_account_id": 500,
      "piece_id": 100002,
      "inbox_id": 100003,
      "expedited": false,
      "resubmittable": false,
      "requested_at": "2020-05-10T09:41:00Z",
      "extracted_at": "2020-05-10T10:05:33Z",
      "date_arrived_at": "2020-05-08T14:22:08Z",
      "check_processing_system_type": 0,
      "validate_only": false,
      "scan_page_number": 0,
      "post_operation_action": null,
      "bank_account": {
        "id": 500,
        "created_at": "2020-01-15T10:00:00Z",
        "updated_at": "2020-01-15T10:00:00Z",
        "inbox_id": 100003,
        "routing_number": "121000248",
        "account_number": "********4510",
        "account_display_name": "Business Checking",
        "account_type": "checking",
        "check_processing_system_type": 0,
        "financial_institution": {
          "name": "First National Bank"
        }
      },
      "checks": [
        {
          "amount_in_cents": 150000,
          "check_number": "008451",
          "piece_id": 100002,
          "media": [
            {
              "content_type": "image/jpg",
              "tags": [
                "front",
                "large"
              ],
              "url": "https://media.earthclassmail.com/..."
            }
          ]
        }
      ],
      "deposit_slips": [
        {
          "content_type": "application/pdf",
          "tags": [
            "deposit-slip"
          ],
          "url": "https://media.earthclassmail.com/..."
        }
      ],
      "shipment": {
        "id": 100004,
        "carrier": "USPS",
        "carrier_service": "Priority",
        "tracking_number": "9405500000000000000001",
        "external_id": null,
        "shipped_at": "2020-05-11T18:30:00Z",
        "expected_delivery_at": "2020-05-14T12:00:00Z",
        "delivered_at": "2020-05-13T11:45:00Z"
      },
      "piece": null
    }
  ],
  "from": 1,
  "last_page": 1,
  "per_page": 100,
  "to": 1,
  "total": 1
}

401

Section titled “401 ”

The x-api-key header is missing or the key is not valid, or the caller can’t access an ID in the request. IDs that don’t exist return the same response as IDs the caller can’t access.

Error envelope returned with 4xx and 5xx responses.

object
error
object
code

Usually the HTTP status code. It can differ; a request to an unknown path returns HTTP 400 with code 500.

integer
401
message

Human-readable description of the error.

string
type

The kind of error, for example Authorization or REST.

string
REST
fields

Returned only with 422 responses. It may give more details about what failed validation, as lists of messages keyed by the name of the input.

object
key
additional properties
Array<string>
Examples
{
  "error": {
    "code": 401,
    "message": "The request does not include a valid access token. Please provide a valid access token.",
    "type": "Authorization"
  }
}

© LegalZoom.com, Inc. All rights reserved.

LegalZoom provides access to independent attorneys and self-service tools. LegalZoom is not a law firm and does not provide legal advice, except where authorized through its subsidiary law firm LZ Legal Services, LLC. Use of our products and services is governed by our Terms of Use and Privacy Policy.

AI-readable documentation index: llms.txt