Kaaj Address Verification API
This document describes the API endpoint for verifying business addresses.
Endpoint
GET https://api.kaaj.ai/application/address-verification
Headers
Authorization: Bearer <your_api_key>
Request Parameters
URL query parameters:
Parameter Name | Type | Required | Description |
---|---|---|---|
app_id | string | Yes | Unique identifier for the application/form |
business_name | string | Yes | Legal name of the business |
address | string | Yes | Business address to verify |
Example Request
https://api.kaaj.ai/application/address-verification?app_id=1234560fe-283-c0d674bf&business_name=HEY%20FOO%20CAF%C3%89%20LLC&address=123%20Halstead%20Avenue%2C%20New%20York
Response
Success Response
- Code: 200 OK
- Content:
Field Name | Type | Description |
---|---|---|
from_db | boolean | Indicates if the result was retrieved from database |
address_verification | object | Contains all verification data |
The address_verification
object contains:
Field Name | Type | Description |
---|---|---|
id | integer | Unique identifier for this verification |
business_name | string | Legal name of the business (as input) |
address | string | Business address (as input) |
verification_data | object | Results of the address verification |
app_id | string | Unique identifier for the application/form (as input) |
search_result | object | Results of address search |
azure_image_url | array | List of URLs to street view images |
street_view_metadata | object | Metadata about the street view images |
The verification_data
object contains:
Field Name | Type | Description |
---|---|---|
is_present | boolean | Indicates if the business is present at the address |
business_name | string | Business name as verified |
can_see_buildings | boolean | Indicates if buildings are visible in street view |
neighborhood_type | string | Type of neighborhood (e.g., commercial, residential) |
can_see_business_sign | boolean | Indicates if business signage is visible |
street_view_image_present | boolean | Indicates if street view images are available |
The search_result
object contains:
Field Name | Type | Description |
---|---|---|
found | boolean | Indicates if the address was found |
matched_address | string | The matched address if found, null otherwise |
Sample Response
{
"from_db": true,
"address_verification": {
"id": 37,
"business_name": "HEY FOO CAFÉ LLC",
"address": "123 Halstead Avenue, New York",
"verification_data": {
"is_present": false,
"business_name": "HEY FOO CAFÉ LLC",
"can_see_buildings": true,
"neighborhood_type": "commercial",
"can_see_business_sign": false,
"street_view_image_present": true
},
"app_id": "356880fe-efcd-4493-8283-ac8bc0d674bf",
"search_result": {
"found": false,
"matched_address": null
},
"azure_image_url": [
"https://curiefilestorage.blob.core.windows.net/street-view-images/356880fe-efcd-4493-8283-ac8bc0d674bf_HEALTHY%20FOOD%20CAF%C3%89%20LLC_0_2025-03-07%2010%3A46%3A11.394988.jpg?se=9999-12-31T00%3A00%3A00Z&sp=r&spr=https%2Chttp&sv=2025-01-05&sr=b&sig=pJrDaSxST%2B3usOTTb8VsfqJB7k6P3VSxdEktrNjJ4Uk%3D",
"https://curiefilestorage.blob.core.windows.net/street-view-images/356880fe-efcd-4493-8283-ac8bc0d674bf_HEALTHY%20FOOD%20CAF%C3%89%20LLC_1_2025-03-07%2010%3A46%3A11.396468.jpg?se=9999-12-31T00%3A00%3A00Z&sp=r&spr=https%2Chttp&sv=2025-01-05&sr=b&sig=7SB2/HopdEvm8KLOghm4FGhLYd3vs34pIiSEreNKbt8%3D",
"https://curiefilestorage.blob.core.windows.net/street-view-images/356880fe-efcd-4493-8283-ac8bc0d674bf_HEALTHY%20FOOD%20CAF%C3%89%20LLC_2_2025-03-07%2010%3A46%3A11.397394.jpg?se=9999-12-31T00%3A00%3A00Z&sp=r&spr=https%2Chttp&sv=2025-01-05&sr=b&sig=bkLq8VBhmKLUW1DkeDvK9d%2Bn%2B7%2B0gE9kLUPkBOh5VD4%3D",
"https://curiefilestorage.blob.core.windows.net/street-view-images/356880fe-efcd-4493-8283-ac8bc0d674bf_HEALTHY%20FOOD%20CAF%C3%89%20LLC_3_2025-03-07%2010%3A46%3A11.398300.jpg?se=9999-12-31T00%3A00%3A00Z&sp=r&spr=https%2Chttp&sv=2025-01-05&sr=b&sig=x%2BnYih38aZzkFcTTefsKP5RxUgZ0q2YBU%2BdcIwaV5uI%3D"
],
"street_view_metadata": {
"date": "2021-10",
"status": "OK",
"pano_id": "gY7ordDxjvcRkrh5IGRb3g",
"location": {
"lat": 40.95489985836724,
"lng": -73.73445703716368
},
"copyright": "© Google"
}
}
}
Error Response
- Code: 400 Bad Request
- Content:
{
"message": "One of the following parameters is missing - 'app_id', 'business_name', 'address'"
}
Notes
- All required parameters must be provided in the URL query string.
- The API key must be included in the Authorization header for authentication.
- URL parameters should be properly URL-encoded to handle special characters.
- The response includes detailed information about the business address verification, including street view images if available.
- The
from_db
field indicates whether the result was retrieved from a cached database entry or freshly generated.