Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AT&T SIM Swap API

SIM card change detection for fraud prevention

AT&T SIM Swap API is one of 12 APIs that AT&T publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SIM Swap. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://devex-web.att.com.

2 operations 2 paths 5 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.att.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

AT&T SIM Swap API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

SIM Swap 2

SIM card change detection for fraud prevention

POST
/sim-swap/v1/check
Check AT&T SIM Swap Status
checkSimSwap body → 200400403
POST
/sim-swap/v1/retrieve-date
Retrieve AT&T SIM Swap Date
retrieveSimSwapDate body → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (3 properties), SimSwapCheckRequest (2 properties), SimSwapDateResponse (1 property), SimSwapDateRequest (1 property). Each schema is shown below with its type and property counts.

SimSwapCheckResponse
object
1 property
SimSwapDateRequest
object
1 property 1 required
SimSwapDateResponse
object
1 property
ErrorResponse
object
3 properties
SimSwapCheckRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atandt-sim-swap-api-openapi.yml Raw ↑

Other APIs AT&T publishes across the network.

AT&T MVNO APIs
AT&T Cloud Voice APIs
AT&T eBonding APIs
AT&T Device Status API
AT&T Network Insights API
AT&T Number Verification API
AT&T Order Management API
AT&T Product Ordering API
AT&T Quality on Demand API
AT&T Service Qualification API
AT&T Threat Detection API