Address Validation
Version 1.0.2
Endpoint
POST
https://partner.att.com/omni-svcs/v1/address/validate
Copy
The Validate Address endpoint offers real-time verification and normalization of customer postal addresses. It ensures that address data conforms to AT&T’s internal standards and third-party reference (e.g. USPS) before downstream use in ordering, service eligibility checks, billing, or fulfillment. Address Supported are PPU, Billing, Shipping. Key Benefits: 1. Reduces delivery failures and billing errors by catching bad addresses early. 2. Streamlines customer onboarding flows for Apple, SaraPlus, and other national retail partners. 3. Supports AT&T’s MVPD and broadband services with a single, standards-based interface.
Header Parameters
- appnamestringApplication name making the request
Body Parameters
- objectStructured textual way of describing how to find a property in an urban area (country properties are often defined differently)
- addressLine1stringFirst line of the address including street number, street name, and street type
- addressLine2stringSecond line of the address for apartment, suite, unit, or building information
- addressTypestringRequiredType of address validation required. Valid values are Billing, Shipping, or PPU (Point of Presence). Allows multiple values separated by comma
- productCategorystringProduct category for address validation (e.g., WSS for wireless, WBB for wireline broadband, Fiber)
- citystringCity that the address is in
- zipCodestringDescriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as ZIP code)
- stateOrProvincestringThe state or province that the address is in
Responses
Address validation response
Body
application/json
- objectRequiredThis resource is used to manage address validation response
- validationResultstringResult of the address validation. Possible values: success (exact match found), closematch (multiple matches found), closematch-mdu (Multiple Dwelling Unit address requiring unit information), nomatch (no match found), fails (validation failed)
- validationResultCodestringAddress match code indicating the quality and type of match
- validationResultDescriptionstringDetailed description for the validation result code
- validGeographicAddressobjectGeographic address details populated when address is valid and an exact match is identified
- alternateGeographicAddressarray of objects
List of alternate addresses when multiple matches are found or for Multiple Dwelling Units (MDU) requiring additional selection
Alternate geographic address when multiple matches are found or for Multiple Dwelling Units - validationTypeRecommendationarray of objects
Recommended actions for each address validation type based on the validation results