MatchedAddressDto

  • address
    Type: object · AddressDto nullable

    Standardized address returned by the address validation service after normalization

    • city
      Type: string · City
      max length:  
      100
      nullable

      City name. Used for city-level tax rate lookup where applicable.

    • country
      Type: string · Country
      max length:  
      50
      nullable

      ISO 3166-1 alpha-2 country code (e.g., US, CA). Used to select the applicable tax engine.

    • county
      Type: string · County
      max length:  
      100
      nullable

      County or district name. Used for county-level tax rate lookup.

    • is_partial
      Type: boolean · Is Partial nullable

      Set to true if the address is intentionally incomplete (e.g., only country and state are known). Partial addresses may result in a broader jurisdiction match and less precise tax calculation.

    • state
      Type: string · State
      max length:  
      100
      nullable

      State or province abbreviation (e.g., CA, NY). Used to determine state-level tax rates and exemption jurisdiction matching.

    • street
      Type: string · Street
      max length:  
      200
      nullable

      Street number and name (e.g., 123 Main St). Required for full address validation.

    • zip
      Type: string · Zip
      max length:  
      20
      nullable

      Postal or ZIP code. Can be used to infer state if state is not provided.

  • address_corrected
    Type: boolean · Address Corrected nullable

    True if geocoded result differs from input

  • confidence
    Type: number · Confidence
    min:  
    0
    max:  
    1
    nullable

    Address match quality score returned by the geocoding service: 0 = no match, 1 = exact match. Low confidence may indicate an imprecise tax jurisdiction result.

  • latitude
    Type: number · Latitude nullable
  • longitude
    Type: number · Longitude nullable
  • low_confidence_warning
    Type: boolean · Low Confidence Warning nullable

    True if confidence is below 0.7

  • match_level
    Type: string · MatchLevelenum nullable

    Granularity of the geocode match

    values
    • street
    • city
    • zip
    • state
    • unmatched