SPS - Subscription SIM Management (v5)

Download OpenAPI specification:Download

The "Subscription SIM Management API" provides the ability to validate SIM and query SIM details of a subscription.

Operations

Provides the ability to validate a SIM prior to activation

This API provides the ability to validate SIM/SIM Check for activation

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Ways to invoke API:

SIM Check or Validate SIM using iccid: /simCheck?iccid=11986621644523024501

query Parameters

iccid

required

string (iccid) [ 19 .. 20 ] characters ^[0-9]{19,20}$

Example: iccid=11986621644523024501

ICCID or SIM Number

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TEST20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) 12 characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json

Example
Valid SIM
Valid SIM
Invalid SIM

{"validationStatus": true }

Provides the ability to get SIM details for the given subscription

This API provides the ability to get SIM details for the given subscription

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

Ways to invoke API:

Get SIM details using iccid: /simDetails?iccid=11986621644523024501

Get SIM details using gpsi: /simDetails?gpsi=13035551111

query Parameters

iccid	string (iccid) [ 19 .. 20 ] characters ^[0-9]{19,20}$ Example: iccid=11986621644523024501 ICCID or SIM Number
gpsi	string (gpsi) [ 11 .. 15 ] characters ^[0-9]{11,15}$ Example: gpsi=13035551111 GPSI or Phone Number

header Parameters

X-Correlation-Id	string <uuid> (CorrelationId) Example: TEST20210903155950999 Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes
wholesaleCustomerId	string (CustomerId) 12 characters ^.*$ Example: 100000108464 Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json

{"simStatus": "Active", "blockState": "false", "gpsi": "13035551111", "supi": "1234567890", "iccid": "11986621644523024501", "subscriberId": "SUB3742259805" }