From dd84c85233e1c940143b722fc6d6f83fa034be05 Mon Sep 17 00:00:00 2001 From: amaan-lob <72472696+amaan-lob@users.noreply.github.com> Date: Fri, 19 Aug 2022 12:05:29 -0700 Subject: [PATCH] chore: add company field to identity validation (#379) * chore: add company field to identity validation * Update resources/identity_validation/attributes/identity_validation_recipient.yml Co-authored-by: BennyKitchell Co-authored-by: Aditi Ramaswamy <15935019+sudoku-lord@users.noreply.github.com> --- docs/index.html | 16 ++--- .../identity_validation_company.yml | 7 +++ .../identity_validation_recipient.yml | 7 +++ .../identity_validation.yml | 14 ++--- .../models/company_identity_validation.yml | 63 +++++++++++++++++++ .../models/company_multi_line_address.yml | 50 +++++++++++++++ .../models/identity_validation.yml | 61 +----------------- .../models/identity_validation_writable.yml | 3 + .../models/recipient_identity_validation.yml | 63 +++++++++++++++++++ ...s.yml => recipient_multi_line_address.yml} | 2 +- .../responses/identity_validation.yml | 2 +- tests/identity_validation_test.js | 33 +++++++++- 12 files changed, 243 insertions(+), 78 deletions(-) create mode 100644 resources/identity_validation/attributes/identity_validation_company.yml create mode 100644 resources/identity_validation/attributes/identity_validation_recipient.yml create mode 100644 resources/identity_validation/models/company_identity_validation.yml create mode 100644 resources/identity_validation/models/company_multi_line_address.yml create mode 100644 resources/identity_validation/models/identity_validation_writable.yml create mode 100644 resources/identity_validation/models/recipient_identity_validation.yml rename resources/identity_validation/models/{multi_line_address.yml => recipient_multi_line_address.yml} (95%) diff --git a/docs/index.html b/docs/index.html index cae3346f..ad341745 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5249,9 +5249,9 @@

DPV Footnotes - deliverability_analysis[dpv_footnotes]

https://api.lob.com/v1/us_zip_lookups

Request samples

Content type
{
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "us_zip_c7cb63d68f8d6",
  • "cities": [
    • {
      }
    ],
  • "zip_code_type": "standard",
  • "object": "us_zip_lookup",
  • "zip_code": "94107"
}

Identity Validation

Validates whether a given name is associated with an address.

back to top

Identity Validation

Validates whether a given name is associated with an address.

-
Authorizations:
basicAuth
Request Body schema:
Any of
city
required
string <= 200 characters

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

+
Authorizations:
basicAuth
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.

-
recipient
required
string or null (recipient) <= 500 characters

The intended recipient, typically a person's or firm's name.

+
recipient
required
string or null (identity_validation_recipient) <= 500 characters

The name of the person whose identity is being validated.

primary_line
required
string (primary_line_us) <= 500 characters

The primary delivery line (usually the street address) of the address. Combination of the following applicable components:

    @@ -5268,12 +5268,12 @@

    DPV Footnotes - deliverability_analysis[dpv_footnotes]

secondary_line
string (secondary_line) <= 500 characters

The secondary delivery line of the address. This field is typically empty but may contain information if primary_line is too long.

urbanization
string (urbanization) <= 500 characters

Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See USPS documentation for clarification.

zip_code
string^\d{5}((-)?\d{4})?$

Required if city and state are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. 94107, 941072282, 94107-2282).

-

Responses

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.

ratelimit-reset
integer
Example: 1528749846

The time at which the rate limit window resets in UTC epoch seconds

-
Response Schema: application/json
id
string (identity_validation_id) ^id_validation_[a-zA-Z0-9_]+$

Unique identifier prefixed with id_validation_.

-
recipient
string or null (recipient) <= 500 characters

The intended recipient, typically a person's or firm's name.

+
Response Schema: application/json
One of
Any of
id
string (identity_validation_id) ^id_validation_[a-zA-Z0-9_]+$

Unique identifier prefixed with id_validation_.

+
recipient
string or null (identity_validation_recipient) <= 500 characters

The name of the person whose identity is being validated.

primary_line
string (primary_line_us) <= 500 characters

The primary delivery line (usually the street address) of the address. Combination of the following applicable components:

    @@ -5305,9 +5305,9 @@

    DPV Footnotes - deliverability_analysis[dpv_footnotes]

  • "" — No tracking data exists for this address.
object
string
Default: "id_validation"
Value: "id_validation"

Value is resource type.

-

Request samples

Content type
{
  • "recipient": "Lob.com",
  • "primary_line": "210 King St.",
  • "secondary_line": "",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "id_validation_8a013f3e",
  • "recipient": "LOB.COM",
  • "primary_line": "210 KING ST.",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1728",
  • "score": 100,
  • "confidence": "high",
  • "object": "id_validation"
}

Intl Autocompletions

Address autocompletion for non-US addresses. Given partial address information, this endpoint returns up to 10 address suggestions.

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

Request samples

Content type
{
  • "company": "Lob.com",
  • "primary_line": "210 King St.",
  • "secondary_line": "",
  • "city": "San Francisco",
  • "state": "CA",
  • "zip_code": "94107"
}

Response samples

Content type
application/json
{
  • "id": "id_validation_8a013f3e",
  • "company": "LOB.COM",
  • "primary_line": "210 KING ST.",
  • "secondary_line": "",
  • "urbanization": "",
  • "last_line": "SAN FRANCISCO CA 94107-1728",
  • "score": 100,
  • "confidence": "high",
  • "object": "id_validation"
}

Intl Autocompletions

Address autocompletion for non-US addresses. Given partial address information, this endpoint returns up to 10 address suggestions.

Autocompletion Test Env

Your test API key does not autocomplete international addresses and is used to simulate behavior. With your test API key, requests with specific values for address_prefix return predetermined values. When address_prefix is set to:

@@ -6957,7 +6957,7 @@

Changelog