GET
Retrieve an address validation

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Path Parameters

id
string
required

Response

OK

id
string
required
object
enum<string>
required
Available options:
address_validation
status
enum<string>
required
Available options:
verified,
corrected,
ambiguous,
unverified,
invalid
deliverability
enum<string>
Available options:
deliverable,
deliverable_missing_unit,
undeliverable,
unknown
input
object
suggested
object | null
alternatives
object[]
components
object
residential
boolean | null
geocode
object | null
changes
string[]
connection
string
messages
object[]
carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.