Service Qualification

Version 1.0.2
download iconDownload spec

Endpoint

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

Allows external partners to verify whether a given service address and Postal code are eligible for fiber connectivity.

arrowRequest

Service Qualification request payload

Header Parameters

    Body Parameters

    Responses

    Service Qualification response

    arrowBody

    application/json

    REQUEST

    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
    curl --request POST \
         --url https://partner.att.com/omni-svcs/v1/service-qualification \
         --header 'accept: application/json' \
         --header 'content-type: application/json' \
         --data '
    {
      "channel": {
        "id": "IND",
        "name": "IND",
        "extensions": [
          {
            "name": "subChannel",
            "value": "bestbuy"
          },
          {
            "name": "subChannelGroup",
            "value": "National Retail"
          },
          {
            "name": "agentId",
            "value": "s12345"
          }
        ]
      },
      "geographicAddress": {
        "postcode": "91911",
        "city": "CHULA VISTA",
        "stateOrProvince": "CA",
        "addressCharacteristic": [
          {
            "name": "addressLine1",
            "valueType": "string",
            "value": "3802 EAST MAIN ST"
          }
        ]
      },
      "customerType": "CONSUMER",
      "offers": [
        {
          "productOfferingTypeGroup": "BBOffers",
          "billingAccountNumber": "123456789",
          "intent": "MOVE"
        }
      ]
    }
    '

    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
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    {
      "addressValidation": {
        "validationResult": "success",
        "validGeographicAddress": {
          "id": "00000NG3XH",
          "streetNr": "3802",
          "streetName": "MAIN",
          "streetType": "ST",
          "city": "CHULA VISTA",
          "stateOrProvince": "CA",
          "postcode": "91911",
          "postcodeExtension": "6246",
          "country": "USA",
          "completeTimeZone": "Pacific Time (PST/PDT)",
          "geographicSubAddress": [
            {
              "subUnitType": "APT",
              "subUnitNumber": "5"
            }
          ]
        }
      },
      "serviceCharacteristic": [
        {
          "name": "InstantHSIAOnIndicator",
          "valueType": "string",
          "value": "false"
        }
      ],
      "serviceQualification": [
        {
          "queryServiceQualificationDate": "2025-10-09T20:47:12.05Z",
          "serviceQualificationItem": [
            {
              "category": {
                "name": "INTERNET",
                "displayName": "Internet"
              },
              "service": {
                "category": "HSIA",
                "displayName": "AT&T Internet",
                "serviceType": "HSIA",
                "serviceCharacteristic": [
                  {
                    "name": "QualificationResult",
                    "valueType": "string",
                    "value": "qualified"
                  }
                ]
              }
            },
            {
              "category": {
                "name": "INTERNET",
                "displayName": "Internet"
              },
              "service": {
                "category": "FIBER",
                "displayName": "AT&T Fiber",
                "serviceType": "FIBER",
                "serviceCharacteristic": [
                  {
                    "name": "QualificationResult",
                    "valueType": "string",
                    "value": "qualified"
                  }
                ]
              }
            }
          ],
          "serviceInventory": [
            {
              "category": {
                "name": "INTERNET",
                "displayName": "Internet"
              },
              "service": {
                "category": "FIBER",
                "name": "FIBER",
                "serviceType": "FIBER",
                "available": true
              }
            },
            {
              "category": {
                "name": "INTERNET",
                "displayName": "Internet"
              },
              "service": {
                "category": "HSIA",
                "name": "HSIA",
                "serviceType": "HSIA",
                "available": true
              }
            }
          ]
        }
      ],
      "swimlaneList": [
        {
          "plan": "Hsia5000g",
          "swimlane": "29",
          "planTier": "F",
          "planMRCBillingOffer": "88541733",
          "BBFootPrint": "FiberKit",
          "PSid": "NA001"
        },
        {
          "plan": "Hsia2000g",
          "swimlane": "29",
          "planTier": "E",
          "planMRCBillingOffer": "88541733",
          "BBFootPrint": "FiberKit",
          "PSid": "NA001"
        },
        {
          "plan": "Hsia1000g",
          "swimlane": "29",
          "planTier": "D",
          "planMRCBillingOffer": "88541733",
          "BBFootPrint": "FiberKitOptional",
          "PSid": "NA001"
        },
        {
          "plan": "Hsia500g",
          "swimlane": "29",
          "planTier": "C",
          "planMRCBillingOffer": "88541733",
          "BBFootPrint": "FiberKitOptional",
          "PSid": "NA001"
        },
        {
          "plan": "Hsia300g",
          "swimlane": "29",
          "planTier": "B",
          "planMRCBillingOffer": "88541733",
          "BBFootPrint": "FiberKitOptional",
          "PSid": "NA001"
        },
        {
          "plan": "Hsia100g",
          "swimlane": "29",
          "planTier": "A",
          "planMRCBillingOffer": "88541733",
          "BBFootPrint": "FiberKitOptional",
          "PSid": "NA001"
        }
      ]
    }