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 Lockbox Addresses API

Lockbox Addresses are physical locations that can receive mail containing paper checks.

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

Tagged areas include Lockbox Addresses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 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.

4 operations 2 paths 5 schemas 2 GET1 PATCH1 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 Lockbox Addresses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Lockbox Addresses 4

Lockbox Addresses are physical locations that can receive mail containing paper checks.

GET
/lockbox_addresses
List Lockbox Addresses
list_lockbox_addresses 7 params → 2004XX5XX
POST
/lockbox_addresses
Create a Lockbox Address
create_a_lockbox_address body → 2004XX5XX
GET
/lockbox_addresses/{lockbox_address_id}
Retrieve a Lockbox Address
retrieve_a_lockbox_address 1 param → 2004XX5XX
PATCH
/lockbox_addresses/{lockbox_address_id}
Update a Lockbox Address
update_a_lockbox_address 1 param body → 2004XX5XX

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are lockbox_address (7 properties), lockbox_address_list (2 properties), update_a_lockbox_address_parameters (2 properties), create_a_lockbox_address_parameters (1 property). Each schema is shown below with its type and property counts.

lockbox_address
object
Lockbox Addresses are physical locations that can receive mail containing paper checks.
7 properties 7 required
error
update_a_lockbox_address_parameters
object
2 properties
create_a_lockbox_address_parameters
object
1 property
lockbox_address_list
object
A list of Lockbox Address objects.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

increase-lockbox-addresses-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