increase-test
GET/lockbox_recipients/{lockbox_recipient_id}

Retrieve a Lockbox Recipient

Retrieves a Lockbox Recipient inbox and its associated Account and Lockbox Address. Use lockbox_recipient_id to identify the recipient and review its status, mail stop code, and other details.

1 parameter
lockbox_recipient_idstringrequired
The identifier of the Lockbox Recipient to retrieve.

3 status codes
200Returns the Lockbox Recipient object, including its associated Account and Lockbox Address, status, and mail stop code.
account_idstringrequired
The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Recipient was created.
descriptionstringrequired
The description of the Lockbox Recipient.
idstringrequired
The Lockbox Recipient 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).
lockbox_address_idstringrequired
The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.
mail_stop_codestringrequired
The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Address. It should be included in the mailing address intended for this Lockbox Recipient.
recipient_namestringrequired
The name of the Lockbox Recipient.
statusstringrequired
The status of the Lockbox Recipient.
Allowed:activedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `lockbox_recipient`.
Allowed:lockbox_recipient
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

The lockbox_recipient_id path parameter must identify an existing Lockbox Recipient.