AT&T MVNX API

Inquire Port Eligibility By Subscriber Number

Version 1.0.0
download iconDownload spec
View Use Cases

Endpoint

POST
https://lgw.att.com/InquirePortEligibilityBySubscriberNumber

Determines whether an existing subscriber is eligible to port in their current subscriber number from another service provider.

arrowRequest

Body Parameters

Responses

success

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
47
48
49
50
51
52
53
54
55
56
57
curl --request POST \
     --url https://lgw.att.com/InquirePortEligibilityBySubscriberNumber \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "string",
      "messageId": "string",
      "returnURL": "string",
      "responseTo": "string",
      "timeToLive": 0,
      "originatorId": "string",
      "dateTimeStamp": "2025-07-01T13:56:07.846Z",
      "conversationId": "string",
      "applicationName": "string",
      "originalVersion": "string",
      "uniqueTransactionId": "string",
      "infrastructureVersion": "string",
      "originalInfrastructureVersion": "string"
    },
    "SecurityMessageHeader": {
      "userName": "string",
      "userPassword": "string"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "string",
      "totalInSequence": "string"
    }
  },
  "InquirePortEligibilityBySubscriberNumberRequest": {
    "dealer": {
      "code": "string",
      "secondaryCode": "string"
    },
    "PortEligibility": [
      {
        "equipmentType": "C",
        "subscriberNumber": "string"
      }
    ],
    "marketServiceInfo": {
      "productType": "C",
      "billingMarket": {
        "localMarket": "string",
        "billingMarket": "string",
        "billingSubMarket": "string"
      },
      "serviceZipCode": "string",
      "billingSystemId": "string"
    },
    "portInDestination": "string",
    "relaxedMarketCoverageIndicator": false
  }
}
'

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
{
  "MessageHeader": {
    "TrackingMessageHeader": {
      "version": "string",
      "messageId": "string",
      "returnURL": "string",
      "responseTo": "string",
      "timeToLive": 0,
      "originatorId": "string",
      "dateTimeStamp": "2025-07-01T13:56:07.830Z",
      "conversationId": "string",
      "applicationName": "string",
      "originalVersion": "string",
      "uniqueTransactionId": "string",
      "infrastructureVersion": "string",
      "routingRegionOverride": [
        {}
      ],
      "originalInfrastructureVersion": "string"
    },
    "SecurityMessageHeader": {
      "userName": "string",
      "userPassword": "string"
    },
    "SequenceMessageHeader": {
      "sequenceNumber": "string",
      "totalInSequence": "string"
    }
  },
  "InquirePortEligibilityResponse": {
    "Response": {
      "code": "string",
      "description": "string"
    },
    "PortEligibilityResponse": [
      {
        "reasonCode": "string",
        "serviceArea": [
          {}
        ],
        "equipmentType": "C",
        "eligibilityFlag": false,
        "subscriberNumber": "string",
        "reasonDescription": "string",
        "OldServiceProvider": {
          "localId": "string",
          "networkId": "string",
          "resellerName": "string"
        },
        "NewServiceProvider": {
          "localId": "string",
          "networkId": "string",
          "resellerName": "string"
        }
      }
    ]
  }
}