API Documentation
Address Lookup
Our Address Lookup API validates residential addresses and provides detailed information about the property type and estimated value.
Single Line Address Request
Request Header Parameters:
Object | Description |
---|---|
x-api-key | [Required] Your API access key, available in your account dashboard. |
Request Body Parameters:
Object | Description |
---|---|
address | [Required] The address to be verified. |
Response Body Parameters:
Object | Type | Description |
---|---|---|
address | [string] | The full verified address. |
addressValid | [boolean] | Whether the address is a residential property. |
homeType | [string] | The type of property. |
homeValue | [int] | The real-time estimated value of the property. |
Example Success Response :
{ "address": "1013 Bates Ave, Bakersfield, CA, 93307", "addressValid": true, "homeType": "SINGLE_FAMILY", "homeValue": "273900" }
Example Error Response :
{ "message": "Invalid address. Please include the street number", "error": "Bad Request", "statusCode": 400 }
Multi Line Address Request
Request Header Parameters:
Object | Description |
---|---|
x-api-key | [Required] Your API access key, available in your account dashboard. |
Request Body Parameters:
Object | Description |
---|---|
street | [Required] The street number and name of the address. |
city | [Required] The city of the address. |
state | [Required] The state of the address. |
zip | [Required] The zip of the address. |
Response Body Parameters:
Object | Type | Description |
---|---|---|
address | [string] | The full verified address. |
addressValid | [boolean] | Whether the address is a residential property. |
homeType | [string] | The type of property. |
homeValue | [int] | The real-time estimated value of the property. |
Example Success Response :
{ "address": "1013 Bates Ave, Bakersfield, CA, 93307", "addressValid": true, "homeType": "SINGLE_FAMILY", "homeValue": "273900" }
Example Error Response :
{ "message": "Invalid address. Please include the street number", "error": "Bad Request", "statusCode": 400 }
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.
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.
Home Type List
Home Type List
Home Type | Description |
---|---|
APARTMENT | Apartment |
CONDO | Condominium |
LOT | Land Parcel |
MANUFACTURED | Mobile Home |
MULTI_FAMILY | Multi-Family Residence (Apartment|Condominium|Townhouse) |
SINGLE_FAMILY | Single Family Residence |
TOWNHOUSE | Townhouse |
UNKNOWN | AddressVerify.io could not verify this property |
APARTMENT
Apartment
CONDO
Condominium
LOT
Land Parcel
MANUFACTURED
Mobile Home
MULTI_FAMILY
Multi-Family Residence (Apartment|Condominium|Townhouse)
SINGLE_FAMILY
Single Family Residence
TOWNHOUSE
Townhouse
UNKNOWN
AddressVerify.io could not verify this property
Error Code List
Error Code List:
Code | Type | Info |
---|---|---|
401 | Unauthorized | The request requires user authentication.No user found with the provided credentials.User account is not active.Authentication token has expired. |
402 | No active plans found | The user has no active subscription plans.No active subscription plan found for this API. |
404 | User not found | The system could not find the requested user. |
429 | Rate limit exceeded | The user has sent too many requests in a given amount of time.The total request limit for the user has been exceeded. |
400 | Bad request | The request is missing a required email address or passwords. |
Code Examples
Code Examples:
Highest Level of Compatibility
No need for a specific set of skills to parse data — our API functionality can be implemented in under 10 minutes using any major programming language.
- PHP
- Python
- Node Js
- Go
- Ruby
example.php
<?php
$client = new Client();
$headers = [
'x-api-key' => '{{apiKey}}'
];
$body = '{
"address":"1013 Bates Ave, Bakersfield, CA, 93307"
}';
$request = new Request('POST', 'https://api.addressverify.io/service/lookup/address', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();