Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Overview
Accounts
Transactions
Ach Transfers
Check Transfers
Real Time Payments Transfers
Fednow Transfers
Swift Transfers
Wire Transfers
Card Transfers
Check Deposits
Cards
Compliance
Events and Webhooks
External Accounts
Files and Exports
OAuth
Intrafi
Lockbox Addresses

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

The Lockbox Address object
{
  "address": {
    "city": "San Francisco",
    "line1": "1234 Market St",
    "line2": "Ste 567",
    "postal_code": "94114",
    "state": "CA"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Lockbox Address 1",
  "id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
  "idempotency_key": null,
  "status": "active",
  "type": "lockbox_address"
}
Attributes
address
dictionary
Nullable

The mailing address for the Lockbox Address. It will be present after Increase generates it.

created_at
string

The ISO 8601 time at which the Lockbox Address was created.

description
string
Nullable

The description you choose for the Lockbox Address.

id
string

The Lockbox Address identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

status
enum

The status of the Lockbox Address.

type
string

A constant representing the object’s type. For this resource it will always be lockbox_address.

List Lockbox Addresses
curl \
  --url "${INCREASE_URL}/lockbox_addresses" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a list response:
{
  "data": [
    { /* Lockbox Address object */ },
    { /* Lockbox Address object */ }
    / * ... */
  ],
  "next_cursor": "v57w5d",
}
Parameters
idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters
More
cursor
string
limit
integer
created_at.after
string
created_at.before
string
created_at.on_or_after
string
created_at.on_or_before
string
Create a Lockbox Address
curl -X "POST" \
  --url "${INCREASE_URL}/lockbox_addresses" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "description": "Lockbox Address 1"
  }'
Parameters
description
string

The description you choose for the Lockbox Address.

Between 1 and 200 characters
Retrieve a Lockbox Address
curl \
  --url "${INCREASE_URL}/lockbox_addresses/lockbox_address_lw6sbzl9ol5dfd8hdml6" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
lockbox_address_id
string
Required

The identifier of the Lockbox Address to retrieve.

More about Lockbox Addresses.
Update a Lockbox Address
curl -X "PATCH" \
  --url "${INCREASE_URL}/lockbox_addresses/lockbox_address_lw6sbzl9ol5dfd8hdml6" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "disabled"
  }'
Parameters
lockbox_address_id
string
Required

The identifier of the Lockbox Address.

More about Lockbox Addresses.
description
string

The description you choose for the Lockbox Address.

Between 1 and 200 characters
status
enum

The status of the Lockbox Address.