v1

latestOpenAPI 3.0.02026-07-12414931.1 MB

Address Validation

Suggestions

This API endpoint provides address suggestions based on partial input data. It helps users auto-complete and validate addresses efficiently by returning a list of suggested addresses that match the input criteria. This improves accuracy, increases speed, reduces errors, and streamlines the data entry process.

post/v1/address_validation/suggestions

Request body

line1string

Primary address line, such as street name and number

line2string

Additional address details, such as an apartment or suite number

line3string

Additional address details for complex addresses

citystring

The city or town name for the address

statestring

State, province, or region of the address

countrystring

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

postalCodestring

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

idinteger

Unique identifier for the request, if applicable

countystring

County or district name for the address

full_addressstring

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

Response

Successfully retrieved address suggestions

{"stackTrail":"paths:/v1/address_validation/suggestions:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}