Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Lob US Verifications API
version: 1.22.0
description: 'The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p>
'
license:
name: MIT
url: https://mit-license.org/
contact:
name: Lob Developer Experience
url: https://support.lob.com/
email: lob-openapi@lob.com
termsOfService: https://www.lob.com/legal
servers:
- url: https://api.lob.com/v1
description: production
security:
- basicAuth: []
tags:
- name: US Verifications
description: "Validate, automatically correct, and standardize the addresses in your\naddress book based on USPS's <a href=\"https://postalpro.usps.com/certifications/cass\" target=\"_blank\">Coding Accuracy Support System (CASS)</a>.\n<br>\n<div class=\"back-to-top\" ><a href=\"#\" onclick=\"toTopLink()\">back to top</a></div>\n\n## US Verifications Test Env\n\nWhen verifying US addresses, you'll likely want to test against a wide array of addresses to\nensure you're handling responses correctly. With your test API key, requests that use specific\nvalues for `address` or `primary_line` and (if using `primary_line`) an arbitrary five digit\nnumber for `zip_code` (e.g. \"11111\") let you explore the responses to many types of addresses:\n\n<table>\n <tr>\n <th style=\"white-space: nowrap\">ADDRESS TYPE FOR SAMPLE RESPONSE</th>\n <th style=\"white-space: nowrap\">DELIVERABILITY</th>\n <th style=\"white-space: nowrap\">SET <code>primary_line</code> OR <code>address</code> TO</th>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Commercial highrise</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>commercial highrise</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Residential highrise</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>residential highrise</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Residential house</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>residential house</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">PO Box</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>po box</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Rural route</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>rural route</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Puerty Rico address w/ urbanization</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>puerto rico</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Military address</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>military</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Department of state</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>department of state</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Generic deliverable</td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n <td style=\"white-space: nowrap\"><code>deliverable</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Missing a suite number</td>\n <td style=\"white-space: nowrap\"><code>deliverable_missing_unit</code></td>\n <td style=\"white-space: nowrap\"><code>missing unit</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Suite number doesn't exist</td>\n <td style=\"white-space: nowrap\"><code>deliverable_incorrect_unit</code></td>\n <td style=\"white-space: nowrap\"><code>incorrect unit</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Residential house with unnecessary suite number</td>\n <td style=\"white-space: nowrap\"><code>deliverable_unnecessary_unit</code></td>\n <td style=\"white-space: nowrap\"><code>unnecessary unit</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Undeliverable and block matched</td>\n <td style=\"white-space: nowrap\"><code>undeliverable</code></td>\n <td style=\"white-space: nowrap\"><code>undeliverable block match</code></td>\n </tr>\n <tr>\n <td style=\"white-space: nowrap\">Undeliverable and no block matched</td>\n <td style=\"white-space: nowrap\"><code>undeliverable</code></td>\n <td style=\"white-space: nowrap\"><code>undeliverable no match</code></td>\n </tr>\n</table>\n\nSee the `test` request & response examples under [US Verification Examples](#operation/us_verification) within the\n\"Verify a US or US territory address\" section in US Verifications.\n\nYou can rely on the response from these examples generally matching the response you'd see in the live environment with an\naddress of that type (excluding the `recipient` field).\n\nThe test API key does not perform any verification, automatic correction, or standardization for addresses. If you wish to\ntry these features out, use our <a href=\"https://lob.com/address-verification\" target=\"_blank\">live demo</a> or the free plan (see <a href=\"https://lob.com/pricing/address-verification\" target=\"_blank\">our pricing</a> for details).\n<div class=\"back-to-top\" ><a href=\"#\" onclick=\"toTopLink()\">back to top</a></div>\n"
paths:
/bulk/us_verifications:
post:
operationId: bulk_us_verifications
summary: Bulk Verify
description: Verify a list of US or US territory addresses _with a live API key_. Requests to this endpoint with a test API key will return a dummy response based on the primary line you input.
tags:
- US Verifications
parameters:
- in: query
name: case
schema:
type: string
enum:
- upper
- proper
default: upper
description: Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. "PO BOX") and proper-cased (e.g. "PO Box"), respectively. Only affects `recipient`, `primary_line`, `secondary_line`, `urbanization`, and `last_line`. Default casing is `upper`.
required: false
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/multiple_components_list'
example:
addresses:
- primary_line: 210 King Street
city: San Francisco
state: CA
zip_code: '94107'
- recipient: Walgreens
primary_line: Ave Wilson Churchill 123
secondary_line: ''
urbanization: URB FAIR OAKS
city: RIO PIEDRAS
state: PR
zip_code: 00926
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/multiple_components_list'
example:
addresses:
- primary_line: 210 King Street
city: San Francisco
state: CA
zip_code: '94107'
- recipient: Walgreens
primary_line: Ave Wilson Churchill 123
secondary_line: ''
urbanization: URB FAIR OAKS
city: RIO PIEDRAS
state: PR
zip_code: 00926
multipart/form-data:
schema:
$ref: '#/components/schemas/multiple_components_list'
example:
addresses:
- primary_line: 210 King Street
city: San Francisco
state: CA
zip_code: '94107'
- recipient: Walgreens
primary_line: Ave Wilson Churchill 123
secondary_line: ''
urbanization: URB FAIR OAKS
city: RIO PIEDRAS
state: PR
zip_code: 00926
responses:
'200':
$ref: '#/components/responses/bulk_us_verifications'
default:
$ref: '#/components/responses/us_verifications_error'
x-codeSamples:
- lang: Shell
source: 'curl https://api.lob.com/v1/bulk/us_verifications \
-u <YOUR LIVE API KEY>: \
--header ''Content-Type: application/x-www-form-urlencoded'' \
--data-urlencode ''addresses[0][primary_line]=210 King Street'' \
--data-urlencode ''addresses[0][city]=San Francisco'' \
--data-urlencode ''addresses[0][state]=CA'' \
--data-urlencode ''addresses[0][zip_code]=94017''
'
label: CURL
- lang: Typescript
source: "const UsVerifications = new USVerificationsApi(av_config);\nconst verificationData1: UsVerificationsWritable = {\n primary_line: '210 King St',\n city: 'San Francisco',\n state: 'CA',\n zip_code: '94107'\n};\nconst verificationData2: UsVerificationsWritable = {\n primary_line: '185 BERRY ST STE 6600',\n city: 'SAN FRANCISCO',\n state: 'CA',\n zip_code: '94107'\n};\nconst addressList: MultipleComponentsList = {\n addresses: [verificationData1, verificationData2],\n};\n\ntry {\n const bulkVerified = await UsVerifications.verifyBulk(addressList);\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: "Lob.bulkUSVerifications.verify({\n addresses: [{\n primary_line: '210 King St',\n city: 'San Francisco',\n state: 'CA',\n zip_code: '94107'\n }]\n}), function (err, res) {\n console.log(err, res);\n});\n"
label: NODE
- lang: Ruby
source: "usVerificationsApi = UsVerificationsApi.new(config)\n\nverificationData0 = MultipleComponents.new({\n primary_line: \"210 King Street\",\n city: \"San Francisco\",\n state: \"CA\",\n zip_code: \"94017\",\n})\n\nverificationData1 = MultipleComponents.new({\n primary_line: \"185 BERRY ST STE 6600\",\n city: \"SAN FRANCISCO\",\n state: \"CA\",\n zip_code: \"94017\",\n})\n\n\naddressList = MultipleComponentsList.new({\n addresses: [\n verificationData0,\n verificationData1,\n ],\n})\n\nbegin\n bulkVerifiedAddrs = usVerificationsApi.verifyBulk(addressList)\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = UsVerificationsApi(api_client)\n\nverification_data_0 = MultipleComponents(\n primary_line = \"210 King Street\",\n city = \"San Francisco\",\n state = \"CA\",\n zip_code = \"94017\",\n)\n\nverification_data_1 = MultipleComponents(\n primary_line = \"185 BERRY ST STE 6600\",\n city = \"SAN FRANCISCO\",\n state = \"CA\",\n zip_code = \"94017\",\n)\n\n\naddress_list = MultipleComponentsList(\n addresses = [\n verification_data_0,\n verification_data_1,\n ],\n)\n\ntry:\n bulk_verified = api.verifyBulk(address_list)\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$verificationData0 = new OpenAPI\\Client\\Model\\MultipleComponents(array(\n 'primary_line' => '210 King Street',\n 'city' => 'San Francisco',\n 'state' => 'CA',\n 'zip_code' => '94017',\n));\n\n$verificationData1 = new OpenAPI\\Client\\Model\\MultipleComponents(array(\n 'primary_line' => '185 BERRY ST STE 6600',\n 'city' => 'SAN FRANCISCO',\n 'state' => 'CA',\n 'zip_code' => '94017',\n));\n\n$addressList = new OpenAPI\\Client\\Model\\MultipleComponentsList(array(\n 'addresses' => [\n $verificationData0,\n $verificationData1,\n ]\n));\n\ntry {\n $result = $apiInstance->verifyBulk($addressList);\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: "MultipleComponentsList bulkVerify = new MultipleComponentsList();\nMultipleComponents bulkAddress0 = new MultipleComponents();\nbulkAddress0.setPrimaryLine(\"210 King Street\");\nbulkAddress0.setCity(\"San Francisco\");\nbulkAddress0.setState(\"CA\");\nbulkAddress0.setZipCode(\"94017\");\nbulkVerify.addAddressesItem(bulkAddress0);\n\nMultipleComponents bulkAddress1 = new MultipleComponents();\nbulkAddress1.setPrimaryLine(\"185 BERRY ST STE 6600\");\nbulkAddress1.setCity(\"SAN FRANCISCO\");\nbulkAddress1.setState(\"CA\");\nbulkAddress1.setZipCode(\"94017\");\nbulkVerify.addAddressesItem(bulkAddress1);\n\nUsVerificationsApi apiInstance = new UsVerificationsApi(config);\ntry {\n UsVerifications bulkVerifyResponse = apiInstance.verifyBulk(bulkVerify, null);\n} catch (ApiException e) {\n e.printStackTrace();\n}\n"
label: JAVA
- lang: Elixir
source: "Lob.BulkUSVerification.verify.verify(\n%{\n addresses:[\n {\n primary_line: \"210 King Street\",\n city: \"San Francisco\",\n state: \"CA\",\n zip_code: \"94107\"\n }\n ]\n})\n"
label: ELIXIR
- lang: CSharp
source: "List<MultipleComponents> addresses = new List<MultipleComponents>();\nMultipleComponents bulkAddress0 = new MultipleComponents(\n null, // recipient\n \"210 King Street\", // primaryLine\n null, // secondaryLine\n null, // urbanization\n \"San Francisco\", // city\n \"CA\", // state\n \"94017\" // zipCode\n);\naddresses.Add(bulkAddress0);\n\nMultipleComponents bulkAddress1 = new MultipleComponents(\n null, // recipient\n \"185 BERRY ST STE 6600\", // primaryLine\n null, // secondaryLine\n null, // urbanization\n \"San Francisco\", // city\n \"CA\", // state\n \"94017\" // zipCode\n);\naddresses.Add(bulkAddress1);\n\nMultipleComponentsList bulkVerify = new MultipleComponentsList(addresses);\n\nUsVerificationsApi api = new UsVerificationsApi(config);\ntry {\n UsVerifications bulkVerifyResponse = api.verifyBulk(bulkVerify, null);\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
/us_verifications:
post:
operationId: us_verification
summary: Single Verify
description: Verify a US or US territory address _with a live API key_. The address can be in components (e.g. `primary_line` is "210 King Street", `zip_code` is "94107") or as a single string (e.g. "210 King Street 94107"), but not as both. Requests using a test API key validate required fields but return empty values unless specific `primary_line` values are provided. See the [US Verifications Test Environment](#section/US-Verifications-Test-Env) for details.
tags:
- US Verifications
parameters:
- in: query
name: case
schema:
type: string
enum:
- upper
- proper
default: upper
description: Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. "PO BOX") and proper-cased (e.g. "PO Box"), respectively. Only affects `recipient`, `primary_line`, `secondary_line`, `urbanization`, and `last_line`. Default casing is `upper`.
required: false
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/us_verifications_writable'
examples:
basic:
value:
primary_line: 210 King Street
city: San Francisco
state: CA
zip_code: '94107'
full_payload:
value:
recipient: Walgreens
primary_line: Ave Wilson Churchill 123
secondary_line: ''
urbanization: URB FAIR OAKS
city: RIO PIEDRAS
state: PR
zip_code: 00926
single_line:
value:
address: 210 King Street 94107
test:
value:
primary_line: po box
zip_code: '11111'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/us_verifications_writable'
examples:
basic:
value:
primary_line: 210 King Street
city: San Francisco
state: CA
zip_code: '94107'
full_payload:
value:
recipient: Walgreens
primary_line: Ave Wilson Churchill 123
secondary_line: ''
urbanization: URB FAIR OAKS
city: RIO PIEDRAS
state: PR
zip_code: 00926
single_line:
value:
address: 210 King Street 94107
test:
value:
primary_line: po box
zip_code: '11111'
multipart/form-data:
schema:
$ref: '#/components/schemas/us_verifications_writable'
examples:
basic:
value:
primary_line: 210 King Street
city: San Francisco
state: CA
zip_code: '94107'
full_payload:
value:
recipient: Walgreens
primary_line: Ave Wilson Churchill 123
secondary_line: ''
urbanization: URB FAIR OAKS
city: RIO PIEDRAS
state: PR
zip_code: 00926
single_line:
value:
address: 210 King Street 94107
test:
value:
primary_line: po box
zip_code: '11111'
responses:
'200':
$ref: '#/components/responses/us_verifications'
default:
$ref: '#/components/responses/us_verifications_error'
x-codeSamples:
- lang: Shell
source: "curl https://api.lob.com/v1/us_verifications \\\n -u <YOUR_LIVE_API_KEY>: \\\n -d \"primary_line=210 King Street\" \\\n -d \"city=San Francisco\" \\\n -d \"state=CA\" \\\n -d \"zip_code=94107\"\n"
label: CURL
- lang: Typescript
source: "const UsVerification = new USVerificationsApi(av_config);\nconst verificationData1: UsVerificationsWritable = {\n primary_line: '210 King Street',\n city: 'San Francisco',\n state: 'CA',\n zip_code: '94107'\n};\n\ntry {\n const singleVerified = await UsVerification.verifySingle(verificationData1);\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: "Lob.usVerifications.verify({\n primary_line: '210 King Street',\n city: 'San Francisco',\n state: 'CA',\n zip_code: '94107'\n}, function (err, res) {\n console.log(err, res);\n});\n"
label: NODE
- lang: Ruby
source: "usVerificationsApi = UsVerificationsApi.new(config)\n\nverificationData = UsVerificationsWritable.new({\n primary_line: \"210 King Street\",\n city: \"San Francisco\",\n state: \"CA\",\n zip_code: \"94017\",\n})\n\nbegin\n singleVerifiedAddr = usVerificationsApi.verifySingle(verificationData)\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = UsVerificationsApi(api_client)\nverification_data_1 = UsVerificationsWritable(\n primary_line = \"210 King Street\",\n city = \"San Francisco\",\n state = \"CA\",\n zip_code = \"94017\",\n)\n\ntry:\n single_verified = api.verifySingle(verification_data_1)\nexcept ApiException as e:\n print(e)\n"
label: PYTHON
- lang: PHP
source: "$apiInstance = new OpenAPI\\Client\\Api\\UsVerificationsApi($config, new GuzzleHttp\\Client());\n\n$verificationData = new OpenAPI\\Client\\Model\\UsVerificationsWritable(array(\n 'primary_line' => '210 King Street',\n 'city' => 'San Francisco',\n 'state' => 'CA',\n 'zip_code' => '94017',\n));\n\ntry {\n $result = $apiInstance->verifySingle($verificationData);\n} catch (Exception $e) {\n echo $e->getMessage(), PHP_EOL;\n}\n"
- lang: Java
source: "UsVerificationsWritable singleVerify = new UsVerificationsWritable();\nsingleVerify.setPrimaryLine(\"210 King Street\");\nsingleVerify.setCity(\"San Francisco\");\nsingleVerify.setState(\"CA\");\nsingleVerify.setZipCode(\"94017\");\n\nUsVerificationsApi apiInstance = new UsVerificationsApi(config);\ntry {\n apiInstance.verifySingle(singleVerify, null);\n} catch (ApiException e) {\n e.printStackTrace();\n}\n"
label: JAVA
- lang: Elixir
source: "Lob.USVerification.verify(%{\n primary_line: \"210 King Street\",\n city: \"San Francisco\",\n state: \"CA\",\n zip_code: \"94107\"\n})\n"
label: ELIXIR
- lang: CSharp
source: "UsVerificationsWritable singleVerify = new UsVerificationsWritable(\n null,\n null,\n \"210 King Street\",\n null,\n null,\n \"San Francisco\",\n \"CA\",\n \"94017\"\n);\n\nUsVerificationsApi api = new UsVerificationsApi(config);\n\ntry {\n api.verifySingle(singleVerify, null);\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
components:
schemas:
error:
type: object
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.
required:
- error
properties:
error:
type: object
required:
- message
- status_code
- code
properties:
message:
type: string
description: A human-readable message with more details about the error
example: Rate limit exceeded. Please wait 5 seconds and try your request again.
status_code:
$ref: '#/components/schemas/failure_status_code'
code:
type: string
enum:
- bad_request
- conflict
- feature_limit_reached
- internal_server_error
- invalid
- not_deletable
- not_found
- request_timeout
- service_unavailable
- unrecognized_endpoint
- unsupported_lob_version
- address_length_exceeds_limit
- bank_account_already_verified
- bank_error
- billing_address_required
- custom_envelope_inventory_depleted
- deleted_bank_account
- failed_deliverability_strictness
- file_pages_below_min
- file_pages_exceed_max
- file_size_exceeds_limit
- foreign_return_address
- inconsistent_page_dimensions
- invalid_bank_account
- invalid_bank_account_verification
- invalid_check_international
- invalid_country_covid
- invalid_file
- invalid_file_dimensions
- invalid_file_download_time
- invalid_file_url
- invalid_image_dpi
- invalid_international_feature
- invalid_perforation_return_envelope
- invalid_template_html
- mail_use_type_can_not_be_null
- merge_variable_required
- merge_variable_whitespace
- payment_method_unverified
- pdf_encrypted
- special_characters_restricted
- unembedded_fonts
- email_required
- invalid_api_key
- publishable_key_not_allowed
- rate_limit_exceeded
- unauthorized
- unauthorized_token
description: 'A pre-defined string identifying an error. Error codes fall into three categories:
**GENERIC**
* `bad_request` - 422: an invalid request was made. See error message for details.
* `conflict` - 409/422: this operation would leave data in a conflicted state.
* `feature_limit_reached` - 403: the account has reached its resource limit and requires upgrading to add more.
* `internal_server_error` - 500: an error has occured on Lob''s servers. Please try request again.
* `invalid` - 422: an invalid request was made. See error message for details.
* `not_deletable` - 422: an attempt was made to delete a resource, but the resource cannot be deleted.
* `not_found` - 404: the requested resource was not found.
* `request_timeout` - 408: the request took too long. Please try again.
* `service_unavailable` - 503: the Lob servers are temporarily unavailable. Please try agian.
* `unrecognized_endpoint` - 404: the requested endpoint doesn''t exist.
* `unsupported_lob_version` - 422: an unsupported Lob API version was requested.
**ADVANCED**
* `address_length_exceeds_limit` - 422: the sum of to.address_line1 and to.address_line2 cannot surpass 50 characters.
* `bank_account_already_verified` - 422: the bank account has already been verified.
* `bank_error` - 422: there''s an issue with the bank account.
* `billing_address_required` - 403: in order to create a live mail piece, your account needs to set up a billing address.
* `custom_envelope_inventory_depleted` - 422: custom envelope inventory is depleted, and more will need to be ordered.
* `deleted_bank_account` - 404: checks cannot be created with a deleted bank account.
* `failed_deliverability_strictness` - 422: the `to` address doesn''t meet strictness requirements. See <a href="https://dashboard.lob.com/#/settings/account" target="_blank">Account Settings</a> to configure strictness.
* `file_pages_below_min` - 422: not enough pages.
* `file_pages_exceed_max` - 422: too many pages.
* `file_size_exceeds_limit` - 422: the file size is too large. See description for details.
* `foreign_return_address` - 422: the `from` address must be a US address.
* `inconsistent_page_dimensions` - 422: all pages of the input file must have the same dimensions.
* `invalid_bank_account` - 422: the provided bank routing number is invalid.
* `invalid_bank_account_verification` - 422: verification amounts do not match.
* `invalid_check_international` - 422: checks cannot be sent internationally.
* `invalid_country_covid` - 422: the postal service in the specified country is currently unable to process the request due to COVID-19 restrictions.
* `invalid_file` - 422: the file is invalid.
* `invalid_file_dimensions` - 422: file dimensions are incorrect for the selected mail type.
* `invalid_file_download_time` - 422: file download from remote server took too long.
* `invalid_file_url` - 422: the file URL when creating a resource is invalid.
* `invalid_image_dpi` - 422: DPI must be at least 300.
* `invalid_international_feature` - 422: the specified product cannot be sent to the destination.
* `invalid_perforation_return_envelope` - 422: both `return_envelope` and `perforation` must be used together.
* `invalid_template_html` - 422: the provided HTML is invalid.
* `mail_use_type_can_not_be_null` - 422: use_type must be one of "marketing" or "operational". Alternatively, an admin can set the account default use type in Account Settings.
* `merge_variable_required` - 422: a required merge variable is missing.
* `merge_variable_whitespace` - 422: merge variable names cannot contain whitespace.
* `payment_method_unverified` - 401: you must have a verified bank account or credit card to submit live requests.
* `pdf_encrypted` - 422: an encrypted PDF was provided.
* `special_characters_restricted` - 422: cannot use special characters for merge variable names.
* `unembedded_fonts` - 422: the provided PDF contains non-standard unembedded fonts. See description for details.
**AUTHENTICATION**
* `email_required` - 401: account must have a verified email address before creating live resources.
* `invalid_api_key` - 401/403: the API key is invalid.
* `publishable_key_not_allowed` - 403: the requested operation needs a secret key, not a publishable key. See [API Keys](#section/API-Keys) for more information.
* `rate_limit_exceeded` - 429: requests were sent too quickly and must be slowed down.
* `unauthorized` - 401: the request isn''t authorized.
* `unauthorized_token` - 401: token isn''t authorized.
'
city:
allOf:
- $ref: '#/components/schemas/city_no_description'
- type: string
description: The name of the city.
secondary_line:
type: string
description: 'The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
'
maxLength: 200
us_components:
type: object
description: A nested object containing a breakdown of each component of an address.
required:
- primary_number
- street_predirection
- street_name
- street_suffix
- street_postdirection
- secondary_designator
- secondary_number
- pmb_designator
- pmb_number
- extra_secondary_designator
- extra_secondary_number
- city
- state
- zip_code
- zip_code_plus_4
- zip_code_type
- delivery_point_barcode
- address_type
- record_type
- default_building_address
- county
- county_fips
- carrier_route
- carrier_route_type
- po_box_only_flag
properties:
primary_number:
$ref: '#/components/schemas/primary_number'
street_predirection:
type: string
enum:
- N
- S
- E
- W
- NE
- SW
- SE
- NW
- ''
description: 'Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).
'
street_name:
$ref: '#/components/schemas/street_name'
street_suffix:
type: string
description: 'The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc).
'
street_postdirection:
type: string
enum:
- N
- S
- E
- W
- NE
- SW
- SE
- NW
- ''
description: 'Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).
'
secondary_designator:
type: string
description: 'The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc).
'
secondary_number:
type: string
description: 'Number of the apartment/unit/etc.
'
pmb_designator:
type: string
description: 'Designator of a <a href="https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency" target="_blank">CMRA-authorized</a> private mailbox.
'
pmb_number:
type: string
description: 'Number of a <a href="https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency" target="_blank">CMRA-authorized</a> private mailbox.
'
extra_secondary_designator:
type: string
description: 'An extra (often unnecessary) secondary designator provided with the input address.
'
extra_secondary_number:
type: string
description: 'An extra (often unnecessary) secondary number provided wi
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lobcom/refs/heads/main/openapi/lobcom-us-verifications-api-openapi.yml