AT&T · JSON Structure

Sim Swap Api Sim Swap Check Request Structure

SimSwapCheckRequest schema

Type: object Properties: 2 Required: 1
5GBroadbandCAMARAConnectivityDevice StatusEdge ComputingEnterpriseFortune 100MessagingMobileNetworkNetwork APIsSIM SwapSpeechTelecommunicationsWirelessWireline

SimSwapCheckRequest is a JSON Structure definition published by AT&T, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

phoneNumber maxAge

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/att/refs/heads/main/json-structure/sim-swap-api-sim-swap-check-request-structure.json",
  "description": "SimSwapCheckRequest schema",
  "type": "object",
  "required": [
    "phoneNumber"
  ],
  "properties": {
    "phoneNumber": {
      "type": "string",
      "description": "Mobile phone number in E.164 format associated with the SIM to check.",
      "example": "+12125551234"
    },
    "maxAge": {
      "type": "int32",
      "description": "Maximum age in hours to check for a SIM swap. If not provided, the default lookback period is used.",
      "minimum": 1,
      "maximum": 2400,
      "example": 240
    }
  },
  "name": "SimSwapCheckRequest"
}