Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Increase Inbound Mail Items API

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.

Increase Inbound Mail Items API is one of 56 APIs that Increase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Inbound Mail Items. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against 2 base URLs: https://api.increase.com, https://sandbox.increase.com.

3 operations 3 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.increase.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Increase Inbound Mail Items API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Inbound Mail Items 3

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.

GET
/inbound_mail_items
List Inbound Mail Items
list_inbound_mail_items 8 params → 2004XX5XX
GET
/inbound_mail_items/{inbound_mail_item_id}
Retrieve an Inbound Mail Item
retrieve_an_inbound_mail_item 1 param → 2004XX5XX
POST
/inbound_mail_items/{inbound_mail_item_id}/action
Action an Inbound Mail Item
action_an_inbound_mail_item 1 param body → 2004XX5XX

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are inbound_mail_item (10 properties), inbound_mail_item_check (5 properties), inbound_mail_item_list (2 properties), action_an_inbound_mail_item_parameters (1 property). Each schema is shown below with its type and property counts.

error
inbound_mail_item_check
object
Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
5 properties 5 required
action_an_inbound_mail_item_parameters
object
1 property 1 required
inbound_mail_item
object
Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.
10 properties 10 required
inbound_mail_item_list
object
A list of Inbound Mail Item objects.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-inbound-mail-items-api-openapi.yml Raw ↑

Other APIs Increase publishes across the network.

Increase Account Numbers API
Increase Account Statements API
Increase Account Transfers API
Increase Accounts API
Increase Ach Prenotifications API
Increase Ach Transfers API
Increase Card Disputes API
Increase Card Payments API
Increase Card Purchase Supplements API
Increase Card Push Transfers API
Increase Card Tokens API
Increase Card Validations API