increase-test
POST/lockbox_addresses

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
descriptionstringoptional
The description you choose for the Lockbox Address.

3 status codes
200Lockbox Address
addressobjectrequired
The mailing address for the Lockbox Address. It will be present after Increase generates it.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Address was created.
descriptionstringrequired
The description you choose for the Lockbox Address.
idstringrequired
The Lockbox Address identifier.
idempotency_keystringrequired
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).
statusstringrequired
The status of the Lockbox Address.
Allowed:pendingactivedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `lockbox_address`.
Allowed:lockbox_address
4XXError
5XXError