Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
resolve-address
Resolve Address
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/resolve-address \
  --header 'Authorization: <api-key>'
{
  "street": "350 5th Avenue",
  "city": "New York",
  "state": "NY",
  "county": "New York County",
  "country": "United States",
  "zipCode": "10001"
}

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

address
string
required

Freeform address string to geocode. Must be non-empty and non-blank (whitespace-only values are rejected).

Minimum string length: 1

Response

Address resolved successfully into all six subfields

Structured address resolved from a freeform input string. Every field is guaranteed to be populated — the endpoint returns a 400 error rather than a partial address when any subfield (including county) cannot be determined.

street
string
required

Street number and route (e.g. "350 5th Avenue")

city
string
required

City or locality (e.g. "New York")

state
string
required

2-letter state or administrative region code (e.g. "NY")

county
string
required

County or second-order administrative area (e.g. "New York County")

country
string
required

Country name (e.g. "United States")

zipCode
string
required

Postal / zip code as a string. Leading zeros are preserved (e.g. "02140").