v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Retrieve a Lockbox Address

get/lockbox_addresses/{lockbox_address_id}

Path parameters

lockbox_address_idstring required

The identifier of the Lockbox Address to retrieve.

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