Bulk Address Lookup

The Bulk Address Lookup API allows you to verify and validate multiple US addresses at once. You can provide either a freeform full address or separate address components (street, apt/suite/other, city, state, zipcode) to verify if they form a valid US address.

The bulk address lookup model

The bulk address lookup model contains a status, request, message, and the result of all the information from the Address Lookup result.

Bulk Address Lookup Properties

Name
status
Type
string
Description
The status of the lookup: SUCCESS, FAIL.
Name
request
Type
LookupRequest
Description
The original lookup request.
Name
message
Type
result
Description
Success message, or reason for failure, if the individual item failed.
Name
result
Type
AddressLookup
Description
The Address Lookup Model.

Read the docs for the Address Lookup model.

LookupRequest

Name
full_address
Type
string
Description
Freeform full US address.
Name
street_address
Type
string
Description
The street line of the address.
Name
apt_suite_other
Type
string
Description
The apartment, suite or space number.
Name
city
Type
string
Description
Name of the city.
Name
state
Type
string
Description
The two-letter abbreviation or full name of US state.
Name
zip_code
Type
string
Description
The ZIP code.
Name
country
Type
string
Description
The two or three letter abbreviation. Only US/USA is supported.

POST/v1/addresses/lookup/bulk

Bulk address lookup

This endpoint verifies multiple US addresses in a single request. You can provide a list of addresses, each with either a freeform full address or separate address components.

Required attributes

Name
items
Type
array
Description
Array of address lookup requests to process in bulk.

Lookup request properties

Name
full_address
Type
string
Description
Freeform full US address.
Name
street_address
Type
string
Description
The street line of the address.
Name
apt_suite_other
Type
string
Description
The apartment, suite or space number.
Name
city
Type
string
Description
Name of the city.
Name
state
Type
string
Description
The two-letter abbreviation or full name of US state.
Name
zip_code
Type
string
Description
The ZIP code.
Name
country
Type
string
Description
The 2 or 3 digit country code. Only US/USA is supported.

Request

POST

/v1/addresses/lookup/bulk

curl -X POST https://us-address.addressfully.com/address-lookup/v1/addresses/lookup/bulk \
    -H "Authorization: Bearer {api_key}" \
    -H "Content-Type: application/json" \
    -d '{
            "items": [
                {
                    "full_address": "",
                    "street_address": "1250 Prospect St",
                    "apt_suite_other": "",
                    "city": "La Jolla",
                    "state": "CA",
                    "zip_code": "92037",
                    "country": "US"
                }
            ]
        }'

Response

[
    {
        "status": "SUCCESS",
        "request" : {
            "full_address" : "",
            "street_address" : "1250 Prospect St",
            "apt_suite_other" : "",
            "city" : "La Jolla",
            "state" : "CA",
            "zip_code" : "92037",
            "country" : "US"
        },
        "message" : "Lookup successful",
        "result" : {
            "original_lookup_request" : {
                "full_address" : "",
                "street_address" : "1250 Prospect St",
                "apt_suite_other" : "",
                "city" : "La Jolla",
                "state" : "CA",
                "zip_code" : "92037",
                "country" : "US"
            },
            "lookup_index" : 0,
            "address_line1" : "1250 PROSPECT ST ",
            "address_line2" : "LA JOLLA, CA 92037-3680",
            "lookup_status" : "ADDRESS_FOUND",
            "address_accuracy_level" : "ROOFTOP",
            "address_breakdown" : {
                "primary_no" : "1250",
                "street_name" : "PROSPECT",
                "street_suffix_abbrev" : "ST",
                "secondary_no" : "",
                "secondary_abbrev" : "",
                "city_name" : "LA JOLLA",
                "preferred_city_name" : "LA JOLLA",
                "state" : "CA",
                "zip_code" : "92037",
                "zip_add_on_no" : "3680",
                "county_name" : "SAN DIEGO"
            },
            "address_additional_info" : {
                "record_type_code" : "H",
                "carrier_route_id" : "C013",
                "county_no" : "073",
                "congressional_dist_no" : "50"
            },
            "address_delivery_info" : {
                "dpv_confirmation_indicator" : "",
                "dpv_cmra_indicator" : "",
                "dpv_door_not_accessible_indicator" : "",
                "dpv_drop_indicator" : "",
                "dpv_false_positive_indicator" : "",
                "dpv_footnotes" : "",
                "dpv_no_stats_indicator" : "",
                "dpv_no_stats_reason_code" : "",
                "dpv_no_secure_location" : "",
                "dpv_pbsa_indicator" : "",
                "dpv_vacant_indicator" : "",
                "residential_delivery_indicator" : "",
                "building_or_firm_name" : ""
            }
        }
    }
]