All updates
Non-Breaking

Physical SIM Activation and PIN/PUK Retrieval APIs

·By eliasramos

New Physical SIM Activation Support

Connect API now supports physical SIM (pSIM) activation journeys using activation codes and SIM Profile reservations.

Partners can now:

  • Reserve a Physical SIM Profile using an activation code
  • Activate subscriptions using a reservation_id
  • Retrieve Physical SIM Profile details
  • Retrieve Physical SIM and PUK information through dedicated APIs

This extends the existing activation order flow to support physical SIM onboarding.


Physical SIM Activation Flow

The Physical SIM activation journey now follows this flow:

  1. Partner creates a Physical SIM Profile reservation using the activation code printed on the physical SIM package
  2. API returns the reserved Physical SIM Profile information and a reservation_id
  3. Partner creates an activation order using sim_type = "psim" and the returned reservation_id
  4. Partner may later retrieve Physical SIM Profile details and PIN/PUK information when needed

Key Capabilities

Physical SIM Profile Reservation

A new Physical SIM Profile reservation endpoint allows partners to start the Physical SIM activation journey using an activation code.

POST /sim-profiles/reserve

The reservation response includes:

  • Physical SIM Profile details
  • reservation_id
  • Reservation expiration timestamp

Physical SIM Activation Orders

Activation orders now support Physical SIM activation using a reservation reference.

{
  "type": "activate_subscription",
  "subscriber_id": "subr_01HXF4F4VYTCPVMBPBK3T52TN7",
  "purchase_location": "CA",
  "sim_profile": {
    "sim_type": "psim",
    "reservation_id": "resv_01HV3KWPNRCT870WV3XG41CAT3"
  },
  "products": {
    "plan": {
      "product_offering_id": "prdoff_01HRD00B0K1EPRZ9WEVGEMUIJ6E"
    }
  }
}

When sim_type = "psim", reservation_id becomes mandatory.


Physical SIM Profile Retrieval

Partners can retrieve Physical SIM Profile details using:

GET /sim-profiles/{sim-id}

For Physical SIM profiles, the response includes reservation-related information and SIM status details.


PIN/PUK Retrieval

Partners can retrieve the original PIN and PUK associated with a Physical SIM Profile using:

GET /sim-profiles/{sim-id}/secret-codes

This supports customer service and SIM recovery journeys.


Summary of Changes

CapabilityChangeEndpoint / Contract
Physical SIM Profile reservation+ AddedPOST /sim-profiles/reserve
Physical SIM activation order+ ExtendedPOST /orders with sim_type = psim and reservation_id
Physical SIM Profile retrieval+ AddedGET /sim-profiles/{sim-id}
PIN/PUK retrieval+ AddedGET /sim-profiles/{sim-id}/secret-codes