AT&T DevEx

Omni APIs Central | Wireless Solutions | Add a Line | Digital PoS

Version 1.0.0 (latest)

Perform Address Validation

Version 1.0.0
download iconDownload spec

Endpoint

POST
https://partner.att.com/omni-svcs/v1/address

Address Supported are PPU, Billing, Shipping

arrowRequest

Body Parameters

Responses

Return Address Validation Response

arrowBody

application/json

REQUEST

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
     --url https://partner.att.com/omni-svcs/v1/address \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "geographicAddress": {
    "addressLine1": "23114 38th Ave SE",
    "addressLine2": "APT 123",
    "addressType": "Shipping, Billing",
    "city": "CHOLA VISTA",
    "postalcode": "98021",
    "stateOrProvince": "WA"
  }
}
'

RESPONSE

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
{
  "validationResult": "success",
  "validationResultCode": "4S80",
  "validGeographicAddress": {
    "id": "00000NG3XH",
    "streetNr": "3802",
    "streetName": "MAIN",
    "streetType": "ST",
    "city": "CHULA VISTA",
    "stateOrProvince": "CA",
    "postcode": "91911",
    "postcodeExtension": "6247",
    "streetSuffix": "SE",
    "geographicSubAddress": [
      {
        "subUnitType": "STE",
        "subUnitNumber": "5",
        "subAddressType": "H"
      }
    ],
    "addressCharacteristic": [
      {
        "name": "addressLine1",
        "value": "3802 MAIN ST STE 5"
      },
      {
        "name": "cityAbbreviatedName",
        "value": "CHULA VISTA"
      },
      {
        "name": "cassAddressLine1",
        "value": "2400 BRIARWEST BLVD"
      },
      {
        "name": "cassAddressLine2",
        "value": "HOUSTON TX  77077-7601"
      },
      {
        "name": "county",
        "value": "COOK"
      },
      {
        "name": "urbanizationCode",
        "value": "URB SUMMIT HLS"
      },
      {
        "name": "addressMatchCode",
        "value": "3SUU"
      },
      {
        "name": "addressMatchCodeDescription",
        "value": "Unit information is not recognized by the U.S. Postal Service.  Mail may not be delivered"
      },
      {
        "name": "addressMatchCodeStatus",
        "value": "S80000"
      },
      {
        "name": "deliveryPointValidationCode",
        "value": "S"
      },
      {
        "name": "lacsCode",
        "value": "F"
      },
      {
        "name": "deliveryPointValidationFootnote",
        "value": "AABBCC"
      },
      {
        "name": "taxationGeocode",
        "value": "0144339144000"
      },
      {
        "name": "latitude",
        "value": "29.738805"
      },
      {
        "name": "longitude",
        "value": "-95.61404"
      }
    ]
  },
  "validationTypeRecommendation": [
    {
      "validationType": "BILLING",
      "validationRecommendation": "ACCEPT"
    },
    {
      "validationType": "SHIPPING",
      "validationRecommendation": "ACCEPT"
    }
  ]
}