openapi: 3.0.3
info:
title: Lob Bulk API
version: 1.20.2
description: "Experience direct mail like never before, with unmatched personalization and scalability \x14 all in one intuitive platform."
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: Bulk
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:
- Bulk
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
/bulk/intl_verifications:
post:
operationId: bulk_intl_verifications
summary: Bulk Verify
description: Verify a list of international (except US or US territories) address _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:
- Bulk
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/intl_verifications_payload'
example:
addresses:
- recipient: John Doe
primary_line: 370 Water St
secondary_line: ''
city: Summerside
state: Prince Edwards Island
postal_code: C1N 1C4
country: CA
- recipient: Jane Doe
primary_line: UL. DOLSKAYA 1
secondary_line: ''
city: MOSCOW
state: MOSCOW G
postal_code: '115569'
country: RU
multipart/form-data:
schema:
$ref: '#/components/schemas/intl_verifications_payload'
example:
addresses:
- recipient: John Doe
primary_line: 370 Water St
secondary_line: ''
city: Summerside
state: Prince Edwards Island
postal_code: C1N 1C4
country: CA
- recipient: Jane Doe
primary_line: UL. DOLSKAYA 1
secondary_line: ''
city: MOSCOW
state: MOSCOW G
postal_code: '115569'
country: RU
responses:
'200':
$ref: '#/components/responses/bulk_intl_verifications'
default:
$ref: '#/components/responses/intl_verifications_error'
x-codeSamples:
- lang: Shell
source: 'curl https://api.lob.com/v1/bulk/intl_verifications \
-u <YOUR LIVE API KEY>: \
--header ''Content-Type: application/x-www-form-urlencoded'' \
--data-urlencode ''addresses[0][primary_line]=370 WATER ST'' \
--data-urlencode ''addresses[0][postal_code]=C1N 1C4'' \
--data-urlencode ''addresses[0][country]=CA''
'
label: CURL
- lang: Typescript
source: "const IntlVerifications = new IntlVerificationsApi(av_config);\nlet verificationData1: IntlVerificationWritable = {\n primary_line: '370 WATER ST',\n postal_code: 'C1N 1C4',\n country: CountryExtended.Ca\n};\nconst verificationData2: IntlVerificationWritable = {\n primary_line: '012 PLACEHOLDER ST',\n postal_code: 'F0O 8A2',\n country: CountryExtended.Ca\n};\nlet addressList = new IntlVerificationsPayload({\n addresses: [verificationData1, verificationData2]\n});\n\ntry {\n const bulkVerified = await IntlVerifications.verifyBulk(addressList);\n\n} catch (err: any) {\n console.error(err);\n}\n"
label: TYPESCRIPT
- lang: Javascript
source: "Lob.bulkIntlVerifications.verify({\n addresses: [{\n primary_line: '370 Water St',\n secondary_line: '',\n city: 'Summerside',\n state: 'Prince Edward Island',\n postal_code: 'C1N 1C4',\n country: 'CA'\n }]\n}), function (err, res) {\n console.log(err, res);\n});\n"
label: NODE
- lang: Ruby
source: "intlVerificationsApi = IntlVerificationsApi.new(config)\n\nverificationData0 = MultipleComponentsIntl.new({\n primary_line: \"35 Tower Hill\",\n city: \"London\",\n postal_code: \"EC3N 4DR\",\n country: \"GB\",\n})\n\nverificationData1 = MultipleComponentsIntl.new({\n primary_line: \"370 Water St\",\n city: \"Summerside\",\n state: \"Prince Edward Island\",\n postal_code: \"C1N 1C4\",\n country: \"CA\",\n})\n\n\naddressList = IntlVerificationsPayload.new({\n addresses: [\n verificationData0,\n verificationData1,\n ],\n})\n\nbegin\n bulkVerifiedAddrs = intlVerificationsApi.verifyBulk(addressList)\nrescue => err\n p err.message\nend\n"
label: RUBY
- lang: Python
source: "with ApiClient(configuration) as api_client:\n api = IntlVerificationsApi(api_client)\n\nverification_data_0 = MultipleComponentsIntl(\n primary_line = \"35 Tower Hill\",\n city = \"London\",\n postal_code = \"EC3N 4DR\",\n country = CountryExtended(\"GB\"),\n)\n\nverification_data_1 = MultipleComponentsIntl(\n primary_line = \"370 Water St\",\n city = \"Summerside\",\n state = \"Prince Edward Island\",\n postal_code = \"C1N 1C4\",\n country = CountryExtended(\"CA\"),\n)\n\n\naddress_list = IntlVerificationsPayload(\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\\MultipleComponentsIntl(array(\n 'primary_line' => '35 Tower Hill',\n 'city' => 'London',\n 'postal_code' => 'EC3N 4DR',\n 'country' => 'GB',\n));\n\n$verificationData1 = new OpenAPI\\Client\\Model\\MultipleComponentsIntl(array(\n 'primary_line' => '370 Water St',\n 'city' => 'Summerside',\n 'state' => 'Prince Edward Island',\n 'postal_code' => 'C1N 1C4',\n 'country' => 'CA',\n));\n\n$addressList = new OpenAPI\\Client\\Model\\IntlVerificationsPayload(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: "List<IntlVerification.RequestBuilder> addresses = new ArrayList<IntlVerification.RequestBuilder>();\naddresses.add(new IntlVerification.RequestBuilder()\n .setPrimaryLine(\"370 Water St\")\n .setCity(\"Summerside\")\n .setState(\"Prince Edward Island\")\n .setPostalCode(\"C1N 1C4\")\n .setCountry(\"CA\"));\nLobResponse<BulkIntlVerification> response = new BulkIntlVerification.RequestBuilder()\n .setAddresses(addresses)\n .verify();\nBulkIntlVerification bulkIntlVerification = response.getResponseBody();\n"
label: JAVA
- lang: Elixir
source: "Lob.BulkIntlVerification.verify.verify(\n%{addresses:[\n {\n primary_line: '370 Water St',\n secondary_line: '',\n city: 'Summerside',\n state: 'Prince Edward Island',\n postal_code: 'C1N 1C4',\n country: 'CA'\n }\n ]\n})\n"
label: ELIXIR
- lang: CSharp
source: "List<MultipleComponentsIntl> addresses = new List<MultipleComponentsIntl>();\nMultipleComponentsIntl bulkAddress0 = new MultipleComponentsIntl(\n null, // recipient\n \"35 Tower Hill\", // primaryLine\n null, // secondaryLine\n \"London\", // city\n null, // state\n \"EC3N 4DR\", // postalCode\n CountryExtended.GB // country\n);\naddresses.Add(bulkAddress0);\n\nMultipleComponentsIntl bulkAddress1 = new MultipleComponentsIntl(\n null, // recipient\n \"370 Water St\", // primaryLine\n null, // secondaryLine\n \"Summerside\", // city\n \"Prince Edward Island\", // state\n \"C1N 1C4\", // postalCode\n CountryExtended.CA // country\n);\naddresses.Add(bulkAddress1);\n\nIntlVerificationsPayload bulkVerify = new IntlVerificationsPayload(addresses);\n\nIntlVerificationsApi api = new IntlVerificationsApi(config);\n\ntry {\n IntlVerifications bulkVerifyResponse = api.verifyBulk(bulkVerify);\n} catch (ApiException e) {\n Console.WriteLine(e.ToString());\n}\n"
label: CSHARP
components:
schemas:
intl_components:
type: object
description: A nested object containing a breakdown of each component of an address.
properties:
primary_number:
$ref: '#/components/schemas/primary_number'
street_name:
$ref: '#/components/schemas/street_name'
city:
$ref: '#/components/schemas/city'
state:
$ref: '#/components/schemas/state'
postal_code:
$ref: '#/components/schemas/postal_code'
us_verifications:
type: object
required:
- addresses
- errors
properties:
addresses:
type: array
items:
oneOf:
- $ref: '#/components/schemas/us_verification'
- $ref: '#/components/schemas/error'
errors:
description: Indicates whether any errors occurred during the verification process.
type: boolean
primary_line:
type: string
description: 'The primary delivery line (usually the street address) of the address.
'
maxLength: 200
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.
'
us_ver_id:
type: string
description: Unique identifier prefixed with `us_ver_`.
pattern: ^us_ver_[a-zA-Z0-9_]+$
country_extended:
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.
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
lob_confidence_score:
type: object
description: Lob Confidence Score is a nested object that provides a numerical value between 0-100 of the likelihood that an address is deliverable based on Lobs mail delivery data to over half of US households.
required:
- score
- level
properties:
score:
type: number
nullable: true
format: float
description: 'A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address.
'
default: null
minimum: 0
maximum: 100
level:
type: string
enum:
- high
- medium
- low
- ''
description: "Indicates the likelihood that the address is a valid, mail-receiving address. Possible values are:\n - `high` Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful.\n - `medium` Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully.\n - `low` Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful.\n - `\"\"` No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success.\n"
intl_verification:
allOf:
- $ref: '#/components/schemas/intl_verification_base'
- type: object
properties:
id:
$ref: '#/components/schemas/intl_ver_id'
last_line:
type: string
description: 'Combination of the following applicable `components`:
* `city`
* `state`
* `zip_code`
* `zip_code_plus_4`
'
country:
$ref: '#/components/schemas/country_short'
coverage:
type: string
enum:
- SUBBUILDING
- HOUSENUMBER/BUILDING
- STREET
- LOCALITY
- SPARSE
description: 'The coverage level for the country. This represents the maximum level of
accuracy an input address can be verified to.
* `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building
* `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located
* `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country
* `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together.
* `SPARSE` - Some addresses for this country exist in our databases
'
deliverability:
type: string
enum:
- deliverable
- deliverable_missing_info
- undeliverable
- no_match
description: 'Summarizes the deliverability of the `intl_verification` object. Possible values are:
* `deliverable` The address is deliverable.
* `deliverable_missing_info` The address is missing some information, but is most likely deliverable.
* `undeliverable` The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found.
* `no_match` This address is not deliverable. No matching street could be found within the city or postal code.
'
status:
type: string
enum:
- LV4
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lob/refs/heads/main/openapi/lob-bulk-api-openapi.yml