Sign in

Retrieve an Inbound Mail Item

get/inbound_mail_items/{inbound_mail_item_id}

Path parameters

inbound_mail_item_idstring required

The identifier of the Inbound Mail Item to retrieve.

Response

Inbound Mail Item

created_atstring date-time required

The ISO 8601 time at which the Inbound Mail Item was created.

file_idstring required

The identifier for the File containing the scanned contents of the mail item.

idstring required

The Inbound Mail Item identifier.

lockbox_idstring nullable required

The identifier for the Lockbox that received this mail item. For mail items that could not be processed due to an invalid address, this will be null.

recipient_namestring nullable required

The recipient name as written on the mail item.

rejection_reason'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' nullable required

If the mail item has been rejected, why it was rejected.

status'pending' | 'processed' | 'rejected' required

If the mail item has been processed.

type'inbound_mail_item' required

A constant representing the object's type. For this resource it will always be inbound_mail_item.

Example response

{
  "checks": [
    {
      "amount": 1750,
      "back_file_id": "file_makxrc67oh9l6sg7w9yc",
      "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
      "front_file_id": "file_makxrc67oh9l6sg7w9yc",
      "status": "deposited"
    },
    {
      "amount": 1750,
      "back_file_id": "file_makxrc67oh9l6sg7w9yc",
      "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
      "front_file_id": "file_makxrc67oh9l6sg7w9yc",
      "status": "deposited"
    }
  ],
  "created_at": "2020-01-31T23:59:59Z",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "inbound_mail_item_q6rrg7mmqpplx80zceev",
  "lockbox_id": "lockbox_3xt21ok13q19advds4t5",
  "recipient_name": "Ian Crease",
  "rejection_reason": null,
  "status": "processed",
  "type": "inbound_mail_item"
}

Changes