v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
AddressStandardization

Standardize and validate an address

Returns the standardized address together with a confidence tier (HIGH/MEDIUM/LOW), a validation status (VALID/PARTIAL/INVALID), and enrichment data (ZIP+4, county, lat/long, timezone). Pass-through to the DAL address cleanser.

post/addresses/standardize

Headers

tenant-idstring required

Request body

addressLine1string required

Primary street line

addressLine2string

Secondary street line (apt, suite, unit, floor)

citystring

City

countystring

County

statestring

State / province code

zipstring

ZIP / postal code (5 or 5+4, hyphen-separated)

countrystring

ISO country code

addressTypestring

Optional address type hint (e.g. billing, mailing, office, remit_to, service, irs)

Example request

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Suite 100",
  "city": "New York",
  "county": "New York County",
  "state": "NY",
  "zip": "10001",
  "country": "US",
  "addressType": "billing"
}

Response

Address standardized successfully

confidence'HIGH' | 'MEDIUM' | 'LOW'
validationStatus'VALID' | 'PARTIAL' | 'INVALID'

Example response

{
  "enrichment": {
    "zip4": "1234",
    "county": "New York County",
    "stateFips": "36",
    "countyFips": "36061"
  }
}
All 377 operations