api.address.validate

GET /address/isvalid — ACPortal

Python

api.address.validate(*, line1: str, city: str, state: str, zip: str) -> AddressIsValidResult

CLI

ab address validate [--line1 ...] [--city ...] [--state ...] [--zip ...]

GET /address/isvalid

Query parameters — AddressValidateParams

Field

Type

Required

Description

Line1

Optional[str]

no

Street address line 1

City

Optional[str]

no

City name

State

Optional[str]

no

State abbreviation

Zip

Optional[str]

no

ZIP/postal code

Response

Returns AddressIsValidResult.

Field

Type

Required

Description

isValid

Optional[bool]

no

Whether address is valid

validatedAddress

Optional[dict]

no

Corrected/validated address

suggestions

Optional[list[dict]]

no

Alternative suggestions

dontValidate

Optional[bool]

no

Skip validation flag

countryId

Optional[str]

no

Country UUID

countryCode

Optional[str]

no

ISO country code

latitude

Optional[float]

no

Latitude

longitude

Optional[float]

no

Longitude

propertyType

Optional[int]

no

Property type classification


← Back to api.address