Create a check (BILLABLE + DRAWS FUNDS)
lob_checks_createCommit a check send to mail a physical check. Requires a verified bank account and recipient address; optionally preview and confirm in live mode.
Instructions
Commit a check send. HIGH IMPACT: incurs Lob fees AND draws the check amount from the linked bank account when cashed. Requires a verified bank account ID (bank_…). In live mode, requires a confirmation_token from lob_checks_preview that matches the current payload. If LOB_REQUIRE_ELICITATION_FOR_CHECKS_OVER_USD is set and amount exceeds it, an elicitation form must be confirmed by the user before dispatch.
For the bottom of the check page, Lob requires exactly one of message (plain text, max 400 chars) or check_bottom (custom template / HTML / PDF, typically paired with merge_variables).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Recipient address. Either a saved address ID (`adr_…`) or an inline address. | |
| from | Yes | Sender (return) address. Either a saved address ID (`adr_…`) or an inline address. | |
| logo | No | Logo printed on the check face (upper-left, grayscale; PNG or JPG). | |
| memo | No | Memo line on the check (max 40 chars). | |
| extra | No | Additional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource. | |
| amount | Yes | Check amount in USD (e.g. 125.50). | |
| message | No | Plain-text message printed on the bottom of the check page (max 400 chars). Mutually exclusive with `check_bottom`. | |
| metadata | No | Up to 20 string key/value pairs to attach to the resource. | |
| use_type | No | Required for some mail classes. 'marketing' for promotional, 'operational' for transactional. | |
| mail_type | No | Mail class. Defaults to usps_first_class for most pieces. | |
| send_date | No | ISO 8601 timestamp (e.g. '2026-05-01T00:00:00Z') to schedule the send. Must be at most 180 days in the future. | |
| attachment | No | Secondary document included in the envelope after the check page. Up to 6 pages. | |
| description | No | Internal description (max 255 chars). | |
| bank_account | Yes | Verified Lob bank account ID. | |
| check_bottom | No | Custom artwork for the bottom half of the check page. Accepts a Lob template ID (`tmpl_…`), an HTML string, an https:// URL, or a base64 PDF. Mutually exclusive with `message`. | |
| check_number | No | Optional check number; auto-assigned if omitted. | |
| idempotency_key | No | Idempotency key (max 256 chars). If omitted, the server auto-generates a value derived from the confirmation_token when present, otherwise a fresh UUIDv4. Lob deduplicates identical keys for 24 hours. | |
| merge_variables | No | Key/value pairs substituted into Handlebars-style {{variables}} in your HTML/template content. | |
| billing_group_id | No | Billing group ID (`bg_…`) to attribute the charge to. | |
| confirmation_token | No | Token from lob_checks_preview. Required in live mode (LOB_LIVE_MODE=true). |