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

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

Request body

line1string nullable

Primary address line, such as street name and number

line2string nullable

Additional address details, such as an apartment or suite number

line3string nullable

Additional address details for complex addresses

citystring nullable

The city or town name for the address

statestring nullable

State, province, or region of the address

countrystring nullable

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 nullable

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 nullable

Unique identifier for the request, if applicable

countystring nullable

County or district name for the address

fullAddressstring nullable

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"}

Changes

Changed in 1 of the 2 revisions of this API.1112

Aug 29, 20266ba4f4c774c31112See the full diff
- ▲
  added the new required header request parameter x-organization-id
  new-required-request-parameter
- ●
  removed the request property full_address
  request-property-removed
- ○
  the endpoint scheme security APIKeyHeader was added to the API
  api-security-added
- ○
  the endpoint scheme security APIKeyHeader AND CustomHeader was removed from the API
  api-security-removed
- ○
  added the new optional request property fullAddress
  new-optional-request-property
- ○
  request property city list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property country list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property county list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property id list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property line1 list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property line2 list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property line3 list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property postalCode list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property state list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
This revision also has 362 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history