GSMA Open Gateway API Descriptions
Open Gateway northbound service APIs are defined within the CAMARA project
The APIs in the following table are mature: APIs which are stable or already part of two or more CAMARA Meta releases.
More details can be found on all APIs in the CAMARA API Overview page: https://camaraproject.org/api-overview
| Authentication and Fraud Prevention | Location Services | Communication Services | Communication Quality | Device Information | Computing Services | Payments and Charging |
| Call Forwarding Signal | Geofencing Subscriptions | WebRTC Call Handling | Application Profiles | Connected Network Type | Simple Edge Discovery | Blockchain Public Access |
| Customer Insights | Location Retrieval | WebRTC Event Handling | Connectivity Insights | Connected Network Type Subscriptions | Carrier Billing | |
| Device Swap | Location Verification | WebRTC Registration | Connectivity Insights Subscription | Device Identifier | Carrier Billing Refund | |
| Know Your Customer Age Verification | Population Density Data | QoS Profiles | Device Reachability Status | |||
| Know Your Customer Fill In | Regional Device Count | QoS Provisioning | Device Reachability Status Subscription | |||
| Know Your Customer Match | Quality on Demand | Device Roaming Status | ||||
| Know Your Customer Tenure | Device Roaming Status Subscription | |||||
| Number Recycling | ||||||
| Number Verification | ||||||
| One Time Password SMS | ||||||
| Scam Signal | ||||||
| SIM Swap | ||||||
| SIM Swap Subscription |
Authentication and Fraud Prevention
Call Forwarding Signal
API Description
Determine if a “call forwarding” service is enabled
https://camaraproject.org/call-forwarding-signal
Case Study
Customer Insights
API Description
Provides and index or scoring related to the user’s credit profile
Device Swap
API Description
Check if the MSISDN has had a change of device in the last 30 days
https://camaraproject.org/device-swap
Use Case
Know Your Customer Age Verification
API Description
Allows Service Providers to validate age information with operators
https://camaraproject.org/know-your-customer-age-verification
Use Case
Know Your Customer Fill-In
API Description
Fill in web dialogues using operator data
Know Your Customer Match
API Description
Allows Service Providers to validate user information with operators
https://camaraproject.org/know-your-customer-match
Case Study:
Know Your Customer Tenure
API Description
Verify the length of tenure for a mobile user who is bound to a mobile number with their current mobile operator
Number Recycling
API Description
Check whether the subscriber of the phone number has changed
https://camaraproject.org/number-recycling
Use Case
Number Verification
API Description
Allows users to verify the phone number of a connected device
https://camaraproject.org/number-verification
Case Study
One Time Password SMS
To offer secure user authentication to Service Providers
https://camaraproject.org/one-time-password-sms
Case Study:
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.
Case Study
SIM Swap
API Description
Allows user to get information on SIM pairing changes
https://camaraproject.org/sim-swap
Case Study
SIM Swap Subscription
Location Services
Geofencing Subscriptions
API Description
Get notifications if a device reaches and area
Location Retrieval
API Description
Provide the location of a device
https://camaraproject.org/location-retrieval
Case Study
Location Verification
API Description
Check the location of a device
https://camaraproject.org/location-verification
Case Study
Use Case
Population Density Data
API Description
Get dynamic population density data in a specific area for a future date & time
Region Device Count
API Description
Query the number of active devices in the specified area
https://camaraproject.org/region-user-count
Use Case
Communication Services
Web RTC Call Handling
API Description
Create, recover, update and terminate 1-1 voice and video sessions
Web RTC Event Subscription
API Description
Receive events about updates of an active session or new session requests (incoming calls)
Web RTC Registration
API Description
Manage registration and Connectivity (RACM) towards MNO’s IMS network
Communication Quality
Application Profiles
API Description
Share information about applications relevant for network related decision making
Connectivity Insights
API Description
Get information is the QoS threshold has breached
https://camaraproject.org/connectivity-insights
Case Study
Connectivity Insights Subscriptions
API Description
Alerts the consumer if and when the QoS threshold has breached
https://camaraproject.org/connectivity-insights-subscriptions/
QoS Profiles
API Description
Provide the ability to set certain profile of QoS
QoS Provisioning
API Description
Creating, getting, updating and removing a QoS provision for a device
Quality-On-Demand
API Description
Allow users to set mobile connection quality and get notofocations
https://camaraproject.org/quality-on-demand
Case Study
Device Information
Connected Network Type
API Description
Query the device’s connected network type
Connected Network Type Subscriptions
API Description
Receive notifications when the connected network type changes
https://camaraproject.org/connected-network-type-subscriptions/
Device Identifier
API Description
Check the identity of the subscribers device
Device Reachability Status
API Description
Check the network connection status of a device
Device Reachability Status Subscriptions
API Description
Get notifications if the connection status of a device changes
https://camaraproject.org/device-reachability-status-subscriptions/
Device Roaming Status
API Description
Check the roaming status of a device
Device Roaming Status Subscriptions
API Description
Get notifications if the roaming status of a device changes
https://camaraproject.org/device-roaming-status-subscriptions/
Computing Services
Simple Edge Discovery
API Description
Discover the closest edge cloud zone to a given network device
https://camaraproject.org/simple-edge-discovery
Use Case
Payments and Charging
Blockchain Public Address
API Description
Manage a blockchain public address associated to a phone number
Carrier Billing
API Description
Purchase, pay and follow up on fulfilment of products
https://camaraproject.org/carrier-billing
Case Study
Carrier Billing Refund
API Description
Perform a refund over a given payment