Skip to main content
POST
/
v1
/
address_validation
/
suggestions
Suggestions
curl --request POST \
  --url https://api.trykintsugi.com/v1/address_validation/suggestions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <api-key>' \
  --data '
{
  "line1": "1600 Amphitheatre Parkway",
  "line2": "",
  "line3": "",
  "city": "Mountain View",
  "state": "CA",
  "postalCode": "94043",
  "id": 215,
  "county": "",
  "full_address": "1600 Amphitheatre Parkway, Mountain View, CA 94043",
  "country": "US"
}
'
[
  {
    "city": "MOUNTAIN VIEW",
    "county": "Santa Clara County",
    "state": "CA",
    "postal_code": "94043",
    "country": "US"
  },
  {
    "city": "MOUNTAIN VIEW",
    "county": "Santa Clara County",
    "state": "CA",
    "postal_code": "94040",
    "country": "US"
  }
]

Authorizations

X-API-KEY
string
header
required
x-organization-id
string
header
required

Body

application/json
line1
string

Primary address line, such as street name and number

line2
string

Additional address details, such as an apartment or suite number

line3
string

Additional address details for complex addresses

city
string

The city or town name for the address

state
string

State, province, or region of the address

country
string
default:US

Country code in ISO 3166-1 alpha-2 format (e.g., 'US' for the United States). Defaults to 'US'. should not be empty. Not validating here as the validation structure can be different for different providers

postalCode
string
default:""

ZIP or postal code for the address. Can be empty for some locales. Not validating here as the validation structure can be different for different providers

id
integer

Unique identifier for the request, if applicable

county
string

County or district name for the address

full_address
string

A complete address string that can be used as an alternative to providing individual fields.

Response

Successfully retrieved address suggestions