Search address

Searches for an address.

The API returns a list of matching addresses.

URL

POST https://api.complycube.com/v1/lookup/addresses

Headers

Name	Type	Description
Content-Type*	string	The content-type must always be set to application/json.
Authorization*	string	The API live or test key.

Body

Name	Type	Description
line*	string	The line of the address.
country*	string	The country of the address. This will be the two-letter country ISO code.
postalCode*	string	The zip or postal code of the address.

Example request

cURL

curl -X POST https://api.complycube.com/v1/lookup/addresses \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
               "line": "350 Fifth",
               "postalCode": "10118",
               "country": "US"
        }'

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const client = await complycube.lookup.searchAddress({
    line: "350 Fifth",
    postalCode: "10118",
    country: "US"
});

The Address object

Attribute	Type	Description
propertyNumber	string	The property number of the address.
buildingName	string	The building name of the address.
line	string	The line of the address.
city	string	The city or town of the address.
state	string	The county, state, or province of the client's address. When country is US, this will be the state's USPS abbreviation (e.g. NY, CA, or DE).
postalCode	string	The zip or postal code of the address.
country	string	The country of the address. This will be the two-letter country ISO code.

Example response

Success (200)

{
    "totalItems": 1,
    "items": [
        {
            "propertyNumber": "350",
            "line": "350 5th Ave, New York, NY 10118-0100",
            "city": "New York",
            "state": "NY",
            "postalCode": "10118-0100",
            "country": "US"
        }
    ]
}