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
POSTverifyAddress

Validates a given address.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
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.
addressLine1STRING
REQUIREDThe total string must be no longer than 200 characters.
apiKeyCREDENTIALS
REQUIREDApi Key.
Optional Parameters
addressLine2STRING
OPTIONALThe total string must be no longer than 200 characters.
addressCountrySTRING
OPTIONALMust be a 2 letter country short-name code (ISO 3166). Defaults to US.
addressStateSTRING
OPTIONALRequired 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.
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.
addressCitySTRING
OPTIONALRequired if address_country is US, otherwise optional. The total string must be no longer than 200 characters.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication