README.md

SimSwap

Incubating API Repository to evolve and maintain the definitions and documentation of SimSwap Service APIs within the Sub Project Number Insights

• API Repository wiki page

Scope

• Service APIs for “SimSwap” (see APIBacklog.md)
• The APIs provide the API consumer with the ability to:
  • obtain information on any recent SIM pairing change related to the User’s mobile account.
• Describe, develop, document and test the APIs (with 1-2 Telcos)
• Started: October 2022
• Incubating stage since: February 2025

Status and released versions

• Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release.

• NEW: Public release r3.2 features the following APIs:

  • version 2.1.0 of the API sim-swap - available here
    • API definitions with inline documentation:
      • OpenAPI YAML
      • View it on ReDoc
      • View it on Swagger Editor
  • version 0.3.0 of the API sim-swap-subscriptions - available here
    • API definitions with inline documentation:
      • OpenAPI YAML
      • View it on ReDoc
      • View it on Swagger Editor

• Previous Public release r2.2 features the following APIs:

  • version 2.0.0 of the API sim-swap - available here
    • API definitions with inline documentation:
      • OpenAPI YAML
      • View it on ReDoc
      • View it on Swagger Editor
  • version 0.2.0 of the API sim-swap-subscriptions - available here
    • API definitions with inline documentation:
      • OpenAPI YAML
      • View it on ReDoc
      • View it on Swagger Editor

• The latest public release is available here: https://github.com/camaraproject/SimSwap/releases/latest

• Other releases of this sub project are available in https://github.com/camaraproject/SimSwap/releases

• For changes see CHANGELOG.md

Contributing

• Meetings are held virtually
  • Schedule: Every 4 weeks, Thursday, 7:30 AM UTC (8:30 CET/9:30 CEST)
  • Registration / Join
  • Minutes: Access meeting minutes
• Mailing List:
  • Subscribe / Unsubscribe to the mailing list https://lists.camaraproject.org/g/sp-number-insights.
  • A message to the community of this Sub Project can be sent using sp-number-insights@lists.camaraproject.org.