theme
Lob
FREE
By dimashirokov
Updated a year ago

Lob API Documentation

Programmatically send physical mail at scale.

Learn more about this API
POSTcreateAddress
POSTcreateAreaMailing
POSTcreateBankAccount
POSTcreateCheck
POSTcreateLetter
POSTcreatePostcard
POSTdeleteAddress
POSTdeleteBankAccount
POSTgetAddress
POSTgetAllAddresses
POSTgetAllAreaMailings
POSTgetAllBankAccounts
POSTgetAllChecks
POSTgetAllCountries
POSTgetAllLetters
POSTgetAllPostcards
POSTgetAllRoutes
POSTgetAllStates
POSTretrieveAreaMailing
POSTretrieveBankAccount
POSTretrieveCheck
POSTretrieveLetter
POSTretrievePostcard
POSTretrieveRoutesByZipcode
POSTverifyAddress
POSTverifyBankAccount
POSTcreateCheck

Create a new check.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
amountNUMBER
REQUIREDThe payment amount to be sent in dollars. Must be less than 1000000.
checkFromSTRING
REQUIREDMust either be an address ID or an JSON object with correct address parameters. If an JSON object is used, an address will be created for you and returned with an ID.
bankAccountSTRING
REQUIREDMust be a bank account ID. Only verified bank accounts may be used.
apiKeyCREDENTIALS
REQUIREDApi Key.
checkToSTRING
REQUIREDMust either be an address ID or an JSON object with correct address parameters. If an JSON object is used, an address will be created for you and returned with an ID.
Optional Parameters
metadataARRAY
OPTIONALMust be an Array with up to 20 key-value pairs. Keys must at most 40 characters and values must be at most 500 characters. Neither can contain the characters and Nested objects are not supported. See Metadata for more information.
descriptionSTRING
OPTIONALAn internal description that identifies this resource.
messageSTRING
OPTIONALEither message or check_bottom, choose one. Max of 400 characters to be included at the bottom of the check page.
mailTypeSELECT
OPTIONALA string designating the mail postage type. Options are usps_first_class or ups_next_day_air. Defaults to usps_first_class. See pricing for extra costs incurred for ups_next_day_air.
attachmentFILE
OPTIONALA document to include with the check. This can be a local file or a URL to an 8.5 x11 PDF, PNG, or JPEG, or an HTML string. This will be printed double-sided in black & white and will be included in the envelope after the check page. If a PDF is provided, it must be 6 pages or fewer. If HTML is provided that renders to more than 6 pages, it will be trimmed. Please follow these design guidelines. See pricing for extra costs incurred.
checkNumberSTRING
OPTIONALChecks will default starting at 10000 and increment accordingly.
merge_variablesJSON
OPTIONALMust be an JSON object with up to 40 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters " and Nested objects are not supported. For parameters that accept HTML strings, you can provide optional data variables that will be merged with your HTML. To add a variable, insert double curly braces into your HTML like so: {{variable_name}}.
memoSTRING
OPTIONALMax of 40 characters to be included on the memo line of the check.
checkBottomFILE
OPTIONALEither message or file, choose one. This can be a local file or a URL to a 1 page 8.5x11 PDF, PNG, or JPEG, or an HTML string. This will be printed on the bottom of the check page in black & white. You must follow this template.
logoFILE
OPTIONALThis can be a URL or local file. The image must be a square, have color model of RGB or CMYK, be at least 100px X 100px, and have a transparent background. The accepted file types are PNG and JPEG. If supplied, the logo is printed in grayscale and placed in the upper-left corner of the check.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication