API Documentation
Complete guide to integrating the AddressVerify API into your application.
Address Lookup
Our Address Lookup API validates residential addresses and provides detailed information about the property type and estimated value.
Single Line Address Request
Submit a complete address in a single line for quick verification. The API will parse and validate the address components automatically.
POST
https://api.addressverify.io/service/lookup/address
Request Headers
Parameter | Description |
---|---|
x-api-key | [Required] Your API access key |
Request Body
Parameter | Description |
---|---|
address | [Required] The address to be verified |
Response
{ "address": "1013 Bates Ave, Bakersfield, CA, 93307", "addressValid": true, "homeType": "SINGLE_FAMILY", "homeValue": "273900" }
Multi Line Address Request
Submit address components separately for more precise validation. This method allows you to specify street, city, state, and zip code individually.
POST
https://api.addressverify.io/service/lookup/fields
Request Body
Parameter | Description |
---|---|
street | [Required] Street number and name |
city | [Required] City name |
state | [Required] State abbreviation |
zip | [Required] ZIP code |
Home Type List
Home Type | Description |
---|---|
APARTMENT | Apartment |
CONDO | Condominium |
LOT | Land Parcel |
MANUFACTURED | Mobile Home |
MULTI_FAMILY | Multi-Family Residence |
SINGLE_FAMILY | Single Family Residence |
TOWNHOUSE | Townhouse |
UNKNOWN | Could not verify property |
Error Code List
Code | Type | Description |
---|---|---|
400 | Bad Request | Invalid or missing parameters |
401 | Unauthorized | Invalid API key or authentication |
402 | Payment Required | No active subscription plan |
404 | Not Found | Resource not found |
429 | Too Many Requests | Rate limit exceeded |
Code Examples
const axios = require('axios');
const config = {
method: 'post',
url: 'https://api.addressverify.io/service/lookup/address',
headers: {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
data: {
address: '123 Main St, New York, NY 10001'
}
};
axios(config)
.then(response => console.log(JSON.stringify(response.data)))
.catch(error => console.log(error));