From 5c0bb9f8984c9f3de39895c4160e3939411af3e6 Mon Sep 17 00:00:00 2001 From: Amaan Rahim Date: Wed, 18 Oct 2023 14:16:18 -0700 Subject: [PATCH] commit dist + docs --- dist/lob-api-bundled.yml | 190 +++++++++++++++++++++++++++++++++++---- docs/index.html | 30 +++---- 2 files changed, 188 insertions(+), 32 deletions(-) diff --git a/dist/lob-api-bundled.yml b/dist/lob-api-bundled.yml index fc1fcb43..309e7cf5 100644 --- a/dist/lob-api-bundled.yml +++ b/dist/lob-api-bundled.yml @@ -5041,6 +5041,7 @@ components: - county_fips - carrier_route - carrier_route_type + - po_box_only_flag properties: primary_number: $ref: '#/components/schemas/primary_number' @@ -5200,6 +5201,15 @@ components: 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 @@ -5249,6 +5259,12 @@ components: - 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 @@ -5339,6 +5355,125 @@ components: (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). example: 'Y' + dpv_inactive_reason: + type: string + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + - '06' + - '' + description: > + Indicates the reason why an address is vacant or no longer receiving + deliveries. Possible values are: + + * `01` –– Address does not receive mail from the USPS directly, but + is serviced by a drop address. + + * `02` –– Address not yet deliverable. + + * `03` –– A DPV match is not made + (`deliverability_analysis[dpv_confirmation]` is `N` or an empty + string). + + * `04` –– Address is a College, Military Zone, or other type. + + * `05` –– Address no longer receives deliveries. + + * `06` –– Address is missing required secondary information. + + * `''` –– A DPV match is not made or the address is active. + example: '06' + dpv_throwback: + type: string + enum: + - 'Y' + - 'N' + - '' + description: > + Indicates a street address for which mail is delivered to a PO Box. + Possible values are: + + * `Y` –– Address is a PO Box throwback delivery point. + + * `N` –– Address is not a PO Box throwback delivery point. + + * `''` –– A DPV match is not made + (`deliverability_analysis[dpv_confirmation]` is `N` or an empty + string). + example: 'N' + dpv_non_delivery_day_flag: + type: string + enum: + - 'Y' + - 'N' + - '' + description: > + Indicates whether deliveries are not performed on one or more days + of the week at an address. Possible values are: + + * `Y` –– Mail delivery does not occur on some days of the week. + + * `N` –– Mail delivery occurs every day of the week. + + * `''` –– A DPV match is not made + (`deliverability_analysis[dpv_confirmation]` is `N` or an empty + string). + example: 'N' + dpv_non_delivery_day_values: + type: string + description: > + Indicates days of the week (starting on Sunday) deliveries are not + performed at an address. For example: + + * `YNNNNNN` –– Mail delivery does not occur on Sunday's. + + * `NYNNNYN` –– Mail delivery does not occur on Monday's or Friday's. + + * `''` –– A DPV match is not made + (`deliverability_analysis[dpv_confirmation]` is `N` or an empty + string) or address receives mail every day of the week + (`deliverability_analysis[dpv_non_delivery_day_flag]` is `N` or an + empty string). + example: YNNNNNN + dpv_no_secure_location: + type: string + enum: + - 'Y' + - 'N' + - '' + description: > + Indicates packages to this address will not be left due to security + concerns. Possible values are: + + * `Y` –– Address does not have a secure mailbox. + + * `N` –– Address has a secure mailbox. + + * `''` –– A DPV match is not made + (`deliverability_analysis[dpv_confirmation]` is `N` or an empty + string). + example: 'N' + dpv_door_not_accessible: + type: string + enum: + - 'Y' + - 'N' + - '' + description: > + Indicates the door of the address is not accessible for mail + delivery. Possible values are: + + * `Y` –– Door is not accessible. + + * `N` –– Door is accessible. + + * `''` –– A DPV match is not made + (`deliverability_analysis[dpv_confirmation]` is `N` or an empty + string). + example: 'N' dpv_footnotes: type: array description: > @@ -10807,20 +10942,20 @@ components: addresses: - id: us_ver_c7cb63d68f8d6 recipient: LOB.COM - primary_line: 210 KING ST STE 6100 + primary_line: 210 KING ST secondary_line: '' urbanization: '' - last_line: SAN FRANCISCO CA 94107-1728 + last_line: SAN FRANCISCO CA 94107-1702 deliverability: deliverable valid_address: true components: - primary_number: '185' + primary_number: '210' street_predirection: '' street_name: KING street_suffix: ST street_postdirection: '' - secondary_designator: STE - secondary_number: '6100' + secondary_designator: '' + secondary_number: '' pmb_designator: '' pmb_number: '' extra_secondary_designator: '' @@ -10828,16 +10963,17 @@ components: city: SAN FRANCISCO state: CA zip_code: '94107' - zip_code_plus_4: '1728' + zip_code_plus_4: '1702' zip_code_type: standard delivery_point_barcode: '941071728506' address_type: commercial - record_type: highrise + record_type: street default_building_address: false county: SAN FRANCISCO county_fips: '06075' - carrier_route: C001 + carrier_route: C032 carrier_route_type: city_delivery + po_box_only_flag: 'N' latitude: 37.77597542841264 longitude: -122.3929557343685 deliverability_analysis: @@ -10845,6 +10981,12 @@ components: dpv_cmra: 'N' dpv_vacant: 'N' dpv_active: 'Y' + dpv_inactive_reason: '' + dpv_throwback: 'N' + dpv_non_delivery_day_flag: 'N' + dpv_non_delivery_day_values: '' + dpv_no_secure_location: 'N' + dpv_door_not_accessible: 'N' dpv_footnotes: - AA - BB @@ -12768,20 +12910,20 @@ components: value: id: us_ver_c7cb63d68f8d6 recipient: LOB.COM - primary_line: 210 KING ST STE 6100 + primary_line: 210 KING ST secondary_line: '' urbanization: '' - last_line: SAN FRANCISCO CA 94107-1728 + last_line: SAN FRANCISCO CA 94107-1702 deliverability: deliverable valid_address: true components: - primary_number: '185' + primary_number: '210' street_predirection: '' street_name: KING street_suffix: ST street_postdirection: '' - secondary_designator: STE - secondary_number: '6100' + secondary_designator: '' + secondary_number: '' pmb_designator: '' pmb_number: '' extra_secondary_designator: '' @@ -12789,16 +12931,17 @@ components: city: SAN FRANCISCO state: CA zip_code: '94107' - zip_code_plus_4: '1728' + zip_code_plus_4: '1702' zip_code_type: standard - delivery_point_barcode: '941071728506' + delivery_point_barcode: '941071702108' address_type: commercial - record_type: highrise + record_type: street default_building_address: false county: SAN FRANCISCO county_fips: '06075' - carrier_route: C001 + carrier_route: C032 carrier_route_type: city_delivery + po_box_only_flag: 'N' latitude: 37.77597542841264 longitude: -122.3929557343685 deliverability_analysis: @@ -12806,6 +12949,12 @@ components: dpv_cmra: 'N' dpv_vacant: 'N' dpv_active: 'Y' + dpv_inactive_reason: '' + dpv_throwback: 'N' + dpv_non_delivery_day_flag: 'N' + dpv_non_delivery_day_values: '' + dpv_no_secure_location: 'N' + dpv_door_not_accessible: 'N' dpv_footnotes: - AA - BB @@ -12852,6 +13001,7 @@ components: county_fips: '06075' carrier_route: BOO2 carrier_route_type: po_box + po_box_only_flag: '' latitude: 37.75971500260575 longitude: -122.69397561170017 deliverability_analysis: @@ -12859,6 +13009,12 @@ components: dpv_cmra: 'N' dpv_vacant: 'N' dpv_active: 'Y' + 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: - AA - BB diff --git a/docs/index.html b/docs/index.html index 743e271a..d9b0abe6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3226,7 +3226,7 @@

