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

## The Lockbox Address object
### Example
```json
{
  "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.

  - `address.city` (string)
    The city of the address.

  - `address.line1` (string)
    The first line of the address.

  - `address.line2` (string)
    The second line of the address.

  - `address.postal_code` (string)
    The postal code of the address.

  - `address.state` (string)
    The two-letter United States Postal Service (USPS) abbreviation for the state of the address.

- `created_at` (string)
  The [ISO 8601](https://en.wikipedia.org/wiki/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](https://increase.com/documentation/idempotency-keys).

- `status` (enum)
  The status of the Lockbox Address.
  Cases:
  * `pending` (Increase is generating this Lockbox Address.)
  * `active` (This Lockbox Address is active.)
  * `disabled` (This Lockbox Address is disabled.)
  * `canceled` (This Lockbox Address is permanently disabled.)

- `type` (string)
  A constant representing the object's type. For this resource it will always be `lockbox_address`.

## List Lockbox Addresses
GET /lockbox_addresses

### Example
```curl
curl \
  --url "${INCREASE_URL}/lockbox_addresses" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

- `created_at.after` (string, optional)
  Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.before` (string, optional)
  Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_after` (string, optional)
  Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_before` (string, optional)
  Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `idempotency_key` (string, optional)
  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](https://increase.com/documentation/idempotency-keys).

### Returns a Lockbox Address List object:
```json
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Create a Lockbox Address
POST /lockbox_addresses

### Example
```curl
curl -X "POST" \
  --url "${INCREASE_URL}/lockbox_addresses" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "description": "Lockbox Address 1"
  }'
```

### Body Parameters
- `description` (string, optional)
  The description you choose for the Lockbox Address.

## Retrieve a Lockbox Address
GET /lockbox_addresses/{lockbox_address_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/lockbox_addresses/lockbox_address_lw6sbzl9ol5dfd8hdml6" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path Parameters
- `lockbox_address_id` (string, required)
  The identifier of the Lockbox Address to retrieve.

## Update a Lockbox Address
PATCH /lockbox_addresses/{lockbox_address_id}

### Example
```curl
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"
  }'
```
### Path Parameters
- `lockbox_address_id` (string, required)
  The identifier of the Lockbox Address.

### Body Parameters
- `description` (string, optional)
  The description you choose for the Lockbox Address.

- `status` (enum, optional)
  The status of the Lockbox Address.
  Cases:
  * `active` (This Lockbox Address is active.)
  * `disabled` (This Lockbox Address is disabled.)
  * `canceled` (This Lockbox Address is permanently disabled.)