API Reference
v1.7.3
Search
K

Search address

Searches for an address.
The API returns a list of matching addresses.
post
https://api.complycube.com
/lookup/addresses
Search for an address
Parameters
Header
Content-Type*
string
The content-type must always be set to application/json.
Authorization*
string
The live or sandbox API key.
Body
line*
string
The line of the address.
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.
Responses
200: OK
Search complete successfully.

Example request

cURL
Node.js
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"
}'
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.