Sign in

v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

Create a Lockbox Address

The Lockbox Address starts with a pending status and a null address. Shortly after creation, Increase generates the mailing address and the status becomes active. You can only create Lockbox Recipients for an active Lockbox Address.

post/lockbox_addresses

Request body

descriptionstring

The description you choose for the Lockbox Address.

Example request

{
  "description": "Lockbox Address 1"
}

Response

Lockbox Address

created_atstring date-time required

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

descriptionstring nullable required

The description you choose for the Lockbox Address.

idstring required

The Lockbox Address identifier.

idempotency_keystring nullable required

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'pending' | 'active' | 'disabled' | 'canceled' required

The status of the Lockbox Address.

type'lockbox_address' required

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

Example response

{
  "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"
}