3. Learn more

Array of objects or null (tracking_event_normal)

An array of tracking_event objects ordered by ascending time. Will not be populated for postcards created in test mode.

campaign_id
string or null

The unique ID of the associated campaign if the resource was generated from a campaign.

use_type
string or null (psc_use_type)
Enum: "marketing" "operational" null

The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our Help Center article.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

status
any (The status of the postcard.)
Enum: "processed" "rendered" "failed"
failure_reason
string or null

A string describing the reason for failure if the postcard failed to render.

object
string
Default: "postcard"
Value: "postcard"

Value is resource type.

adr_id (string) or (address_editable_us (address obj with `name` defined (object) or address obj with `company` defined (object)))

Required if to address is international. Must either be an address ID or an inline object with correct address parameters. Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by verification.

billing_group_id
string (billing_group_id)

An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.

object (qr_code)

Customize and place a QR code on the creative at the required position.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

Responses

Response Headers
ratelimit-limit
integer
Example: 150

The rate limit for a given endpoint.

ratelimit-remaining
integer
Example: 100

The number of requests remaining in the current window.

@@ -3338,7 +3338,7 @@

3. Learn more

Array of objects or null (tracking_event_normal)

An array of tracking_event objects ordered by ascending time. Will not be populated for postcards created in test mode.

