masstack

V0
V1
V2
API Overview Resources Schemas

Sim Swap

API operation of Sim Swap API.

Parameters

Name In Type Required Description
org_id path string true ‘none’
body body SimSwapCreateSimSwapDate true Create a SIM swap date request for a phone number.

Request body - instance of SimSwapCreateSimSwapDate

1
2
3

{
  "phoneNumber": "+346661113334"
}
Name Type Required Description
phoneNumber SimSwapPhoneNumber true A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ‘+’.

Request example

1
2
3
4
5
6
7
8


curl -X POST https://opengateway.masstack.com/v1/orgs/{org_id}/sim-swap/retrieve-date \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '+346661113334'
}"

Responses

Code Meaning Description Schema
200 OK Contains information about SIM swap change SimSwapSimSwapInfo
400 Bad Request Bad Request SimSwapApiError
401 Unauthorized Unauthorized SimSwapApiError
403 Forbidden Forbidden SimSwapApiError
404 Not Found Not found SimSwapApiError
422 Unprocessable Entity Unprocessable Content SimSwapApiError
500 Internal Server Error Internal Server Error SimSwapApiError
503 Service Unavailable Service Unavailable SimSwapApiError
504 Gateway Time-out Gateway Timeout SimSwapApiError

Parameters

Name In Type Required Description
org_id path string true ‘none’
body body SimSwapCreateCheckSimSwap true Create a check SIM swap request for a phone number.

Request body - instance of SimSwapCreateCheckSimSwap

1
2
3
4

{
  "phoneNumber": "+346661113334",
  "maxAge": 240
}
Name Type Required Description
phoneNumber SimSwapPhoneNumber true A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ‘+’.
maxAge integer(int32) false Period in hours to be checked for SIM swap.

Request example

1
2
3
4
5
6
7
8
9


curl -X POST https://opengateway.masstack.com/v1/orgs/{org_id}/sim-swap/check \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '+346661113334',
  'maxAge': 240
}"

Responses

Code Meaning Description Schema
200 OK Returns whether a SIM swap has been performed during a past period SimSwapCheckSimSwapInfo
400 Bad Request Bad Request SimSwapApiError
401 Unauthorized Unauthorized SimSwapApiError
403 Forbidden Forbidden SimSwapApiError
404 Not Found Not found SimSwapApiError
422 Unprocessable Entity Unprocessable Content SimSwapApiError
500 Internal Server Error Internal Server Error SimSwapApiError
503 Service Unavailable Service Unavailable SimSwapApiError
504 Gateway Time-out Gateway Timeout SimSwapApiError

Endpoints

Consents

    Number Verification

      Sim Swap

        Capabilities

          Views

            Admin

              QoSProfiles

                Applications