Skip to main content

Sim Swap API

API docs by Redocly

SIM Swap (0.4.0)

Download OpenAPI specification:Download

E-mail: contact@spryfoxnetworks.com License: Apache 2.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

Retrieve SIM swap date

retrieveSimSwapDate

Get timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.

Authorizations:
three_legged
Request Body schema: application/json
required

Create a SIM swap date request for a MSISDN identifier.

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

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

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "+346661113334"
}

Response samples

Content type
application/json
{
  • "latestSimChange": "2019-08-24T14:15:22Z"
}

Check SIM swap

checkSimSwap

Check if SIM swap has been performed during a past period

Authorizations:
three_legged
Request Body schema: application/json
required

Create a check SIM swap request for a MSISDN identifier.

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

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

maxAge
integer <int32> [ 1 .. 2400 ]
Default: 240

Period in hours to be checked for SIM swap.

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "+346661113334",
  • "maxAge": 240
}

Response samples

Content type
application/json
{
  • "swapped": true
}