How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GSMA Open Gateway Get Device Identifiers API

Retrieve details about the device being used by a mobile subscriber

GSMA Open Gateway Get Device Identifiers API is one of 34 APIs that GSMA Open Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Get Device Identifiers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 0.3.0.

Requests are made against a single base URL, {apiRoot}/device-identifier/v0.3.

3 operations 3 paths 15 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.3.0
Server
{apiRoot}/device-identifier/v0.3
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

GSMA Open Gateway Get Device Identifiers API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — Common security scheme for all CAMARA APIs

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Get Device Identifiers 3

Retrieve details about the device being used by a mobile subscriber

POST
/retrieve-identifier
Get details about the specific device being used by a given mobile subscriber
retrieveIdentifier 1 param body → 200400401403404422429
POST
/retrieve-type
Get details about the type of device being used by a given mobile subscriber
retrieveType 1 param body → 200400401403404422429
POST
/retrieve-ppid
Get a pseudonymous identifier for device being used by a given mobile subscriber
retrievePPID 1 param body → 200400401403404422429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Device (4 properties), ErrorInfo (3 properties), DeviceIpv4Addr (3 properties), DeviceType (3 properties). Each schema is shown below with its type and property counts.

XCorrelator
string
NetworkAccessIdentifier
string
A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Loc…
CommonResponseBody
object
Common parameters to be included in all responses
2 properties
RequestBody
object
Common request body to allow optional Device object to be passed
1 property
DeviceIpv4Addr
object
The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (o…
3 properties
ErrorInfo
object
3 properties 3 required
DevicePPID
object
The individual physical mobile device identifier, expressed as a PPID (Pairwise Pseudonymous Identifier)
1 property
DeviceIpv6Address
string
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to…
SingleIpv4Addr
string
A single IPv4 address with no subnet mask
DeviceIdentifier
object
The individual physical mobile device identifier, as expressed by the IMEI and IMEISV
2 properties
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
Port
integer
TCP or UDP port number
DeviceType
object
The physical device type, as expressed by Type Approval Code, manufacturer name and model name
3 properties
DeviceResponse
An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer incl…
Device
object
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide t…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-gateway-get-device-identifiers-api-openapi.yml Raw ↑

Other APIs GSMA Open Gateway publishes across the network.

GSMA Open Gateway Age Verification API
GSMA Open Gateway API Product API
GSMA Open Gateway API Product Order API
GSMA Open Gateway Application API
GSMA Open Gateway Application Owner API
GSMA Open Gateway Call Forwarding information retrieval API
GSMA Open Gateway Check Device Swap API
GSMA Open Gateway Check SIM swap API
GSMA Open Gateway Check Subscriber Tenure API
GSMA Open Gateway Connected Network Type API
GSMA Open Gateway Device reachability status API
GSMA Open Gateway Device reachability status subscription API
Where this information came from

This is an independent, third-party profile of GSMA Open Gateway Get Device Identifiers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.