campaign_id
string or null

The unique ID of the associated campaign if the resource was generated from a campaign.

use_type
string or null (psc_use_type)
Enum: "marketing" "operational" null

The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our Help Center article.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 4x6 or A5 postcard sizes.

status
any (The status of the postcard.)
Enum: "processed" "rendered" "failed"
failure_reason
string or null

A string describing the reason for failure if the postcard failed to render.

object
string
Default: "postcard"
Value: "postcard"

Value is resource type.

merge_variables
object or null (merge_variables) <= 25000 characters

You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.

string or string (send_date)

A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the send_date has passed, the mailpiece can be canceled. If a date in the format 2017-11-01 is passed, it will evaluate to midnight UTC of that date (2017-11-01T00:00:00.000Z). If a datetime is passed, that exact time will be used. A send_date passed with no time zone will default to UTC, while a send_date passed with a time zone will be converted to UTC.

-
size
string (self_mailer_size)
Default: "6x18_bifold"
Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold"

Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

+
size
string (self_mailer_size)
Default: "6x18_bifold"
Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold"

Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

Array of objects (thumbnail)
expected_delivery_date
string <date> (expected_delivery_date)

A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its send_date.

date_created
string <date-time> (date_created)

A timestamp in ISO 8601 format of the date the resource was created.

date_modified
string <date-time> (date_modified)

A timestamp in ISO 8601 format of the date the resource was last modified.

@@ -3374,7 +3374,7 @@

3. Learn more

inside_template_version_id
string or null^vrsn_[a-zA-Z0-9]+$

Unique identifier prefixed with vrsn_.

object
string
Default: "self_mailer"
Value: "self_mailer"

Value is resource type.

Array of objects (tracking_event_certified)

An array of certified tracking events ordered by ascending time. Not populated in test mode.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

status
any (The status of the self mailer.)
Enum: "processed" "rendered" "failed"
failure_reason
string or null

A string describing the reason for failure if the self mailer failed to render.

merge_variables
object or null (merge_variables) <= 25000 characters

You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.

string or string (send_date)

A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the send_date has passed, the mailpiece can be canceled. If a date in the format 2017-11-01 is passed, it will evaluate to midnight UTC of that date (2017-11-01T00:00:00.000Z). If a datetime is passed, that exact time will be used. A send_date passed with no time zone will default to UTC, while a send_date passed with a time zone will be converted to UTC.

-
size
string (self_mailer_size)
Default: "6x18_bifold"
Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold"

Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

+
size
string (self_mailer_size)
Default: "6x18_bifold"
Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold"

Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

adr_id (string) or (address_editable_us (address obj with `name` defined (object) or address obj with `company` defined (object)))

Required if to address is international. Must either be an address ID or an inline object with correct address parameters. Must either be an address ID or an inline object with correct address parameters. All addresses will be standardized into uppercase without being modified by verification.

billing_group_id
string (billing_group_id)

An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.

object (qr_code)

Customize and place a QR code on the creative at the required position.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

Responses

Response Headers
ratelimit-limit
integer
Example: 150

The rate limit for a given endpoint.

ratelimit-remaining
integer
Example: 100

The number of requests remaining in the current window.

@@ -3474,7 +3474,7 @@

3. Learn more

merge_variables
object or null (merge_variables) <= 25000 characters

You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: {{variable_name}}, pass in {"variable_name": "Harry"} to render Harry. merge_variables must be an object. Any type of value is accepted as long as the object is valid JSON; you can use strings, numbers, booleans, arrays, objects, or null. The max length of the object is 25,000 characters. If you call JSON.stringify on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: !, ", #, %, &, ', (, ), *, +, ,, /, ;, <, =, >, @, [, \, ], ^, `, {, |, }, ~. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.

