Increase Lockbox Recipients API
Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.
Increase Lockbox Recipients 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 Recipients. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Increase Lockbox Recipients 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 Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are lockbox_recipient (10 properties), create_a_lockbox_recipient_parameters (4 properties), update_a_lockbox_recipient_parameters (3 properties), lockbox_recipient_list (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Increase 12
Other APIs Increase publishes across the network.