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

Creates a new address object.

Header Parameters

X-RapidAPI-HostSTRING

REQUIRED

X-RapidAPI-KeySTRING

REQUIRED

Required Parameters

addressLine1STRING

REQUIREDThe total string must be no longer than 200 characters.

apiKeyCREDENTIALS

REQUIREDApi Key.

addressStateSTRING

REQUIREDRequired and must be a 2 letter state short-name code if address_country is US, otherwise optional and the total string can not be any longer than 200 characters.

addressCitySTRING

REQUIREDRequired if address_country is US, otherwise optional. The total string must be no longer than 200 characters.

companySTRING

REQUIREDEither name or company is required, you may also add both. The total string for company must be no longer than 200 characters. If both name and company are provided, they will be printed on two separate lines above the rest of the address.

addressLine2STRING

REQUIREDThe total string must be no longer than 200 characters.

addressZipSTRING

REQUIREDRequired and must follow the ZIP format of 12345 or ZIP+4 format of 12345-1234 if address_country is US, otherwise optional and the total string can not be any longer than 40 characters.

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.

phoneSTRING

OPTIONALThe total string must be no longer than 40 characters.

addressCountrySTRING

OPTIONALMust be a 2 letter country short-name code (ISO 3166). Defaults to US.

nameSTRING

OPTIONALEither name or company is required, you may also add both. The total string for name must be no longer than 50 characters. If both name and company are provided, they will be printed on two separate lines above the rest of the address.

emailSTRING

OPTIONALThe total string must be no longer than 100 characters.

descriptionSTRING

OPTIONALAddress description.