Address Validation

This API validates and enriches address information submitted by the user. It ensures that the address is standardized, accurate, and compliant with geographical and postal standards. The API also adds additional fields, such as county, when possible.

post/v1/address_validation/search

Request

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

Request body

phonestring nullable

Phone number associated with the address.

street_1string nullable

Primary street address.

street_2string nullable

Additional street address details, such as an apartment or suite number.

citystring nullable

City where the customer resides.

countystring nullable

County or district of the customer.

statestring nullable

State or province of the customer.

postal_codestring nullable

ZIP or Postal code of the customer.

country'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'CI' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'XK' | 'ZZ_EU'
full_addressstring nullable

Complete address string of the customer, which can be used as an alternative to individual fields.

Response

Address found successfully

verification_statusstring required

Indicates if the address was VERIFIED, PARTIALLY_VERIFIED, INVALID, UNVERIFIABLE, BLANK

enrich_fieldsstring[] required

List of additional fields added to enrich the address

Changes

    • breaking

      removed the enum value AD of the request property

    • breaking

      removed the enum value AE of the request property

    • breaking

      removed the enum value AF of the request property

    • breaking

      removed the enum value AG of the request property

    • breaking

      removed the enum value AI of the request property

    • breaking

      removed the enum value AL of the request property

    • breaking

      removed the enum value AM of the request property

    • breaking

      removed the enum value AO of the request property

    • breaking

      removed the enum value AQ of the request property

    • breaking

      removed the enum value AR of the request property

    • breaking

      removed the enum value AS of the request property

    • breaking

      removed the enum value AT of the request property

    • breaking

      removed the enum value AU of the request property

    • breaking

      removed the enum value AW of the request property

    • breaking

      removed the enum value AX of the request property

    • breaking

      removed the enum value AZ of the request property

    • breaking

      removed the enum value BA of the request property

    • breaking

      removed the enum value BB of the request property

    • breaking

      removed the enum value BD of the request property

    • breaking

      removed the enum value BE of the request property

    • breaking

      removed the enum value BF of the request property

    • breaking

      removed the enum value BG of the request property

    • breaking

      removed the enum value BH of the request property

    • breaking

      removed the enum value BI of the request property

    • breaking

      removed the enum value BJ of the request property

    • breaking

      removed the enum value BL of the request property

    • breaking

      removed the enum value BM of the request property

    • breaking

      removed the enum value BN of the request property

    • breaking

      removed the enum value BO of the request property

    • breaking

      removed the enum value BQ of the request property

    • breaking

      removed the enum value BR of the request property

    • breaking

      removed the enum value BS of the request property

    • breaking

      removed the enum value BT of the request property

    • breaking

      removed the enum value BV of the request property

    • breaking

      removed the enum value BW of the request property

    • breaking

      removed the enum value BY of the request property

    • breaking

      removed the enum value BZ of the request property

    • breaking

      removed the enum value CA of the request property

    • breaking

      removed the enum value CC of the request property

    • breaking

      removed the enum value CD of the request property

    • breaking

      removed the enum value CF of the request property

    • breaking

      removed the enum value CG of the request property

    • breaking

      removed the enum value CH of the request property

    • breaking

      removed the enum value CI of the request property

    • breaking

      removed the enum value CK of the request property

    • breaking

      removed the enum value CL of the request property

    • breaking

      removed the enum value CM of the request property

    • breaking

      removed the enum value CN of the request property

    • breaking

      removed the enum value CO of the request property

    • breaking

      removed the enum value CR of the request property

    • breaking

      removed the enum value CU of the request property

    • breaking

      removed the enum value CV of the request property

    • breaking

      removed the enum value CW of the request property

    • breaking

      removed the enum value CX of the request property

    • breaking

      removed the enum value CY of the request property

    • breaking

      removed the enum value CZ of the request property

    • breaking

      removed the enum value DE of the request property

    • breaking

      removed the enum value DJ of the request property

    • breaking

      removed the enum value DK of the request property

    • breaking

      removed the enum value DM of the request property

    • breaking

      removed the enum value DO of the request property

    • breaking

      removed the enum value DZ of the request property

    • breaking

      removed the enum value EC of the request property

    • breaking

      removed the enum value EE of the request property

    • breaking

      removed the enum value EG of the request property

    • breaking

      removed the enum value EH of the request property

    • breaking

      removed the enum value ER of the request property

    • breaking

      removed the enum value ES of the request property

    • breaking

      removed the enum value ET of the request property

    • breaking

      removed the enum value FI of the request property

    • breaking

      removed the enum value FJ of the request property

    • breaking

      removed the enum value FK of the request property

    • breaking

      removed the enum value FM of the request property

    • breaking

      removed the enum value FO of the request property

    • breaking

      removed the enum value FR of the request property

    • breaking

      removed the enum value GA of the request property

    • breaking

      removed the enum value GB of the request property

    • breaking

      removed the enum value GD of the request property

    • breaking

      removed the enum value GE of the request property

    • breaking

      removed the enum value GF of the request property

    • breaking

      removed the enum value GG of the request property

    • breaking

      removed the enum value GH of the request property

    • breaking

      removed the enum value GI of the request property

    • breaking

      removed the enum value GL of the request property

    • breaking

      removed the enum value GM of the request property

    • breaking

      removed the enum value GN of the request property

    • breaking

      removed the enum value GP of the request property

    • breaking

      removed the enum value GQ of the request property

    • breaking

      removed the enum value GR of the request property

    • breaking

      removed the enum value GS of the request property

    • breaking

      removed the enum value GT of the request property

    • breaking

      removed the enum value GU of the request property

    • breaking

      removed the enum value GW of the request property

    • breaking

      removed the enum value GY of the request property

    • breaking

      removed the enum value HK of the request property

    • breaking

      removed the enum value HM of the request property

    • breaking

      removed the enum value HN of the request property

    • breaking

      removed the enum value HR of the request property

    • breaking

      removed the enum value HT of the request property

    • breaking

      removed the enum value HU of the request property

    • breaking

      removed the enum value ID of the request property

    • breaking

      removed the enum value IE of the request property

    • breaking

      removed the enum value IL of the request property

    • breaking

      removed the enum value IM of the request property

    • breaking

      removed the enum value IN of the request property

    • breaking

      removed the enum value IO of the request property

    • breaking

      removed the enum value IQ of the request property

    • breaking

      removed the enum value IR of the request property

    • breaking

      removed the enum value IS of the request property

    • breaking

      removed the enum value IT of the request property

    • breaking

      removed the enum value JE of the request property

    • breaking

      removed the enum value JM of the request property

    • breaking

      removed the enum value JO of the request property

    • breaking

      removed the enum value JP of the request property

    • breaking

      removed the enum value KE of the request property

    • breaking

      removed the enum value KG of the request property

    • breaking

      removed the enum value KH of the request property

    • breaking

      removed the enum value KI of the request property

    • breaking

      removed the enum value KM of the request property

    • breaking

      removed the enum value KN of the request property

    • breaking

      removed the enum value KP of the request property

    • breaking

      removed the enum value KR of the request property

    • breaking

      removed the enum value KW of the request property

    • breaking

      removed the enum value KY of the request property

    • breaking

      removed the enum value KZ of the request property

    • breaking

      removed the enum value LA of the request property

    • breaking

      removed the enum value LB of the request property

    • breaking

      removed the enum value LC of the request property

    • breaking

      removed the enum value LI of the request property

    • breaking

      removed the enum value LK of the request property

    • breaking

      removed the enum value LR of the request property

    • breaking

      removed the enum value LS of the request property

    • breaking

      removed the enum value LT of the request property

    • breaking

      removed the enum value LU of the request property

    • breaking

      removed the enum value LV of the request property

    • breaking

      removed the enum value LY of the request property

    • breaking

      removed the enum value MA of the request property

    • breaking

      removed the enum value MC of the request property

    • breaking

      removed the enum value MD of the request property

    • breaking

      removed the enum value ME of the request property

    • breaking

      removed the enum value MF of the request property

    • breaking

      removed the enum value MG of the request property

    • breaking

      removed the enum value MH of the request property

    • breaking

      removed the enum value MK of the request property

    • breaking

      removed the enum value ML of the request property

    • breaking

      removed the enum value MM of the request property

    • breaking

      removed the enum value MN of the request property

    • breaking

      removed the enum value MO of the request property

    • breaking

      removed the enum value MP of the request property

    • breaking

      removed the enum value MQ of the request property

    • breaking

      removed the enum value MR of the request property

    • breaking

      removed the enum value MS of the request property

    • breaking

      removed the enum value MT of the request property

    • breaking

      removed the enum value MU of the request property

    • breaking

      removed the enum value MV of the request property

    • breaking

      removed the enum value MW of the request property

    • breaking

      removed the enum value MX of the request property

    • breaking

      removed the enum value MY of the request property

    • breaking

      removed the enum value MZ of the request property

    • breaking

      removed the enum value NA of the request property

    • breaking

      removed the enum value NC of the request property

    • breaking

      removed the enum value NE of the request property

    • breaking

      removed the enum value NF of the request property

    • breaking

      removed the enum value NG of the request property

    • breaking

      removed the enum value NI of the request property

    • breaking

      removed the enum value NL of the request property

    • breaking

      removed the enum value NO of the request property

    • breaking

      removed the enum value NP of the request property

    • breaking

      removed the enum value NR of the request property

    • breaking

      removed the enum value NU of the request property

    • breaking

      removed the enum value NZ of the request property

    • breaking

      removed the enum value OM of the request property

    • breaking

      removed the enum value PA of the request property

    • breaking

      removed the enum value PE of the request property

    • breaking

      removed the enum value PF of the request property

    • breaking

      removed the enum value PG of the request property

    • breaking

      removed the enum value PH of the request property

    • breaking

      removed the enum value PK of the request property

    • breaking

      removed the enum value PL of the request property

    • breaking

      removed the enum value PM of the request property

    • breaking

      removed the enum value PN of the request property

    • breaking

      removed the enum value PR of the request property

    • breaking

      removed the enum value PS of the request property

    • breaking

      removed the enum value PT of the request property

    • breaking

      removed the enum value PW of the request property

    • breaking

      removed the enum value PY of the request property

    • breaking

      removed the enum value QA of the request property

    • breaking

      removed the enum value RE of the request property

    • breaking

      removed the enum value RO of the request property

    • breaking

      removed the enum value RS of the request property

    • breaking

      removed the enum value RU of the request property

    • breaking

      removed the enum value RW of the request property

    • breaking

      removed the enum value SA of the request property

    • breaking

      removed the enum value SB of the request property

    • breaking

      removed the enum value SC of the request property

    • breaking

      removed the enum value SD of the request property

    • breaking

      removed the enum value SE of the request property

    • breaking

      removed the enum value SG of the request property

    • breaking

      removed the enum value SH of the request property

    • breaking

      removed the enum value SI of the request property

    • breaking

      removed the enum value SJ of the request property

    • breaking

      removed the enum value SK of the request property

    • breaking

      removed the enum value SL of the request property

    • breaking

      removed the enum value SM of the request property

    • breaking

      removed the enum value SN of the request property

    • breaking

      removed the enum value SO of the request property

    • breaking

      removed the enum value SR of the request property

    • breaking

      removed the enum value SS of the request property

    • breaking

      removed the enum value ST of the request property

    • breaking

      removed the enum value SV of the request property

    • breaking

      removed the enum value SX of the request property

    • breaking

      removed the enum value SY of the request property

    • breaking

      removed the enum value SZ of the request property

    • breaking

      removed the enum value TC of the request property

    • breaking

      removed the enum value TD of the request property

    • breaking

      removed the enum value TF of the request property

    • breaking

      removed the enum value TG of the request property

    • breaking

      removed the enum value TH of the request property

    • breaking

      removed the enum value TJ of the request property

    • breaking

      removed the enum value TK of the request property

    • breaking

      removed the enum value TL of the request property

    • breaking

      removed the enum value TM of the request property

    • breaking

      removed the enum value TN of the request property

    • breaking

      removed the enum value TO of the request property

    • breaking

      removed the enum value TR of the request property

    • breaking

      removed the enum value TT of the request property

    • breaking

      removed the enum value TV of the request property

    • breaking

      removed the enum value TW of the request property

    • breaking

      removed the enum value TZ of the request property

    • breaking

      removed the enum value UA of the request property

    • breaking

      removed the enum value UG of the request property

    • breaking

      removed the enum value UM of the request property

    • breaking

      removed the enum value US of the request property

    • breaking

      removed the enum value UY of the request property

    • breaking

      removed the enum value UZ of the request property

    • breaking

      removed the enum value VA of the request property

    • breaking

      removed the enum value VC of the request property

    • breaking

      removed the enum value VE of the request property

    • breaking

      removed the enum value VG of the request property

    • breaking

      removed the enum value VI of the request property

    • breaking

      removed the enum value VN of the request property

    • breaking

      removed the enum value VU of the request property

    • breaking

      removed the enum value WF of the request property

    • breaking

      removed the enum value WS of the request property

    • breaking

      removed the enum value XK of the request property

    • breaking

      removed the enum value YE of the request property

    • breaking

      removed the enum value YT of the request property

    • breaking

      removed the enum value ZA of the request property

    • breaking

      removed the enum value ZM of the request property

    • breaking

      removed the enum value ZW of the request property

    • breaking

      removed the enum value ZZ_EU of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      response property items/address_submitted/city list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/country list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/county list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/full_address list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/postal_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/state list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/street_1 list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/address_submitted/street_2 list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/city list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/country list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/county list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/full_address list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/postal_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/state list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/street_1 list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property items/response_address/street_2 list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added subschema #2 to the request property anyOf list

    • 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.