masstack

V1
API Overview Resources Schemas

Device Swap

API operation related with device swap.

Parameters

Name In Type Required Description
body body CreateDeviceSwapDate true Create a device swap date request for a phone number.

Request body - instance of CreateDeviceSwapDate

1
2
3

{
  "phoneNumber": "+346661113334"
}
Name Type Required Description
phoneNumber PhoneNumber false 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 /device-swap/v0/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 Device swap change DeviceSwapInfo
400 Bad Request Problem with the client request ErrorInfo
401 Unauthorized Unauthorized ErrorInfo
403 Forbidden Forbidden ErrorInfo
404 Not Found Not found ErrorInfo
422 Unprocessable Entity Unprocessable Content ErrorInfo
500 Internal Server Error Server error ErrorInfo
503 Service Unavailable Service unavailable. Typically the server is down. ErrorInfo
504 Gateway Time-out Request time exceeded. If it happens repeatedly, consider reducing the request complexity ErrorInfo

Parameters

Name In Type Required Description
body body CreateCheckDeviceSwap true Create a check device swap request for a phone number.

Request body - instance of CreateCheckDeviceSwap

1
2
3
4

{
  "phoneNumber": "+346661113334",
  "maxAge": 240
}
Name Type Required Description
phoneNumber PhoneNumber 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) true Period in hours to be checked for device swap.

Request example

1
2
3
4
5
6
7
8
9


curl -X POST /device-swap/v0/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 device swap has been performed during a past period CheckDeviceSwapInfo
400 Bad Request Bad Request

In addition to regular scenario of INVALID_ARGUMENT, other scenarios may exist:

Endpoints

API Manager

    Device Swap

      KYC Match