Validate Address

Beta
PUT/v1/core/addresses/actions/validate

This endpoint is idempotent. Learn more

Validates an address and returns whether it is valid, a formatted version, and any validation messages.

address_line_1string

First line of the street address.

address_line_2optional string

Second line of the street address.

citystring

City or locality.

statestring

State or administrative area.

postal_codestring

Postal or ZIP code.

countrystring

Country name or two-letter country code (for example United States or US).

objectstringenumValues:validated_address

Resource type identifier.

statusstringenumValues:validinvalid

Whether the address could be validated.

formatted_addressstringnullable

Formatted, single-line address as standardized by the validation service.

The validation service may omit this regardless of status, so it can be absent even for a valid address.

componentsaddress_componentsnullable

Standardized, parsed address components returned by the validation service.

The validation service may omit this regardless of status, so it can be absent even for a valid address.

objectstringenumValues:address_components

Resource type identifier.

address_line_1string

First line of the street address.

address_line_2stringnullable

Second line of the street address.

citystring

City or locality.

statestring

State or administrative area.

postal_codestring

Postal or ZIP code.

countrystring

Country name or code.

country_codestring

Two-letter country code.

validation_messagesarray of string

Human-readable messages describing issues found during validation.

May be non-empty even when status is valid, for example when components were inferred or replaced with standardized values. Empty when no issues were reported.

Responses

200

Successful response for Validate Address