string or string (send_date)

A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the send_date has passed, the mailpiece can be canceled. If a date in the format 2017-11-01 is passed, it will evaluate to midnight UTC of that date (2017-11-01T00:00:00.000Z). If a datetime is passed, that exact time will be used. A send_date passed with no time zone will default to UTC, while a send_date passed with a time zone will be converted to UTC.

-
size
string (self_mailer_size)
Default: "6x18_bifold"
Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold"

Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

+
size
string (self_mailer_size)
Default: "6x18_bifold"
Enum: "6x18_bifold" "11x9_bifold" "12x9_bifold" "17.75x9_trifold"

Specifies the size of the self mailer. The 17.75x9_trifold size is in beta. Contact support@lob.com or your account contact to learn more.

Array of objects (thumbnail)
expected_delivery_date
string <date> (expected_delivery_date)

A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its send_date.

date_created
string <date-time> (date_created)

A timestamp in ISO 8601 format of the date the resource was created.

date_modified
string <date-time> (date_modified)

A timestamp in ISO 8601 format of the date the resource was last modified.

@@ -3485,7 +3485,7 @@

3. Learn more

inside_template_version_id
string or null^vrsn_[a-zA-Z0-9]+$

Unique identifier prefixed with vrsn_.

object
string
Default: "self_mailer"
Value: "self_mailer"

Value is resource type.

Array of objects (tracking_event_certified)

An array of certified tracking events ordered by ascending time. Not populated in test mode.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for 11x9_bifold self-mailer size.

status
any (The status of the self mailer.)
Enum: "processed" "rendered" "failed"
failure_reason
string or null

A string describing the reason for failure if the self mailer failed to render.

template_id
string^tmpl_[a-zA-Z0-9]+$

Unique identifier prefixed with tmpl_. ID of a saved HTML template.

template_version_id
string^vrsn_[a-zA-Z0-9]+$

Unique identifier prefixed with vrsn_.

campaign_id
string or null

The unique ID of the associated campaign if the resource was generated from a campaign.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

status
any (The status of the letter.)
Enum: "processed" "rendered" "failed"
failure_reason
string or null

A string describing the reason for failure if the letter failed to render.

object
string
Default: "letter"
Value: "letter"

Value is resource type.

custom_envelope
string or null (user_provided) ^env_[a-zA-Z0-9]+$

Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate Print & Mail Edition to gain access.

billing_group_id
string (billing_group_id)

An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information.

object (qr_code)

Customize and place a QR code on the creative at the required position.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

Responses

Response Headers
ratelimit-limit
integer
Example: 150

The rate limit for a given endpoint.

ratelimit-remaining
integer
Example: 100

The number of requests remaining in the current window.

@@ -3666,7 +3666,7 @@

3. Learn more

template_id
string^tmpl_[a-zA-Z0-9]+$

Unique identifier prefixed with tmpl_. ID of a saved HTML template.

template_version_id
string^vrsn_[a-zA-Z0-9]+$

Unique identifier prefixed with vrsn_.

campaign_id
string or null

The unique ID of the associated campaign if the resource was generated from a campaign.

-
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

+
fsc
boolean
Default: false

This is in beta. Contact support@lob.com or your account contact to learn more. Not available for A4 letter size.

status
any (The status of the letter.)
Enum: "processed" "rendered" "failed"
failure_reason
string or null

A string describing the reason for failure if the letter failed to render.

object
string
Default: "letter"
Value: "letter"

Value is resource type.

Response Schema: application/json
required
Array of us_verification (object) or error (object)
errors
required
boolean

Indicates whether any errors occurred during the verification process.

Request samples

Content type
{
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "addresses": [
    • {
      }
    ],
  • "errors": false
}

Single Verify

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 for details.

+
https://api.lob.com/v1/bulk/us_verifications

Request samples

Content type
{
  • "addresses": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "addresses": [
    • {
      }
    ],
  • "errors": false
}

Single Verify

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 for details.

Authorizations:
basicAuth
query Parameters
case
string
Default: "upper"
Enum: "upper" "proper"

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.

Request Body schema:
One of
Any of
city
required
string <= 200 characters

The name of the city. city and state are required if no zip_code is passed.

state
required
string <= 50 characters

The ISO 3166-2 two letter code or subdivision name for the state. city and state are required if no zip_code is passed.

