Open Gateway Onboarding and Ordering Component Suite

REST API

Overview

API Ordering, Developer & Application Onboarding and Management This Operate API component suite covers the onboarding operations between Channel Partners and Operators as described in the GSMA Playbook. It offers a consolidation of multiple TMForum-based APIs into a single endpoint (a component suite). This API focusses on: Developer Management (acceptance, on boarding, lifecycle management) and Application Management (acceptance, on boarding, lifecycle management)


Version history

v5.2.1

08-May-2026 docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments where this previously required in‑house configuration. README files have been updated to document proxy usage. Failed HTML reports can now be opened directly in a browser, and HTML reports now include headers identifying the API and CTK version used, improving certification clarity and traceability.

21-Jan-2026 The CTK and RI have been re-released in a dockerized format, this may require different set up requirements and any automation platforms will need to be updated. Click here for more information.

19-Dec-2025 v5.2.1 stable release: OAS, User Guide, Conformance profile, CTK, VS, and Postman.Conformance Profile now includes an additional comment for the optional attribute approvedProductOfferingTermOrCondition.applicationLegalBasisForInputData, offering guidance on GDPR-related data processing.


v5.2.0

13-June-2025 v5.2.0 stable release: OAS, User Guide, Conformance profile, CTK, VS, and Postman updated with support for product bundles, new query parameters, and improved TMF936-aligned examples. Requires docker desktop for CTK+ VS(RI)


v5.1.2

08-May-2026 docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments where this previously required in‑house configuration. README files have been updated to document proxy usage. Failed HTML reports can now be opened directly in a browser, and HTML reports now include headers identifying the API and CTK version used, improving certification clarity and traceability.

22-Jan-2026 A compliance note for specific geographies was added; no changes were made beyond the conformance profile. Patch fix to Conformance profile

21-Jan-2026 The CTK and RI have been re-released in a dockerized format, this may require different set up requirements and any automation platforms will need to be updated. Click here for more information.

03-June-2025 v5.1.2 stable release: CTK: Bugfix on the HTML report to access from run directory of CTK.

v5.1.2

28-Feb-2025 v5.1.2 stable release: CTK, RI and Postman collection.

v5.1.2

06-Feb-2025 v5.1.2 stable release: fixes some inconsistencies, mainly on examples.

v5.1.1

02-Dec-2024 v5.1.1 preview release: Conformance profile: minor bug fixes released.

22-Nov-2024 v5.1.1 preview release: Conformance profile and User Guide: minor bug fixes released.

01-Nov-2024 v5.1.1 preview release: OAS v5.1.1 The 5.1 brings new requirements from GSMA to allow more use cases regarding legislations constraints including last stable version of W3C DPV values to fulfill GDPR requirements. There are also some improvements on modelling and descriptions. All changes are detailed in "Acknowledgements" chapter of the User Guide.

01-Aug-2024 v5.1.0 preview release: The 5.1 brings new requirements from GSMA to allow more use cases regarding legislations constraints. There are also some improvements on modelling and descriptions. All changes are detailled in "Acknowledgements" chapter of the User Guide.


v5.0.0

16 Sept 2024 v5.0.0 stable release: fix for Postman Collection has bad indentation.

21 Feb 2024 v5.0.0 stable release.


This API is an Open Gateway Operate API, produced within the GSMA Open Gateway initiative.

API No.

TMF931

Stable version

v5.2

This Version

v5.1

Types

RESTful

DOMAIN

Common

IPR MODE

Apache 2.0 unless stated

Release Date

08 May 2026

API assets v5.1

Swagger

OPEN API SPECIFICATION

Postman collection

Postman collection

API user guide / specification

API USER GUIDE (RAND)

Sample implementation codeNew

Sample implementation code

CTKNew

CTK

Conformance profile

Conformance Profile (RAND)