sim-swap

SIM Swap (0.4.0)

SIM Swap API provides the customer the ability to obtain information on any recent SIM pairing change related to the User's mobile account.

This API derives from the GSMA Mobile Connect Account Takeover Protection specification Mobile Connect Account Takeover Protection. For more about Mobile Connect, please see about Mobile Connect.

The API provides 2 operations:

POST retrieve-date : Provides timestamp of latest SIM swap
POST check: Checks if SIM swap has been performed during a past period (defined in the request with 'maxAge' attribute).

Product documentation at Camara

Download OpenAPI description

sim_swap.json

sim_swap.yaml

Overview

E-mail awsgsma@u.com.my

License Apache 2.0

Servers

Mock server

https://developers.opgw.u.com.my/_mock/sim-swap/sim_swap/

Sandbox server (uses test data)

https://api-sandbox.opgw.u.com.my/sim-swap-service/sim-swap/v0/

Retrieve SIM swap date

Operations

Check SIM swap

Operations

checkSimSwap

Request

Check if SIM swap has been performed during a past period

Bodyapplication/jsonrequired

Create a check SIM swap request for a MSISDN identifier.

phoneNumberstring(PhoneNumber)^\+?[0-9]{5,15}$required

Subscriber number in E.164 format (starting with country code). Optionally prefixed with '+'.

Example: "+60182222111"

maxAgeinteger(int32)[ 1 .. 2400 ]

Period in hours to be checked for SIM swap.

Default 240

Example: 240

curl -i -X POST \
  https://developers.opgw.u.com.my/_mock/sim-swap/sim_swap/check \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumber": "+60182222111",
    "maxAge": 240
  }'

Responses

Returns whether a SIM swap has been performed during a past period

Bodyapplication/json

swappedboolean

Indicates whether the SIM card has been swapped during the period within the provided age.

Response

application/json

{
  "swapped": true
}