GSMA Open Gateway API Descriptions
Open Gateway northbound service APIs are defined within the CAMARA project
The APIs in the following table are mature, meaning:
- APIs which are stable and already part of or targeted to be part of a CAMARA meta release
or - APIs which are implemented in at least one operator network
or - APIs included within any initial public API version
All APIs can be found in the CAMARA API Overview page: https://camaraproject.org/api-overview
Authentication and Fraud Prevention
Call Forwarding Signal
API Description
Determine if a “call forwarding” service is enabled
Know Your Customer Fill-in
Know Your Customer Match
API Description
Allows service providers to validate user information with operators
Number Verification
API Description
Allows users to verify the phone number of the connected device
One time password SMS
Scam Signal
API Description
The “Scam Signal” API allows businesses to protect their customers from impersonation scams, particularly Authorized Pushed Payment (APP) fraud.
APP fraud involves a criminal tricking someone into sending them money, often through impersonating representatives from banks, government departments, or even a family member. They can also deceive a victim into making advance payments for fraudulent investments, counterfeit goods and services, or even extort money through a seemingly genuine romance or friendship.
The Scam Signal API is not available on CAMARA. It was developed in accordance with CAMARA standards and within the framework of GSMA OPAG. To maintain the effectiveness of the API, it is stored in a private GSMA repository. Access to this repository is strictly controlled by GSMA, and any requests for access should be directed to the appropriate GSMA contact.
SIM Swap Subscription
Location Services
Geofencing Subscriptions
Location Retrieval
Location Verification
Population Density Data
API Description
Get dynamic population density data in a specific area for a future date & time
Communication Services
Communication Quality
Application Profiles
API Description
Share information about applications relevant for network related decision making
Connectivity Insights
Connectivity Insights Subscriptions
API Description
Alerts the consumers if and when the QoS threshold has breached
Home Devices QoD
API Description
Request prioritisation of traffic on a specific device on the home network
QoD Provisioning
QoS Profiles
Quality-On-Demand
API Description
Allows users to set mobile connection quality and get notifications
Session Insights
API Description
Receive sessions insights score, receive root cause analysis, request service improvements
Device Information
Device Reachability Status
Device Reachability Status Subscription
API Description
Get notifications if the network connection status of a device changes
Device Roaming Status
Device Roaming Status Subscription
API Description
Get notifications if the roaming status of a device changes
Computing Services
Simple Edge Discovery
Payments and Charging
Carrier Billing
Carrier Billing Refunds