TRtrykintsugi
Address Validation

Suggestions

Changed on

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

  • Base URL
    https://api.trykintsugi.com
  • URL
    https://api.trykintsugi.com/v1/address_validation/suggestions
  • Auth
    API key in header X-API-KEY

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

unknown required

Changes

  • 6ba4f4c774c3Revision changes
    • breaking

      added the new required header request parameter x-organization-id

    • warning

      removed the request property

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      the endpoint scheme security APIKeyHeader AND CustomHeader was removed from the API

    • info

      added the new optional request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    This list may be incomplete.