Lockbox Recipients

Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for a Lockbox Recipient are deposited into its associated Account.

Events

Your application can listen to webhooks about this resource. The events about Lockbox Recipients will have the categories "lockbox.created" or "lockbox.updated" .

The Lockbox Recipient object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "description": null,
  "id": "lockbox_3xt21ok13q19advds4t5",
  "idempotency_key": null,
  "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
  "mail_stop_code": "VRE6P",
  "recipient_name": "Company Inc.",
  "status": "active",
  "type": "lockbox_recipient"
}

Attributes

account_id

string

The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.

More about Accounts.

created_at

string

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

description

string

Nullable

The description of the Lockbox Recipient.

string

The Lockbox Recipient 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.

lockbox_address_id

string

The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.

More about Lockbox Addresses.

mail_stop_code

string

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_name

string

Nullable

The name of the Lockbox Recipient.

status

enum

Nullable

The status of the Lockbox Recipient.

type

string

A constant representing the object’s type. For this resource it will always be lockbox_recipient.

List Lockbox Recipients

curl \
  --url "${INCREASE_URL}/lockbox_recipients" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Lockbox Recipient object */ },
    { /* Lockbox Recipient object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Lockbox Recipients to those associated with the provided Account.

More about Accounts.

lockbox_address_id

string

Filter Lockbox Recipients to those associated with the provided Lockbox Address.

More about Lockbox Addresses.

idempotency_key

string

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.

Between 1 and 200 characters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create a Lockbox Recipient

curl -X "POST" \
  --url "${INCREASE_URL}/lockbox_recipients" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
    "recipient_name": "Ian Crease"
  }'

Parameters

account_id

string

Required

The Account that checks sent to this Lockbox Recipient should be deposited into.

More about Accounts.

description

string

The description you choose for the Lockbox Recipient.

Between 1 and 200 characters

lockbox_address_id

string

Required

The Lockbox Address where this Lockbox Recipient may receive mail.

More about Lockbox Addresses.

recipient_name

string

The name of the Lockbox Recipient

Between 1 and 200 characters

Retrieve a Lockbox Recipient

curl \
  --url "${INCREASE_URL}/lockbox_recipients/lockbox_3xt21ok13q19advds4t5" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

lockbox_recipient_id

string

Required

The identifier of the Lockbox Recipient to retrieve.

More about Lockbox Recipients.

Update a Lockbox Recipient

curl -X "PATCH" \
  --url "${INCREASE_URL}/lockbox_recipients/lockbox_3xt21ok13q19advds4t5" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "active"
  }'

Parameters

lockbox_recipient_id

string

Required

The identifier of the Lockbox Recipient.

More about Lockbox Recipients.

description

string

The description you choose for the Lockbox Recipient.

Between 1 and 200 characters

recipient_name

string

The name of the Lockbox Recipient.

Between 1 and 200 characters

status

enum

The status of the Lockbox Recipient.