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"
          }
        ]
      },
      "offers": [
        {
          "productOfferingTypeGroup": "BBOffers",
          "customerType": "CONSUMER",
          "billingAccountNumber": "123456789",
          "intent": "MOVE"
        }
      ]
    }
    '

    RESPONSE

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    {
      "addressValidation": {
        "validationResult": "success",
        "validGeographicAddress": {
          "id": "00011TAJVD",
          "streetNr": "4005",
          "streetName": "OHIO",
          "streetType": "DR",
          "city": "PLANO",
          "stateOrProvince": "TX",
          "postcode": "75093"
        }
      },
      "serviceQualification": [
        {}
      ]
    }