@@ -5048,7 +5048,7 @@

Example Create Request using Sen

object
string
Default: "us_verification"
Value: "us_verification"

Value is resource type.

Request samples

Content type
Example
{
  • "primary_line": "210 King Street",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
Example
{
  • "id": "us_ver_c7cb63d68f8d6",
  • "recipient": "LOB.COM",
  • "primary_line": "210 KING ST STE 6100",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1728",
  • "deliverability": "deliverable",
  • "valid_address": true,
  • "components": {
    • "primary_number": "185",
    • "street_predirection": "",
    • "street_name": "KING",
    • "street_suffix": "ST",
    • "street_postdirection": "",
    • "secondary_designator": "STE",
    • "secondary_number": "6100",
    • "pmb_designator": "",
    • "pmb_number": "",
    • "extra_secondary_designator": "",
    • "extra_secondary_number": "",
    • "city": "SAN FRANCISCO",
    • "state": "CA",
    • "zip_code": "94107",
    • "zip_code_plus_4": "1728",
    • "zip_code_type": "standard",
    • "delivery_point_barcode": "941071728506",
    • "address_type": "commercial",
    • "record_type": "highrise",
    • "default_building_address": false,
    • "county": "SAN FRANCISCO",
    • "county_fips": "06075",
    • "carrier_route": "C001",
    • "carrier_route_type": "city_delivery",
    • "latitude": 37.77597542841264,
    • "longitude": -122.3929557343685
    },
  • "deliverability_analysis": {
    • "dpv_confirmation": "Y",
    • "dpv_cmra": "N",
    • "dpv_vacant": "N",
    • "dpv_active": "Y",
    • "dpv_footnotes": [
      ],
    • "ews_match": false,
    • "lacs_indicator": "",
    • "lacs_return_code": "",
    • "suite_return_code": ""
    },
  • "lob_confidence_score": {
    • "score": 100,
    • "level": "high"
    },
  • "object": "us_verification"
}

US Verification Types

These are detailed definitions for various fields in the US verification object.

+
https://api.lob.com/v1/us_verifications

Request samples

Content type
Example
{
  • "primary_line": "210 King Street",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
Example
{
  • "id": "us_ver_c7cb63d68f8d6",
  • "recipient": "LOB.COM",
  • "primary_line": "210 KING ST",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1702",
  • "deliverability": "deliverable",
  • "valid_address": true,
  • "components": {
    • "primary_number": "210",
    • "street_predirection": "",
    • "street_name": "KING",
    • "street_suffix": "ST",
    • "street_postdirection": "",
    • "secondary_designator": "",
    • "secondary_number": "",
    • "pmb_designator": "",
    • "pmb_number": "",
    • "extra_secondary_designator": "",
    • "extra_secondary_number": "",
    • "city": "SAN FRANCISCO",
    • "state": "CA",
    • "zip_code": "94107",
    • "zip_code_plus_4": "1702",
    • "zip_code_type": "standard",
    • "delivery_point_barcode": "941071702108",
    • "address_type": "commercial",
    • "record_type": "street",
    • "default_building_address": false,
    • "county": "SAN FRANCISCO",
    • "county_fips": "06075",
    • "carrier_route": "C032",
    • "carrier_route_type": "city_delivery",
    • "po_box_only_flag": "N",
    • "latitude": 37.77597542841264,
    • "longitude": -122.3929557343685
    },
  • "deliverability_analysis": {
    • "dpv_confirmation": "Y",
    • "dpv_cmra": "N",
    • "dpv_vacant": "N",
    • "dpv_active": "Y",
    • "dpv_inactive_reason": "",
    • "dpv_throwback": "N",
    • "dpv_non_delivery_day_flag": "N",
    • "dpv_non_delivery_day_values": "",
    • "dpv_no_secure_location": "N",
    • "dpv_door_not_accessible": "N",
    • "dpv_footnotes": [
      ],
    • "ews_match": false,
    • "lacs_indicator": "",
    • "lacs_return_code": "",
    • "suite_return_code": ""
    },
  • "lob_confidence_score": {
    • "score": 100,
    • "level": "high"
    },
  • "object": "us_verification"
}

US Verification Types

These are detailed definitions for various fields in the US verification object.

ZIP Code Types - components[zip_code_type]

@@ -7243,7 +7243,7 @@

Changelog

View our Changelog here.