bo_id
{
"type": "string",
"pattern": "^bo_[a-zA-Z0-9]+$",
"description": "Unique identifier prefixed with `bo_`."
}
buckslip
{
"allOf": [
{
"$ref": "#/components/schemas/lob_base"
},
{
"$ref": "#/components/schemas/buckslip_base"
},
{
"required": [
"description"
]
},
{
"type": "object",
"required": [
"id",
"auto_reorder",
"reorder_quantity",
"threshold_amount",
"url",
"raw_url",
"front_original_url",
"back_original_url",
"thumbnails",
"available_quantity",
"allocated_quantity",
"onhand_quantity",
"pending_quantity",
"projected_quantity",
"buckslip_orders",
"stock",
"weight",
"finish",
"status",
"object"
],
"properties": {
"id": {
"$ref": "#/components/schemas/buckslip_id"
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The signed link for the buckslip."
},
"stock": {
"enum": [
"text",
"cover"
],
"type": "string",
"title": "The stock of the buckslip."
},
"finish": {
"enum": [
"gloss",
"matte"
],
"type": "string",
"title": "The finish of the buckslip."
},
"object": {
"enum": [
"buckslip"
],
"type": "string",
"default": "buckslip",
"description": "object"
},
"status": {
"enum": [
"processed",
"rendered",
"failed"
],
"type": "string",
"title": "The status of the buckslip."
},
"weight": {
"enum": [
"80#"
],
"type": "string",
"title": "The weight of the buckslip."
},
"raw_url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The raw URL of the buckslip."
},
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/thumbnail"
}
},
"auto_reorder": {
"type": "boolean",
"default": false,
"description": "True if the buckslips should be auto-reordered."
},
"buckslip_orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/buckslip_order"
},
"minItems": 0,
"description": "An array of buckslip orders that are associated with the buckslip."
},
"onhand_quantity": {
"type": "number",
"default": 0,
"description": "The onhand quantity of buckslips."
},
"pending_quantity": {
"type": "number",
"default": 0,
"description": "The pending quantity of buckslips."
},
"reorder_quantity": {
"type": "integer",
"nullable": true,
"description": "The number of buckslips to be reordered."
},
"threshold_amount": {
"type": "integer",
"default": 0,
"description": "The threshold amount of the buckslip"
},
"back_original_url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The original URL of the back template."
},
"allocated_quantity": {
"type": "number",
"default": 0,
"description": "The allocated quantity of buckslips."
},
"available_quantity": {
"type": "number",
"default": 0,
"description": "The available quantity of buckslips."
},
"front_original_url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The original URL of the front template."
},
"projected_quantity": {
"type": "number",
"default": 0,
"description": "The sum of pending and onhand quantities of buckslips."
}
}
}
]
}
buckslip_base
{
"type": "object",
"properties": {
"size": {
"enum": [
"8.75x3.75"
],
"type": "string",
"default": "8.75x3.75",
"description": "The size of the buckslip"
},
"description": {
"$ref": "#/components/schemas/buckslip_description"
}
}
}
buckslip_deletion
{
"properties": {
"id": {
"$ref": "#/components/schemas/buckslip_id"
},
"deleted": {
"$ref": "#/components/schemas/deleted"
}
},
"description": "Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end."
}
buckslip_description
{
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "Description of the buckslip."
}
buckslip_editable
{
"allOf": [
{
"$ref": "#/components/schemas/buckslip_base"
},
{
"type": "object",
"required": [
"front"
],
"properties": {
"back": {
"oneOf": [
{
"$ref": "#/components/schemas/remote_file_url"
},
{
"$ref": "#/components/schemas/local_file_path"
}
],
"description": "A PDF template for the back of the buckslip"
},
"front": {
"oneOf": [
{
"$ref": "#/components/schemas/remote_file_url"
},
{
"$ref": "#/components/schemas/local_file_path"
}
],
"description": "A PDF template for the front of the buckslip"
}
}
}
]
}
buckslip_id
{
"type": "string",
"pattern": "^bck_[a-zA-Z0-9]+$",
"description": "Unique identifier prefixed with `bck_`."
}
buckslip_order
{
"allOf": [
{
"$ref": "#/components/schemas/lob_base"
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/bo_id"
},
"status": {
"enum": [
"pending",
"printing",
"available",
"cancelled",
"depleted"
],
"type": "string",
"description": "The status of the buckslip order."
},
"inventory": {
"type": "number",
"default": 0,
"description": "The inventory of the buckslip order."
},
"unit_price": {
"type": "number",
"default": 0,
"description": "The unit price for the buckslip order."
},
"buckslip_id": {
"$ref": "#/components/schemas/buckslip_id"
},
"cancelled_reason": {
"type": "string",
"description": "The reason for cancellation."
},
"quantity_ordered": {
"type": "number",
"default": 0,
"description": "The quantity of buckslips ordered."
},
"availability_date": {
"type": "string",
"format": "date-time",
"description": "A timestamp in ISO 8601 format of the date the resource was created."
},
"expected_availability_date": {
"type": "string",
"format": "date-time",
"description": "The fixed deadline for the buckslips to be printed."
}
}
}
]
}
buckslip_order_editable
{
"type": "object",
"required": [
"quantity"
],
"properties": {
"quantity": {
"type": "integer",
"maximum": 10000000,
"minimum": 5000,
"description": "The quantity of buckslips in the order (minimum 5,000)."
}
}
}
buckslip_updatable
{
"type": "object",
"properties": {
"description": {
"$ref": "#/components/schemas/buckslip_description"
},
"auto_reorder": {
"type": "boolean",
"description": "Allows for auto reordering"
},
"reorder_quantity": {
"type": "number",
"maximum": 10000000,
"minimum": 5000,
"description": "The quantity of items to be reordered (only required when auto_reorder is true)."
}
}
}
campaign
{
"allOf": [
{
"$ref": "#/components/schemas/lob_base"
},
{
"$ref": "#/components/schemas/campaign_writable"
},
{
"type": "object",
"required": [
"id",
"name",
"description",
"schedule_type",
"use_type",
"is_draft",
"creatives",
"uploads",
"auto_cancel_if_ncoa",
"date_created",
"date_modified",
"object"
],
"properties": {
"id": {
"$ref": "#/components/schemas/cmp_id"
},
"object": {
"enum": [
"campaign"
],
"type": "string",
"default": "campaign",
"description": "Value is resource type."
},
"uploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/upload"
},
"maxItems": 1,
"minItems": 0,
"description": "A single-element array containing the upload object that is assocated with this campaign."
},
"is_draft": {
"type": "boolean",
"default": true,
"description": "Whether or not the campaign is still a draft."
},
"use_type": {
"$ref": "#/components/schemas/cmp_use_type"
},
"creatives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/creative"
},
"minItems": 0,
"description": "An array of creatives that have been associated with this campaign."
}
}
}
]
}
campaign_id
{
"type": "string",
"title": "campaign_id",
"pattern": "^(cmp|camp)_[a-zA-Z0-9]+$",
"nullable": true,
"description": "Denotes resources created by the provided campaign id, prefixed with `cmp_`. In the case of snap packs and letters with size `us_legal`, the campaign id is prefixed with `camp_` instead of `cmp_`."
}
campaign_item
{
"allOf": [
{
"$ref": "#/components/schemas/campaign_writable"
},
{
"type": "object",
"required": [
"id",
"name",
"description",
"schedule_type",
"use_type",
"is_draft",
"creatives",
"uploads",
"auto_cancel_if_ncoa",
"date_created",
"date_modified",
"object"
],
"properties": {
"id": {
"$ref": "#/components/schemas/cmp_id"
},
"object": {
"enum": [
"campaign"
],
"type": "string",
"default": "campaign",
"description": "Value is resource type."
},
"deleted": {
"$ref": "#/components/schemas/deleted"
},
"uploads": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"maxItems": 1,
"minItems": 0,
"description": "A single-element array containing the upload object that is assocated with this campaign."
},
"is_draft": {
"type": "boolean",
"default": true,
"description": "Whether or not the campaign is still a draft."
},
"creatives": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "An array of creatives that have been associated with this campaign."
},
"date_created": {
"$ref": "#/components/schemas/date_created"
},
"date_modified": {
"$ref": "#/components/schemas/date_modified"
}
}
}
]
}
campaign_list
{
"type": "array",
"items": {
"$ref": "#/components/schemas/campaign_item"
},
"example": [
{
"id": "cmp_ed76e33e7ac4d0bd",
"name": "My postman Campaign 2",
"object": "campaign",
"deleted": false,
"uploads": [],
"is_draft": true,
"metadata": {},
"use_type": null,
"creatives": [],
"send_date": null,
"description": "Created via postman again",
"date_created": "2022-07-26T20:20:25.016Z",
"date_modified": "2022-07-26T20:20:25.016Z",
"schedule_type": "immediate",
"auto_cancel_if_ncoa": false,
"target_delivery_date": null,
"cancel_window_campaign_minutes": null
}
],
"description": "Array of campaigns associated with the creative ID"
}
campaign_updatable
{
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"is_draft": {
"type": "boolean",
"description": "Whether or not the campaign is still a draft. Can either be excluded or `false`."
},
"metadata": {
"$ref": "#/components/schemas/metadata"
},
"use_type": {
"$ref": "#/components/schemas/cmp_use_type"
},
"send_date": {
"type": "string",
"format": "date-time",
"description": "If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign."
},
"description": {
"$ref": "#/components/schemas/resource_description"
},
"schedule_type": {
"$ref": "#/components/schemas/cmp_schedule_type"
},
"auto_cancel_if_ncoa": {
"type": "boolean",
"description": "Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA."
},
"target_delivery_date": {
"type": "string",
"format": "date-time",
"description": "If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign."
},
"cancel_window_campaign_minutes": {
"type": "integer",
"description": "A window, in minutes, within which the campaign can be canceled."
}
}
}
campaign_writable
{
"type": "object",
"required": [
"name",
"schedule_type",
"use_type"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the campaign."
},
"metadata": {
"$ref": "#/components/schemas/metadata"
},
"use_type": {
"$ref": "#/components/schemas/cmp_use_type"
},
"send_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign."
},
"description": {
"$ref": "#/components/schemas/resource_description"
},
"schedule_type": {
"$ref": "#/components/schemas/cmp_schedule_type"
},
"billing_group_id": {
"type": "string",
"pattern": "^bg_[a-zA-Z0-9]+$",
"nullable": true,
"description": "Unique identifier prefixed with `bg_`."
},
"auto_cancel_if_ncoa": {
"type": "boolean",
"description": "Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA."
},
"target_delivery_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign."
},
"cancel_window_campaign_minutes": {
"type": "integer",
"nullable": true,
"description": "A window, in minutes, within which the campaign can be canceled."
}
}
}
card
{
"allOf": [
{
"$ref": "#/components/schemas/lob_base"
},
{
"$ref": "#/components/schemas/card_base"
},
{
"required": [
"description"
]
},
{
"type": "object",
"required": [
"id",
"url",
"auto_reorder",
"reorder_quantity",
"raw_url",
"front_original_url",
"back_original_url",
"thumbnails",
"available_quantity",
"pending_quantity",
"status",
"orientation",
"threshold_amount",
"object"
],
"properties": {
"id": {
"$ref": "#/components/schemas/card_id"
},
"url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The signed link for the card."
},
"object": {
"enum": [
"card"
],
"type": "string",
"default": "card",
"description": "object"
},
"status": {
"enum": [
"processed",
"rendered"
],
"type": "string",
"title": "The status of the card."
},
"raw_url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The raw URL of the card."
},
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/thumbnail"
}
},
"orientation": {
"enum": [
"horizontal",
"vertical"
],
"type": "string",
"default": "horizontal",
"description": "The orientation of the card."
},
"auto_reorder": {
"type": "boolean",
"default": false,
"description": "True if the cards should be auto-reordered."
},
"pending_quantity": {
"type": "integer",
"default": 0,
"description": "The pending quantity of cards."
},
"reorder_quantity": {
"type": "integer",
"nullable": true,
"description": "The number of cards to be reordered."
},
"threshold_amount": {
"type": "integer",
"default": 0,
"description": "The threshold amount of the card"
},
"back_original_url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The original URL of the back template."
},
"available_quantity": {
"type": "integer",
"default": 0,
"description": "The available quantity of cards."
},
"front_original_url": {
"type": "string",
"format": "uri",
"maxLength": 2083,
"minLength": 1,
"description": "The original URL of the front template."
}
}
}
]
}
card_base
{
"type": "object",
"properties": {
"size": {
"enum": [
"3.375x2.125",
"2.125x3.375"
],
"type": "string",
"default": "2.125x3.375",
"description": "The size of the card"
},
"description": {
"$ref": "#/components/schemas/card_description"
}
}
}
card_deletion
{
"properties": {
"id": {
"$ref": "#/components/schemas/card_id"
},
"deleted": {
"$ref": "#/components/schemas/deleted"
}
},
"description": "Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end."
}
card_description
{
"type": "string",
"nullable": true,
"maxLength": 255,
"description": "Description of the card."
}
card_editable
{
"allOf": [
{
"$ref": "#/components/schemas/card_base"
},
{
"type": "object",
"required": [
"front"
],
"properties": {
"back": {
"oneOf": [
{
"$ref": "#/components/schemas/remote_file_url"
},
{
"$ref": "#/components/schemas/local_file_path"
}
],
"default": "https://s3.us-west-2.amazonaws.com/public.lob.com/assets/card_blank_horizontal.pdf",
"description": "A PDF template for the back of the card"
},
"front": {
"oneOf": [
{
"$ref": "#/components/schemas/remote_file_url"
},
{
"$ref": "#/components/schemas/local_file_path"
}
],
"description": "A PDF template for the front of the card"
}
}
}
]
}
card_id
{
"type": "string",
"pattern": "^card_[a-zA-Z0-9]+$",
"description": "Unique identifier prefixed with `card_`."
}
card_order
{
"allOf": [
{
"$ref": "#/components/schemas/lob_base"
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/co_id"
},
"status": {
"enum": [
"pending",
"printing",
"available",
"cancelled",
"depleted"
],
"type": "string",
"description": "The status of the card order."
},
"card_id": {
"$ref": "#/components/schemas/card_id"
},
"inventory": {
"type": "number",
"default": 0,
"description": "The inventory of the card order."
},
"unit_price": {
"type": "number",
"default": 0,
"description": "The unit price for the card order."
},
"cancelled_reason": {
"type": "string",
"description": "The reason for cancellation."
},
"quantity_ordered": {
"type": "number",
"default": 0,
"description": "The quantity of cards ordered"
},
"availability_date": {
"type": "string",
"format": "date-time",
"description": "A timestamp in ISO 8601 format of the date the resource was created."
},
"expected_availability_date": {
"type": "string",
"format": "date-time",
"description": "The fixed deadline for the cards to be printed."
}
}
}
]
}
card_order_editable
{
"type": "object",
"required": [
"quantity"
],
"properties": {
"quantity": {
"type": "integer",
"maximum": 10000000,
"minimum": 10000,
"description": "The quantity of cards in the order (minimum 10,000)."
}
}
}
card_updatable
{
"type": "object",
"properties": {
"description": {
"$ref": "#/components/schemas/card_description"
},
"auto_reorder": {
"type": "boolean",
"description": "Allows for auto reordering"
},
"reorder_quantity": {
"type": "number",
"maximum": 10000000,
"minimum": 10000,
"description": "The quantity of items to be reordered (only required when auto_reorder is true)."
}
}
}
cents
{
"type": "integer",
"maximum": 100,
"minimum": 1
}
certified
{
"allOf": [
{
"type": "object",
"required": [
"extra_service",
"tracking_events",
"color"
],
"properties": {
"color": {
"$ref": "#/components/schemas/color"
},
"metadata": {
"$ref": "#/components/schemas/metadata"
},
"mail_type": {
"$ref": "#/components/schemas/mail_type"
},
"send_date": {
"$ref": "#/components/schemas/send_date"
},
"description": {
"$ref": "#/components/schemas/resource_description"
},
"double_sided": {
"$ref": "#/components/schemas/double_sided"
},
"extra_service": {
"enum": [
"certified",
"certified_return_receipt"
],
"type": "string",
"description": "Add an extra service to your letter. See <a href=\"https://www.lob.com/pricing/print-mail#compare\" target=\"_blank\">pricing</a> for extra costs incurred.\n * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf\" target=\"_blank\">#10 envelope</a> and <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf\" target=\"_blank\">flat envelope</a> (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet.\n * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter\n"
},
"return_address": {
"$ref": "#/components/schemas/return_address"
},
"custom_envelope": {
"$ref": "#/components/schemas/custom_envelope_returned"
},
"merge_variables": {
"$ref": "#/components/schemas/merge_variables"
},
"perforated_page": {
"type": "integer",
"nullable": true,
"description": "Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf\" target=\"_blank\">perforation guide</a>."
},
"return_envelope": {
"$ref": "#/components/schemas/return_envelope_returned"
},
"tracking_events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tracking_event_certified"
},
"description": "An array of certified tracking events ordered by ascending `time`. Not populated in test mode."
},
"tracking_number": {
"type": "string",
"nullable": true,
"description": "The tracking number will be here immediately upon creation.\nDummy tracking numbers are created in test mode."
},
"address_placement": {
"$ref": "#/components/schemas/address_placement"
}
}
},
{
"$ref": "#/components/schemas/letter_generated_base"
}
]
}
check
{
"allOf": [
{
"$ref": "#/components/schemas/check_base"
},
{
"$ref": "#/components/schemas/from_us"
},
{
"type": "object",
"required": [
"bank_account",
"id",
"amount",
"to",
"url",
"carrier",
"date_created",
"date_modified",
"use_type"
],
"properties": {
"id": {
"$ref": "#/components/schemas/chk_id"
},
"to": {
"$ref": "#/components/schemas/to_address_us_chk"
},
"url": {
"$ref": "#/components/schemas/signed_link"
},
"amount": {
"type": "number",
"format": "float",
"maximum": 999999.99,
"multipleOf": 0.01,
"description": "The payment amount to be sent in US dollars."
},
"object": {
"enum": [
"check"
],
"type": "string",
"default": "check",
"description": "Value is resource type."
},
"status": {
"$ref": "#/components/schemas/status"
},
"carrier": {
"enum": [
"USPS"
],
"type": "string",
"default": "USPS"
},
"deleted": {
"$ref": "#/components/schemas/deleted"
},
"use_type": {
"$ref": "#/components/schemas/chk_use_type"
},
"thumbnails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/thumbnail"
}
},
"bank_account": {
"$ref": "#/components/schemas/bank_account"
},
"date_created": {
"$ref": "#/components/schemas/date_created"
},
"date_modified": {
"$ref": "#/components/schemas/date_modified"
},
"failure_reason": {
"allOf": [
{
"$ref": "#/components/schemas/failure_reason"
},
{
"nullable": true
}
]
},
"tracking_events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tracking_event_normal"
},
"nullable": true,
"description": "An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode."
},
"attachment_template_id": {
"allOf": [
{
"description": "The unique ID of the HTML template used for the attachment."
},
{
"$ref": "#/components/schemas/tmpl_id"
}
]
},
"expected_delivery_date": {
"$ref": "#/components/schemas/expected_delivery_date"
},
"check_bottom_template_id": {
"allOf": [
{
"description": "The unique ID of the HTML template used for the check bottom."
},
{
"$ref": "#/components/schemas/tmpl_id"
}
]
},
"attachment_template_version_id": {
"allOf": [
{
"type": "string",
"description": "The unique ID of the specific version of the HTML template used for the attachment."
},
{
"$ref": "#/components/schemas/vrsn_id"
}
]
},
"check_bottom_template_version_id": {
"allOf": [
{
"type": "string",
"description": "The unique ID of the specific version of the HTML template used for the check bottom."
},
{
"$ref": "#/components/schemas/vrsn_id"
}
]
}
}
}
]
}
check_base
{
"allOf": [
{
"$ref": "#/components/schemas/editable_no_mailtype"
},
{
"type": "object",
"properties": {
"memo": {
"type": "string",
"nullable": true,
"maxLength": 40,
"description": "Text to include on the memo line of the check."
},
"message": {
"type": "string",
"maxLength": 400,
"description": "Max of 400 characters to be included at the bottom of the check page."
},
"use_type": {
"$ref": "#/components/schemas/chk_use_type"
},
"mail_type": {
"enum": [
"usps_first_class"
],
"type": "string",
"default": "usps_first_class",
"description": "Checks must be sent `usps_first_class`"
},
"check_number": {
"type": "integer",
"maximum": 500000000,
"minimum": 1,
"description": "An integer that designates the check number.\nIf `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`.\nA provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number."
}
}
}
]
}
check_bottom
{
"oneOf": [
{
"$ref": "#/components/schemas/html_string"
},
{
"$ref": "#/components/schemas/tmpl_id"
},
{
"$ref": "#/components/schemas/remote_file_url"
},
{
"$ref": "#/components/schemas/local_file_path"
}
],
"description": "The artwork to use on the bottom of the check page.\n\nNotes:\n- HTML merge variables should not include delimiting whitespace.\n- PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page.\n- The check bottom will always be printed in black & white.\n- Must conform to <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf\" target=\"_blank\">this template</a>.\n\nNeed more help? Consult our [HTML examples](#section/HTML-Examples)."
}
check_deletion
{
"properties": {
"id": {
"$ref": "#/components/schemas/chk_id"
},
"deleted": {
"$ref": "#/components/schemas/deleted"
}
},
"description": "Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end."
}
check_editable
{
"oneOf": [
{
"allOf": [
{
"required": [
"message"
]
},
{
"$ref": "#/components/schemas/check_editable_props"
}
],
"title": "words at check bottom"
},
{
"allOf": [
{
"required": [
"check_bottom"
]
},
{
"$ref": "#/components/schemas/check_editable_props"
}
],
"title": "image at check bottom"
}
]
}
check_editable_props
{
"allOf": [
{
"$ref": "#/components/schemas/check_base"
},
{
"$ref": "#/components/schemas/check_input_to"
},
{
"type": "object",
"required": [
"bank_account",
"to",
"from",
"amount",
"use_type"
],
"properties": {
"from": {
"oneOf": [
{
"$ref": "#/components/schemas/adr_id"
},
{
"$ref": "#/components/schemas/inline_address_us"
}
],
"description": "Must either be an address ID or an inline object with correct address parameters. Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by verification."
},
"logo": {
"oneOf": [
{
"type": "string",
"pattern": "^https://[-a-zA-Z0-9@:%._+~#=/]{1,256}.(png|jpg)$"
},
{
"type": "string",
"pattern": "^(?!https://)[a-zA-Z0-9@:%._+~#=/]{1,256}.(png|jpg)$"
}
],
"description": "Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. Image requirements:\n\n * RGB or CMYK\n\n * square\n\n * minimum size: 100px x 100px\n\n * transparent backgrond\n\n * `png` or `jpg`"
},
"amount": {
"type": "number",
"format": "float",
"maximum": 999999.99,
"description": "The payment amount to be sent in US dollars. Amounts will be rounded to two decimal places."
},
"use_type": {
"$ref": "#/components/schemas/chk_use_type"
},
"attachment": {
"oneOf": [
{
"$ref": "#/components/schemas/html_string"
},
{
"$ref": "#/components/schemas/tmpl_id"
},
{
"$ref": "#/components/schemas/remote_file_url"
},
{
"$ref": "#/components/schemas/local_file_path"
}
],
"description": "A document to include with the check.\n\nNotes:\n- HTML merge variables should not include delimiting whitespace.\n- All pages of PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to as many 8.5\"x11\" pages as necessary.\n- If a PDF is provided, it must be 6 pages or fewer.\n- The attachment will be printed double-sided in black & white and will be included in the envelope after the check page.\n- Please follow these <a href=\"https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_attachment_template.pdf\" target=\"_blank\">design guidelines</a>.\n\nSee <a href=\"https://lob.com/pricing/print-mail#compare\" target=\"_blank\">pricing</a> for extra costs incurred. Need more help? Consult our [HTML examples](#section/HTML-Examples)."
},
"bank_account": {
"allOf": [
{
"$ref": "#/components/schemas/bank_id_no_description"
},
{
"type": "string",
"description": "The id for a verified bank account."
}
]
},
"check_bottom": {
"$ref": "#/components/schemas/check_bottom"
},
"billing_group_id": {
"$ref": "#/components/schemas/billing_group_id"
}
}
}
]
}
check_input_to
{
"type": "object",
"properties": {
"to": {
"oneOf": [
{
"$ref": "#/components/schemas/adr_id"
},
{
"$ref": "#/components/schemas/inline_address_us_chk"
}
],
"description": "Must either be an address ID or an inline object with correct address parameters. Checks cannot be sent internationally (`address_country` must be `US`). The total string of the sum of `address_line1` and `address_line2` must be no longer than 50 characters combined. If an object is used, an address will be created, corrected, and standardized for free whenever possible using our US Address Verification engine, and returned back with an ID. Depending on your <a href=\"https://dashboard.lob.com/#/settings/editions\" target=\"_blank\">Print & Mail Edition</a>, addresses may also be run through [National Change of Address (NCOALink)](#tag/National-Change-of-Address). If an address used does not meet your account’s <a href=\"https://dashboard.lob.com/#/settings/account\" target=\"_blank\">US Mail Strictness Setting</a>, the request will fail. <a href=\"https://help.lob.com/print-and-mail/all-about-addresses\" target=\"_blank\">More about verification of mailing addresses</a>"
}
}
}
check_types
{
"enum": [
"check.created",
"check.rendered_pdf",
"check.rendered_thumbnails",
"check.deleted",
"check.delivered",
"check.failed",
"check.mailed",
"check.in_transit",
"check.in_local_area",
"check.international_exit",
"check.processed_for_delivery",
"check.re-routed",
"check.returned_to_sender"
],
"type": "string",
"description": "Unique identifier referring to status of check"
}
chk_id
{
"type": "string",
"pattern": "^chk_[a-zA-Z0-9]+$",
"description": "Unique identifier prefixed with `chk_`."
}
chk_use_type
{
"enum": [
"marketing",
"operational",
null
],
"type": "string",
"nullable": true,
"description": "TThe use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type)."
}
city
{
"allOf": [
{
"$ref": "#/components/schemas/city_no_description"
},
{
"type": "string",
"description": "The name of the city."
}
]
}
city_no_description
{
"type": "string",
"maxLength": 200
}
cmp_id
{
"type": "string",
"title": "Campaign id",
"pattern": "^cmp_[a-zA-Z0-9]+$",
"description": "Unique identifier prefixed with `cmp_`."
}
cmp_schedule_type
{
"enum": [
"immediate"
],
"type": "string",
"description": "How the campaign should be scheduled. Only value available today is `immediate`."
}
cmp_use_type
{
"enum": [
"marketing",
"operational",
null
],
"type": "string",
"nullable": true,
"description": "The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type)."
}
co_id
{
"type": "string",
"pattern": "^co_[a-zA-Z0-9]+$",
"description": "Unique identifier prefixed with `co_`."
}
color
{
"type": "boolean",
"description": "Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white."
}
company
{
"type": "string",
"nullable": true,
"maxLength": 40,
"description": "Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. This field can be used for any secondary recipient information which is not part of the actual mailing address (Company Name, Department, Attention Line, etc).\n"
}
company_input
{
"allOf": [
{
"anyOf": [
{
"title": "Address object with `city` and `state`",
"required": [
"city",
"state"
]
},
{
"title": "Address object with `zip_code`",
"required": [
"zip_code"
]
}
]
},
{
"type": "object",
"required": [
"company",
"primary_line"
],
"properties": {
"city": {
"allOf": [
{
"$ref": "#/components/schemas/city_no_description"
},
{
"type": "string",
"description": "The name of the city. `city` and `state` are required if no `zip_code` is passed."
}
]
},
"state": {
"type": "string",
"maxLength": 50,
"description": "The <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\" target=\"_blank\">ISO 3166-2</a> two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed."
},
"company": {
"$ref": "#/components/schemas/identity_validation_company"
},
"zip_code": {
"allOf": [
{
"type": "string",
"description": "Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`)."
},
{
"$ref": "#/components/schemas/zip_code"
}
]
},
"primary_line": {
"$ref": "#/components/schemas/primary_line_us"
},
"urbanization": {
"$ref": "#/components/schemas/urbanization"
},
"secondary_line": {
"$ref": "#/components/schemas/secondary_line"
}
}
}
]
}
company_validation
{
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/identity_validation_id"
},
"score": {
"type": "number",
"format": "float",
"default": null,
"maximum": 100,
"minimum": 0,
"nullable": true,
"description": "A numerical score between 0 and 100 that represents the likelihood the provided name is associated with a physical address.\n"
},
"object": {
"enum": [
"id_validation"
],
"type": "string",
"default": "id_validation",
"description": "Value is resource type."
},
"company": {
"$ref": "#/components/schemas/identity_validation_company"
},
"last_line": {
"type": "string",
"description": "Combination of the following applicable `components`:\n* City (`city`)\n* State (`state`)\n* ZIP code (`zip_code`)\n* ZIP+4 (`zip_code_plus_4`)\n"
},
"confidence": {
"enum": [
"high",
"medium",
"low",
""
],
"type": "string",
"description": "Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are:\n- `high` — Has a Lob confidence score greater than 70.\n- `medium` — Has a Lob confidence score between 40 and 70.\n- `low` — Has a Lob confidence score less than 40.\n- `\"\"` — No tracking data exists for this address.\n"
},
"primary_line": {
"$ref": "#/components/schemas/primary_line_us"
},
"urbanization": {
"$ref": "#/components/schemas/urbanization"
},
"secondary_line": {
"$ref": "#/components/schemas/secondary_line"
}
}
}
components
{
"type": "object",
"required": [
"zip_code",
"zip_code_plus_4"
],
"properties": {
"zip_code": {
"type": "string",
"pattern": "^\\d{5}$",
"description": "The 5-digit ZIP code"
},
"zip_code_plus_4": {
"allOf": [
{
"description": "A 4-digit ZIP add-on code"
},
{
"$ref": "#/components/schemas/zip_code_plus_4"
}
]
}
},
"description": "A nested object containing a breakdown of each component of a reverse geocoded response."
}
count
{
"type": "integer",
"description": "number of resources in a set"
}
country_extended
{
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AN",
"AO",
"AQ",
"AR",
"AT",
"AU",
"AW",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BW",
"BY",
"BZ",
"CA",
"CD",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CS",
"CU",
"CV",
"CW",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GH",
"GI",
"GL",
"GM",
"GN",
"GQ",
"GR",
"GS",
"GT",
"GW",
"GY",
"HK",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MG",
"MK",
"ML",
"MM",
"MN",
"MO",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PG",
"PH",
"PK",
"PL",
"PN",
"PT",
"PY",
"QA",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VN",
"VU",
"WS",
"YE",
"ZA",
"ZM",
"ZW"
],
"type": "string",
"description": "Must be a 2 letter country short-name code (ISO 3166). Does not accept `US`, `AS`, `PR`, `FM`, `GU`, `MH`, `MP`, `PW`, or `VI`. For these addresses, please use the US verification API. Also does not accept `PS`, which is not currently supported."
}