openapi: 3.0.3
info:
title: Lob Accounts 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:
urbanization:
type: string
description: 'Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See <a href="https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name." target="_blank">USPS documentation</a> for clarification.
'
maxLength: 200
zip_code:
type: string
pattern: ^\d{5}((-)?\d{4})?$
primary_line_us:
type: string
description: 'The primary delivery line (usually the street address) of the address.
Combination of the following applicable `components`:
* `primary_number`
* `street_predirection`
* `street_name`
* `street_suffix`
* `street_postdirection`
* `secondary_designator`
* `secondary_number`
* `pmb_designator`
* `pmb_number`
'
maxLength: 200
street_name:
type: string
description: The name of the street.
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 Lob’s 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"
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 with the input address.
'
city:
$ref: '#/components/schemas/city'
state:
$ref: '#/components/schemas/state'
zip_code:
type: string
description: The 5-digit ZIP code
pattern: ^\d{5}$
zip_code_plus_4:
allOf:
- description: The 4-digit ZIP add-on code
- $ref: '#/components/schemas/zip_code_plus_4'
zip_code_type:
$ref: '#/components/schemas/zip_code_type'
delivery_point_barcode:
type: string
description: 'A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit.
'
address_type:
type: string
enum:
- residential
- commercial
- ''
description: 'Uses USPS''s <a href="https://www.usps.com/nationalpremieraccounts/rdi.htm" target="_blank">Residential Delivery Indicator (RDI)</a> to identify
whether an address is classified as residential or
business. Possible values are:
* `residential` –– The address is residential or a PO Box.
* `commercial` –– The address is commercial.
* `''''` –– Not enough information provided to be determined.
'
record_type:
type: string
enum:
- street
- highrise
- firm
- po_box
- rural_route
- general_delivery
- ''
description: 'A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]`
is `Y`, `S`, or `D`). For more detailed information about each record type, see
[US Verification Details](#tag/US-Verification-Types).
'
default_building_address:
type: boolean
description: 'Designates whether or not the address is the default address for a building containing multiple delivery points.
'
county:
$ref: '#/components/schemas/county'
county_fips:
$ref: '#/components/schemas/county_fips'
carrier_route:
type: string
description: 'A 4-character code assigned to a mail delivery route within a ZIP code.
'
carrier_route_type:
type: string
enum:
- city_delivery
- rural_route
- highway_contract
- po_box
- general_delivery
description: 'The type of `components[carrier_route]`. For more detailed information about
each carrier route type, see [US Verification Details](#tag/US-Verification-Types).
'
po_box_only_flag:
type: string
enum:
- Y
- N
- ''
description: 'Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available.
'
latitude:
type: number
format: float
description: 'A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
'
nullable: true
longitude:
type: number
format: float
description: 'A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
'
nullable: true
us_ver_id:
type: string
description: Unique identifier prefixed with `us_ver_`.
pattern: ^us_ver_[a-zA-Z0-9_]+$
city:
allOf:
- $ref: '#/components/schemas/city_no_description'
- type: string
description: The name of the city.
deliverability_analysis:
type: object
description: A nested object containing a breakdown of the deliverability of an address.
required:
- dpv_confirmation
- dpv_cmra
- dpv_vacant
- dpv_active
- dpv_inactive_reason
- dpv_throwback
- dpv_non_delivery_day_flag
- dpv_non_delivery_day_values
- dpv_no_secure_location
- dpv_door_not_accessible
- dpv_footnotes
- ews_match
- lacs_indicator
- lacs_return_code
- suite_return_code
properties:
dpv_confirmation:
type: string
enum:
- Y
- S
- D
- N
- ''
description: "Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are:\n* `Y` –– The address is deliverable by the USPS.\n* `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary.\n* `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number.\n There is a chance the mail will not reach the intended recipient.\n* `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code).\n* `''` –– This address is not deliverable. N
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lobcom/refs/heads/main/openapi/lobcom-us-verifications-api-openapi.yml