Network as Code Network Intelligence APIs
The network-analytics product family. Advertised capabilities are Congestion Insights, Network Aware Route Optimization, Population Density Data and Consent and Identity Management. Only two are callable in the harvested specification — /congestion-insights/v0/query and /congestion-insights/v0/subscriptions, and consent via /passthrough/camara/v1/consent-info/consent-info/v0.1/retrieve. No population-density or route-optimization path exists in the harvested specification, so those two are marketed capabilities without a published contract.
Network as Code Network Intelligence APIs is one of 7 APIs that Nokia Network as Code publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Network Intelligence, Congestion, and Consent. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes 78 operations across 58 paths, organized into 29 resource areas, and defines 588 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://network-as-code.p-eu.rapidapi.com.
78 operations
58 paths
588 schemas
11 DELETE27 GET40 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Network as Code Network Intelligence APIs declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-rapidapi-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Your RapidAPI key
Paths & Operations 78
Across 58 paths, the API surfaces 78 operations — 11 DELETE, 27 GET, 40 POST. They span 29 resource areas, including Quality-of-Service on Demand v1.0.0, Device Roaming Status Subscriptions v0.8, NaC Authorization Server, Device Status v0.5.1, Device Reachability Status Subscriptions v0.7, Number Verification v1.0.0, KYC Tenure v0.1, Well Known Metadata, and 21 more. Each is listed below with its method, path, parameters, and response codes.
Quality-of-Service on Demand v1.0.0 5
POST
/quality-on-demand/v1/retrieve-sessions
Retrieve sessions for a specific device
DELETE
/quality-on-demand/v1/sessions/{sessionId}
Delete a QoS session
GET
/quality-on-demand/v1/sessions/{sessionId}
Get QoS session information
POST
/quality-on-demand/v1/sessions
Creates a new session
POST
/quality-on-demand/v1/sessions/{sessionId}/extend
Extend the duration of an active session
Device Roaming Status Subscriptions v0.8 4
GET
/device-status/device-roaming-status-subscriptions/v0.8/subscriptions/{subscriptionId}
Retrieve a roaming status event subscription for a device
DELETE
/device-status/device-roaming-status-subscriptions/v0.8/subscriptions/{subscriptionId}
Delete a device-roaming-status event subscription for a device
GET
/device-status/device-roaming-status-subscriptions/v0.8/subscriptions
Retrieve a list of device roaming status event subscription
POST
/device-status/device-roaming-status-subscriptions/v0.8/subscriptions
Create a device roaming status event subscription for a device
NaC Authorization Server 2
GET
/oauth2/v1/apps/{nac_app_ref}/.well-known/jwks.json
Get JWKS for an app.
GET
/oauth2/v1/auth/clientcredentials
Endpoint for getting client credentials to user
Device Status v0.5.1 6
POST
/device-status/v0/connectivity
Get the current connectivity status information
POST
/device-status/v0/subscriptions
Create a device status event subscription for a device
GET
/device-status/v0/subscriptions
Retrieve a list of device status event subscription
POST
/device-status/v0/roaming
Get the current roaming status and the country information
GET
/device-status/v0/subscriptions/{subscriptionId}
Retrieve a device status event subscription for a device
DELETE
/device-status/v0/subscriptions/{subscriptionId}
Delete a device status event subscription for a device
Device Reachability Status Subscriptions v0.7 4
DELETE
/device-status/device-reachability-status-subscriptions/v0.7/subscriptions/{subscriptionId}
Delete a device reachability status event subscription for a device
GET
/device-status/device-reachability-status-subscriptions/v0.7/subscriptions/{subscriptionId}
Retrieve a device reachability status event subscription for a device
GET
/device-status/device-reachability-status-subscriptions/v0.7/subscriptions
Retrieve a list of device reachability status event subscription
POST
/device-status/device-reachability-status-subscriptions/v0.7/subscriptions
Create a device reachability status event subscription for a device
Number Verification v1.0.0 2
POST
/passthrough/camara/v1/number-verification/number-verification/v0/verify
Verifies if the received hashed/plain text phone number matches the phone number associated with the access token
GET
/passthrough/camara/v1/number-verification/number-verification/v0/device-phone-number
Returns the phone number associated with the access token
KYC Tenure v0.1 1
POST
/passthrough/camara/v1/kyc-tenure/kyc-tenure/v0.1/check-tenure
The KYC Tenure service API
Well Known Metadata 3
GET
/.well-known/openid-configuration
Get Well Known Oidc
GET
/.well-known/security.txt
Get Security Txt
GET
/.well-known/oauth-authorization-server
Get Well Known Oauth
SIM Swap v1.0.0 2
POST
/passthrough/camara/v1/sim-swap/sim-swap/v0/check
Check if SIM swap has been performed during a past period
POST
/passthrough/camara/v1/sim-swap/sim-swap/v0/retrieve-date
Get timestamp of last SIM swap event for a mobile user account provided with phone number.
Slice Device Attach v1.0.0 5
POST
/device-attach/v0/attachments
Attach device to an existing or preconfigured slice.
GET
/device-attach/v0/attachments
Retrieve the given device attach resources associated with the owner.
POST
/device-attach/v0/attachments/subscribers/{operation}
Create subscriber in a given slice.
GET
/device-attach/v0/attachments/{resource_id}
Retrieve the given device attach resource.
DELETE
/device-attach/v0/attachments/{resource_id}
Detach device from given slice.
Device Roaming Status Subscriptions v0.7 4
GET
/device-status/device-roaming-status-subscriptions/v0.7/subscriptions
Retrieve a list of device roaming status event subscription
POST
/device-status/device-roaming-status-subscriptions/v0.7/subscriptions
Create a device roaming status event subscription for a device
DELETE
/device-status/device-roaming-status-subscriptions/v0.7/subscriptions/{subscriptionId}
Delete a device-roaming-status event subscription for a device
GET
/device-status/device-roaming-status-subscriptions/v0.7/subscriptions/{subscriptionId}
Retrieve a roaming status event subscription for a device
Number Verification v2.1 2
POST
/passthrough/camara/v1/number-verification/number-verification/v2/verify
Verifies if the received hashed/plain text phone number matches the phone number associated with the access token
GET
/passthrough/camara/v1/number-verification/number-verification/v2/device-phone-number
Returns the phone number associated with the access token
Network Slicing v1.0.0 6
POST
/slice/v1/slices/{id}/activate
Activate a network slice.
POST
/slice/v1/slices/{id}/deactivate
Deactivate a network slice.
GET
/slice/v1/slices
Returns All Slices
POST
/slice/v1/slices
Create a network slice.
DELETE
/slice/v1/slices/{id}
Delete network slice.
GET
/slice/v1/slices/{id}
Get network slice data.
Location Verification v0.2.0 1
POST
/location-verification/v0/verify
Verify the location of a device
Geofencing v0.3.0 4
DELETE
/geofencing-subscriptions/v0.3/subscriptions/{subscriptionId}
Delete a Geofencing event subscription
GET
/geofencing-subscriptions/v0.3/subscriptions/{subscriptionId}
Operation to retrieve a subscription based on the provided ID
POST
/geofencing-subscriptions/v0.3/subscriptions
Create a geofencing subscription for a device
GET
/geofencing-subscriptions/v0.3/subscriptions
Retrieve a list of geofencing event subscription
Number Recycling v0.2 1
POST
/passthrough/camara/v1/number-recycling/number-recycling/v0.2/check
Check whether the subscriber of the phone number has changed.
Quality-of-Service on Demand v0.10.1 5
POST
/qod/v0/sessions/{sessionId}/extend
Extend the duration of an active session
GET
/qod/v0/sessions/{sessionId}
Get QoS session information
DELETE
/qod/v0/sessions/{sessionId}
Delete a QoS session
POST
/qod/v0/sessions
Creates a new session
POST
/qod/v0/retrieve-sessions
Retrieve sessions for a specific device
KYC Age Verification v0.1 1
POST
/passthrough/camara/v1/kyc-age-verification/kyc-age-verification/v0.1/verify
Verify Age Threshold
Device Reachability Status Subscriptions v0.8 4
GET
/device-status/device-reachability-status-subscriptions/v0.8/subscriptions/{subscriptionId}
Retrieve a device reachability status event subscription for a device
DELETE
/device-status/device-reachability-status-subscriptions/v0.8/subscriptions/{subscriptionId}
Delete a device reachability status event subscription for a device
GET
/device-status/device-reachability-status-subscriptions/v0.8/subscriptions
Retrieve a list of device reachability status event subscription
POST
/device-status/device-reachability-status-subscriptions/v0.8/subscriptions
Create a device reachability status event subscription for a device
Congestion Insights v1.0.0 5
POST
/congestion-insights/v0/subscriptions
Create device congestion subscription
GET
/congestion-insights/v0/subscriptions
Get congestion subscriptions
GET
/congestion-insights/v0/subscriptions/{resource_id}
Get congestion subscription
DELETE
/congestion-insights/v0/subscriptions/{resource_id}
Unsubscribe from congestion event
POST
/congestion-insights/v0/query
Fetch congestion level for a device.
Location Verification v1.0.0 1
POST
/location-verification/v1/verify
Verify the location of a device
KYC FIll In v0.4 1
POST
/passthrough/camara/v1/kyc-fill-in/kyc-fill-in/v0.4/fill-in
Providing information related to a customer identity stored the account data bound to the customer's phone number.
Device Swap v1.0.0 2
POST
/passthrough/camara/v1/device-swap/device-swap/v1/retrieve-date
Get last device swap date
POST
/passthrough/camara/v1/device-swap/device-swap/v1/check
Check last device swap date
Device Reachability Status Retrieve v1.1.0 1
POST
/device-status/device-reachability-status/v1/retrieve
Get the current reachability status information
Location Retrieval v0.2.0 1
POST
/location-retrieval/v0/retrieve
Execute location retrieval for a user equipment
Consent Info v0.1.0 1
POST
/passthrough/camara/v1/consent-info/consent-info/v0.1/retrieve
Create a request to retrieve the validity status of the data processing
Device Roaming Status Retrieve v1.1.0 1
POST
/device-status/device-roaming-status/v1/retrieve
Get the current roaming status and the country information
Call Forwarding Signal v0.3.0 2
POST
/passthrough/camara/v1/call-forwarding-signal/call-forwarding-signal/v0.3/call-forwardings
Retrieve the information about the type of call forwarding service active on a phone number (PhoneNumber)
POST
/passthrough/camara/v1/call-forwarding-signal/call-forwarding-signal/v0.3/unconditional-call-forwardings
Retrieve the information about the status of the unconditional call forwarding service on a phone number (PhoneNumber)
KYC Match v0.3 1
POST
/passthrough/camara/v1/kyc-match/kyc-match/v0.3/match
Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.
Schemas 588
The contract defines 588 schemas that model the data the API accepts and returns. The most detailed are KYC_MatchResponse-KYC-M-V0 (32 properties), KYC_FillinResponse-KYC-FIN-V0 (25 properties), KYC_MatchRequestBody-KYC-M-V0 (20 properties), Slice-Input-Slice-V1 (18 properties). Each schema is shown below with its type and property counts.
ErrorInfo-Geo-V0
object
The error info object for possible error cases
3 properties
3 required
SubscriptionRequest-Geo-V0
object
The request for creating a event-type event subscription
5 properties
4 required
Protocol-Geo-V0
string
Identifier of a delivery protocol. Only HTTP is allowed for now
Config-Geo-V0
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
4 properties
1 required
SinkCredential-Geo-V0
object
1 property
1 required
PlainCredential-Geo-V0
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential-Geo-V0
object
An access token credential.
RefreshTokenCredential-Geo-V0
object
An access token credential with a refresh token.
5 required
SubscriptionDetail-Geo-V0
object
The detail of the requested event subscription
2 properties
2 required
SubscriptionEventType-Geo-V0
string
area-entered - Event triggered when the device enters the given area area-left - Event triggered when the device leaves the given area
NotificationEventType-Geo-V0
string
area-entered - Event triggered when the device enters the given area area-left - Event triggered when the device leaves the given area subscription-ends - Even…
Subscription-Geo-V0
object
Represents a event-type subscription.
9 properties
6 required
SubscriptionAsync-Geo-V0
object
Response for a event-type subscription request managed asynchronously (Creation or Deletion)
1 property
SubscriptionId-Geo-V0
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
Device-Geo-V0
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
PhoneNumber-Geo-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-Geo-V0
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…
DeviceIpv4Addr-Geo-V0
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
SingleIpv4Addr-Geo-V0
string
A single IPv4 address with no subnet mask
Port-Geo-V0
integer
TCP or UDP port number
DeviceIpv6Address-Geo-V0
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…
Area-Geo-V0
object
1 property
1 required
AreaType-Geo-V0
string
Type of this area. CIRCLE - The area is defined as a circle. POI - The area is defined by a named point of interest.
Circle-Geo-V0
Circular area
Poi-Geo-V0
Point of interest area
Point-Geo-V0
object
Coordinates (latitude, longitude) defining a location in a map
2 properties
2 required
Latitude-Geo-V0
number
Latitude component of a location
Longitude-Geo-V0
number
Longitude component of location
CloudEvent-Geo-V0
object
The notification callback
7 properties
6 required
Source-Geo-V0
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
DateTime-Geo-V0
string
Timestamp of when the occurrence happened. Must adhere to RFC 3339.
EventAreaLeft-Geo-V0
event structure for event when the device leaves the area
EventAreaEntered-Geo-V0
event structure for event when the device enters the area
EventSubscriptionEnds-Geo-V0
event structure for event subscription ends
AreaLeft-Geo-V0
object
Event detail structure for area-left event
3 properties
3 required
AreaEntered-Geo-V0
object
Event detail structure for area-entered event
3 properties
3 required
SubscriptionEnds-Geo-V0
object
Event detail structure for SUBSCRIPTIONENDS event
5 properties
4 required
TerminationReason-Geo-V0
string
- NETWORKTERMINATED - API server stopped sending notification - SUBSCRIPTIONUNPROCESSABLE - Subscription cannot be processed due to some reason, e.g. because t…
HTTPSubscriptionRequest-Geo-V0
HTTPSubscriptionResponse-Geo-V0
HTTPSettings-Geo-V0
object
2 properties
MQTTSubscriptionRequest-Geo-V0
MQTTSubscriptionResponse-Geo-V0
MQTTSettings-Geo-V0
object
5 properties
1 required
AMQPSubscriptionRequest-Geo-V0
AMQPSubscriptionResponse-Geo-V0
AMQPSettings-Geo-V0
object
4 properties
ApacheKafkaSubscriptionRequest-Geo-V0
ApacheKafkaSubscriptionResponse-Geo-V0
ApacheKafkaSettings-Geo-V0
object
4 properties
1 required
NATSSubscriptionRequest-Geo-V0
NATSSubscriptionResponse-Geo-V0
NATSSettings-Geo-V0
object
1 property
1 required
RetrievalLocationRequest-LocR-V0
object
2 properties
1 required
Device-LocR-V0
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
PhoneNumber-LocR-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-LocR-V0
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…
DeviceIpv4Addr-LocR-V0
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
SingleIpv4Addr-LocR-V0
string
A single IPv4 address with no subnet mask
Port-LocR-V0
integer
TCP or UDP port number
DeviceIpv6Address-LocR-V0
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…
Location-LocR-V0
object
Device location
2 properties
2 required
Area-LocR-V0
object
1 property
1 required
AreaType-LocR-V0
string
Type of this area. CIRCLE - The area is defined as a circle. POLYGON - The area is defined as a polygon.
Circle-LocR-V0
Circular area
Polygon-LocR-V0
PointList-LocR-V0
array
Point-LocR-V0
object
Coordinates (latitude, longitude) defining a location in a map
2 properties
2 required
Latitude-LocR-V0
number
Latitude component of a location
Longitude-LocR-V0
number
Longitude component of location
ErrorInfo-LocR-V0
object
3 properties
3 required
Area-LocV-V1
object
Base schema for all areas
1 property
1 required
AreaType-LocV-V1
string
Type of this area. CIRCLE - The area is defined as a circle.
Circle-LocV-V1
Circular area
Point-LocV-V1
object
Coordinates (latitude, longitude) defining a location in a map
2 properties
2 required
Latitude-LocV-V1
number
Latitude component of a location
Longitude-LocV-V1
number
Longitude component of location
VerifyLocationRequest-LocV-V1
object
Request to verify the location of a device. Device is not required when using a 3-legged access token, following the rules in the description.
3 properties
1 required
VerifyLocationResponse-LocV-V1
object
Response to a location verification request
3 properties
1 required
Device-LocV-V1
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
PhoneNumber-LocV-V1
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-LocV-V1
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…
DeviceIpv4Addr-LocV-V1
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
SingleIpv4Addr-LocV-V1
string
A single IPv4 address with no subnet mask
Port-LocV-V1
integer
TCP or UDP port number
DeviceIpv6Address-LocV-V1
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…
MaxAge-LocV-V1
integer
The maximum age (in seconds) for the location known by the implementation, which is accepted for the verification. Absence of maxAge means "any age" and maxAge…
VerificationResult-LocV-V1
string
Result of a verification request: - TRUE: when the network locates the device within the requested area, - FALSE: when the requested area does not match the ar…
MatchRate-LocV-V1
integer
Estimation of the match rate between the area in the request (R), and area where the network locates the device (N), calculated as the percent value of the int…
LastLocationTime-LocV-V1
string
Timestamp of the last location information. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allow…
ErrorInfo-LocV-V1
object
Common schema for errors
3 properties
3 required
Area-LocV-V0
object
1 property
1 required
AreaType-LocV-V0
string
Type of this area. CIRCLE - The area is defined as a circle.
Circle-LocV-V0
Circular area
Point-LocV-V0
object
Coordinates (latitude, longitude) defining a location in a map
2 properties
2 required
Latitude-LocV-V0
number
Latitude component of a location
Longitude-LocV-V0
number
Longitude component of location
VerifyLocationRequest-LocV-V0
object
3 properties
2 required
VerifyLocationResponse-LocV-V0
object
3 properties
1 required
Device-LocV-V0
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
PhoneNumber-LocV-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-LocV-V0
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…
DeviceIpv4Addr-LocV-V0
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
SingleIpv4Addr-LocV-V0
string
A single IPv4 address with no subnet mask
Port-LocV-V0
integer
TCP or UDP port number
DeviceIpv6Address-LocV-V0
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…
MaxAge-LocV-V0
integer
The maximum age (in seconds) of the available location, which is accepted for the verification.
VerificationResult-LocV-V0
string
Result of a verification request: - TRUE: when the network locates the device within the requested area, - FALSE: when the requested area does not match the ar…
MatchRate-LocV-V0
integer
Estimation of the match rate between the area in the request (R), and area where the network locates the device (N), calculated as the percent value of the int…
LastLocationTime-LocV-V0
string
Timestamp of the last location information. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allow…
ErrorInfo-LocV-V0
object
3 properties
3 required
ErrorInfo-DS-RES-V0
object
3 properties
3 required
SubscriptionRequest-DS-RES-V0
object
The request for creating a event-type event subscription
5 properties
4 required
Protocol-DS-RES-V0
string
Identifier of a delivery protocol. Only HTTP is allowed for now
Config-DS-RES-V0
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
4 properties
1 required
SinkCredential-DS-RES-V0
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property
1 required
PlainCredential-DS-RES-V0
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential-DS-RES-V0
object
An access token credential.
RefreshTokenCredential-DS-RES-V0
object
An access token credential with a refresh token.
5 required
CreateSubscriptionDetail-DS-RES-V0
object
The detail of the requested event subscription.
1 property
EventTypeNotification-DS-RES-V0
string
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability). reachability-sms - Event t…
SubscriptionEventType-DS-RES-V0
string
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability). reachability-sms - Event t…
Subscription-DS-RES-V0
object
Represents a event-type subscription.
8 properties
5 required
Device-DS-RES-V0
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
PhoneNumber-DS-RES-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-RES-V0
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…
DeviceIpv4Addr-DS-RES-V0
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
SingleIpv4Addr-DS-RES-V0
string
A single IPv4 address with no subnet mask
Port-DS-RES-V0
integer
TCP or UDP port number
DeviceIpv6Address-DS-RES-V0
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…
SubscriptionAsync-DS-RES-V0
object
Response for a device reachability status operation managed asynchronously (Creation or Deletion)
1 property
SubscriptionId-DS-RES-V0
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
CloudEvent-DS-RES-V0
object
The notification callback
7 properties
5 required
Source-DS-RES-V0
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
DateTime-DS-RES-V0
string
Timestamp of when the occurrence happened. If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the cu…
EventReachabilityData-DS-RES-V0
event structure for reachability data usage
EventReachabilitySms-DS-RES-V0
event structure for reachability SMS usage
EventReachabilityDisconnected-DS-RES-V0
event structure for disconnection
ReachabilityDataSmsDisconnected-DS-RES-V0
object
2 properties
1 required
EventSubscriptionEnds-DS-RES-V0
event structure for event subscription ends
SubscriptionEnds-DS-RES-V0
object
Event detail structure for org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ends event
4 properties
2 required
TerminationReason-DS-RES-V0
string
- NETWORKTERMINATED - API server stopped sending notification - SUBSCRIPTIONEXPIRED - Subscription expire time (optionally set by the requester) has been reach…
HTTPSubscriptionRequest-DS-RES-V0
HTTPSubscriptionResponse-DS-RES-V0
HTTPSettings-DS-RES-V0
object
2 properties
MQTTSubscriptionRequest-DS-RES-V0
MQTTSubscriptionResponse-DS-RES-V0
MQTTSettings-DS-RES-V0
object
5 properties
1 required
AMQPSubscriptionRequest-DS-RES-V0
AMQPSubscriptionResponse-DS-RES-V0
AMQPSettings-DS-RES-V0
object
4 properties
ApacheKafkaSubscriptionRequest-DS-RES-V0
ApacheKafkaSubscriptionResponse-DS-RES-V0
ApacheKafkaSettings-DS-RES-V0
object
4 properties
1 required
NATSSubscriptionRequest-DS-RES-V0
NATSSubscriptionResponse-DS-RES-V0
NATSSettings-DS-RES-V0
object
1 property
1 required
ErrorInfo-DS-ROS-V0
object
3 properties
3 required
SubscriptionRequest-DS-ROS-V0
object
The request for creating a event-type event subscription
5 properties
4 required
Protocol-DS-ROS-V0
string
Identifier of a delivery protocol. Only HTTP is allowed for now
Config-DS-ROS-V0
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
4 properties
1 required
SinkCredential-DS-ROS-V0
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property
1 required
PlainCredential-DS-ROS-V0
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential-DS-ROS-V0
object
An access token credential.
RefreshTokenCredential-DS-ROS-V0
object
An access token credential with a refresh token.
5 required
CreateSubscriptionDetail-DS-ROS-V0
object
The detail of the requested event subscription.
1 property
EventTypeNotification-DS-ROS-V0
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
SubscriptionEventType-DS-ROS-V0
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
Subscription-DS-ROS-V0
object
Represents a event-type subscription.
8 properties
5 required
Device-DS-ROS-V0
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
PhoneNumber-DS-ROS-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-ROS-V0
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…
DeviceIpv4Addr-DS-ROS-V0
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
SingleIpv4Addr-DS-ROS-V0
string
A single IPv4 address with no subnet mask
Port-DS-ROS-V0
integer
TCP or UDP port number
DeviceIpv6Address-DS-ROS-V0
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…
CountryCode-DS-ROS-V0
integer
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
CountryName-DS-ROS-V0
array
The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries.…
NotificationEventType-DS-ROS-V0
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
SubscriptionAsync-DS-ROS-V0
object
Response for a device reachability status operation managed asynchronously (Creation or Deletion)
1 property
SubscriptionId-DS-ROS-V0
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
CloudEvent-DS-ROS-V0
object
The notification callback
7 properties
5 required
Source-DS-ROS-V0
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
DateTime-DS-ROS-V0
string
Timestamp of when the occurrence happened. Must adhere to RFC 3339.
EventRoamingStatus-DS-ROS-V0
event structure for roaming status change
EventRoamingOn-DS-ROS-V0
event structure for roaming on change
EventRoamingOff-DS-ROS-V0
event structure for roaming off change
EventRoamingChangeCountry-DS-ROS-V0
event structure for roaming change country
EventSubscriptionEnds-DS-ROS-V0
event structure for event subscription ends
BasicDeviceEventData-DS-ROS-V0
object
Event detail structure for basic device events
2 properties
1 required
RoamingStatus-DS-ROS-V0
Event detail structure for org.camaraproject.device-roaming-status-subscriptions.v0.roaming-status event
RoamingChangeCountry-DS-ROS-V0
Event detail structure for org.camaraproject.device-roaming-status-subscriptions.v0.roaming-on event
SubscriptionEnds-DS-ROS-V0
object
Event detail structure for org.camaraproject.device-roaming-status-subscriptions.v0.subscription-ends event
2 properties
1 required
TerminationReason-DS-ROS-V0
string
- NETWORKTERMINATED - API server stopped sending notification - SUBSCRIPTIONEXPIRED - Subscription expire time (optionally set by the requester) has been reach…
HTTPSubscriptionRequest-DS-ROS-V0
HTTPSubscriptionResponse-DS-ROS-V0
HTTPSettings-DS-ROS-V0
object
2 properties
MQTTSubscriptionRequest-DS-ROS-V0
MQTTSubscriptionResponse-DS-ROS-V0
MQTTSettings-DS-ROS-V0
object
5 properties
1 required
AMQPSubscriptionRequest-DS-ROS-V0
AMQPSubscriptionResponse-DS-ROS-V0
AMQPSettings-DS-ROS-V0
object
4 properties
ApacheKafkaSubscriptionRequest-DS-ROS-V0
ApacheKafkaSubscriptionResponse-DS-ROS-V0
ApacheKafkaSettings-DS-ROS-V0
object
4 properties
1 required
NATSSubscriptionRequest-DS-ROS-V0
NATSSubscriptionResponse-DS-ROS-V0
NATSSettings-DS-ROS-V0
object
1 property
1 required
LastStatusTime-DS-RE-V110
string
Last time that the associated device reachability status was updated. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and m…
ReachabilityStatusResponse-DS-RE-V110
object
4 properties
2 required
ConnectivityType-DS-RE-V110
string
DATA: The device is connected to the network for Data usage (regardless of the SMS reachability) SMS: The device is connected to the network only for SMS usage
Device-DS-RE-V110
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
DeviceResponse-DS-RE-V110
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…
PhoneNumber-DS-RE-V110
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-RE-V110
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…
DeviceIpv4Addr-DS-RE-V110
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
SingleIpv4Addr-DS-RE-V110
string
A single IPv4 address with no subnet mask
Port-DS-RE-V110
integer
TCP or UDP port number
DeviceIpv6Address-DS-RE-V110
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…
RequestReachabilityStatus-DS-RE-V110
object
The request to retrieve the current roaming-status for the requested device.
1 property
ErrorInfo-DS-RE-V110
object
3 properties
3 required
XCorrelator-DS-RE-V110
string
RoamingStatusResponse-DS-RO-V110
object
5 properties
2 required
LastStatusTime-DS-RO-V110
string
Last time that the associated device reachability status was updated. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and m…
ActiveRoaming-DS-RO-V110
boolean
Roaming status. True, if it is roaming
Device-DS-RO-V110
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
DeviceResponse-DS-RO-V110
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…
PhoneNumber-DS-RO-V110
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-RO-V110
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…
DeviceIpv4Addr-DS-RO-V110
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
SingleIpv4Addr-DS-RO-V110
string
A single IPv4 address with no subnet mask
Port-DS-RO-V110
integer
TCP or UDP port number
DeviceIpv6Address-DS-RO-V110
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…
CountryCode-DS-RO-V110
integer
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
CountryName-DS-RO-V110
array
The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries.…
RoamingStatusRequest-DS-RO-V110
object
The request for retrieving the current roaming status for the requested device.
1 property
ErrorInfo-DS-RO-V110
object
3 properties
3 required
XCorrelator-DS-RO-V110
string
ErrorInfo-DS-RES-V080
object
3 properties
3 required
SubscriptionRequest-DS-RES-V080
object
The request for creating a event-type event subscription
5 properties
4 required
Protocol-DS-RES-V080
string
Identifier of a delivery protocol. Only HTTP is allowed for now
Config-DS-RES-V080
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
4 properties
1 required
SinkCredential-DS-RES-V080
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property
1 required
PlainCredential-DS-RES-V080
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential-DS-RES-V080
object
An access token credential.
RefreshTokenCredential-DS-RES-V080
object
An access token credential with a refresh token.
5 required
CreateSubscriptionDetail-DS-RES-V080
object
The detail of the requested event subscription.
1 property
EventTypeNotification-DS-RES-V080
string
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability). reachability-sms - Event t…
SubscriptionEventType-DS-RES-V080
string
reachability-data - Event triggered when the device is connected to the network for Data usage (regardless of the SMS reachability). reachability-sms - Event t…
Subscription-DS-RES-V080
object
Represents a event-type subscription.
8 properties
5 required
Device-DS-RES-V080
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
DeviceResponse-DS-RES-V080
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…
PhoneNumber-DS-RES-V080
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-RES-V080
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…
DeviceIpv4Addr-DS-RES-V080
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
SingleIpv4Addr-DS-RES-V080
string
A single IPv4 address with no subnet mask
Port-DS-RES-V080
integer
TCP or UDP port number
DeviceIpv6Address-DS-RES-V080
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…
SubscriptionAsync-DS-RES-V080
object
Response for a device reachability status operation managed asynchronously (Creation or Deletion)
1 property
1 required
SubscriptionId-DS-RES-V080
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
CloudEvent-DS-RES-V080
object
The notification callback
7 properties
5 required
Source-DS-RES-V080
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
DateTime-DS-RES-V080
string
Timestamp of when the occurrence happened. If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the cu…
EventReachabilityData-DS-RES-V080
event structure for reachability data usage
EventReachabilitySms-DS-RES-V080
event structure for reachability SMS usage
EventReachabilityDisconnected-DS-RES-V080
event structure for disconnection
ReachabilityDataSmsDisconnected-DS-RES-V080
object
2 properties
1 required
EventSubscriptionEnded-DS-RES-V080
Event structure for sending subscription-ended event
EventSubscriptionStarted-DS-RES-V080
Event structure for event subscription started
SubscriptionStarted-DS-RES-V080
object
Event detail structure for subscription started event
4 properties
2 required
InitiationReason-DS-RES-V080
string
- SUBSCRIPTIONCREATED - Subscription created by API Server
EventSubscriptionUpdated-DS-RES-V080
Event structure for event subscription updated
SubscriptionUpdated-DS-RES-V080
object
Event detail structure for subscription updated event
4 properties
2 required
UpdateReason-DS-RES-V080
string
- SUBSCRIPTIONACTIVE - API server transitioned susbcription status to ACTIVE - SUBSCRIPTIONINACTIVE - API server transitioned susbcription status to INACTIVE
SubscriptionEnded-DS-RES-V080
object
Event detail structure for org.camaraproject.device-reachability-status-subscriptions.v0.subscription-ended event
4 properties
2 required
TerminationReason-DS-RES-V080
string
- NETWORKTERMINATED - API server stopped sending notification - SUBSCRIPTIONEXPIRED - Subscription expire time (optionally set by the requester) has been reach…
HTTPSubscriptionRequest-DS-RES-V080
HTTPSubscriptionResponse-DS-RES-V080
HTTPSettings-DS-RES-V080
object
2 properties
MQTTSubscriptionRequest-DS-RES-V080
MQTTSubscriptionResponse-DS-RES-V080
MQTTSettings-DS-RES-V080
object
5 properties
1 required
AMQPSubscriptionRequest-DS-RES-V080
AMQPSubscriptionResponse-DS-RES-V080
AMQPSettings-DS-RES-V080
object
4 properties
ApacheKafkaSubscriptionRequest-DS-RES-V080
ApacheKafkaSubscriptionResponse-DS-RES-V080
ApacheKafkaSettings-DS-RES-V080
object
4 properties
1 required
NATSSubscriptionRequest-DS-RES-V080
NATSSubscriptionResponse-DS-RES-V080
NATSSettings-DS-RES-V080
object
1 property
1 required
XCorrelator-DS-RES-V080
string
ErrorInfo-DS-ROS-V080
object
3 properties
3 required
SubscriptionRequest-DS-ROS-V080
object
The request for creating a event-type event subscription
5 properties
4 required
Protocol-DS-ROS-V080
string
Identifier of a delivery protocol. Only HTTP is allowed for now
Config-DS-ROS-V080
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
4 properties
1 required
SinkCredential-DS-ROS-V080
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property
1 required
PlainCredential-DS-ROS-V080
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential-DS-ROS-V080
object
An access token credential.
RefreshTokenCredential-DS-ROS-V080
object
An access token credential with a refresh token.
5 required
CreateSubscriptionDetail-DS-ROS-V080
object
The detail of the requested event subscription.
1 property
EventTypeNotification-DS-ROS-V080
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
SubscriptionEventType-DS-ROS-V080
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
Subscription-DS-ROS-V080
object
Represents a event-type subscription.
8 properties
5 required
Device-DS-ROS-V080
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
DeviceResponse-DS-ROS-V080
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…
PhoneNumber-DS-ROS-V080
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-ROS-V080
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…
DeviceIpv4Addr-DS-ROS-V080
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
SingleIpv4Addr-DS-ROS-V080
string
A single IPv4 address with no subnet mask
Port-DS-ROS-V080
integer
TCP or UDP port number
DeviceIpv6Address-DS-ROS-V080
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…
CountryCode-DS-ROS-V080
integer
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
CountryName-DS-ROS-V080
array
The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries.…
SubscriptionAsync-DS-ROS-V080
object
Response for a device reachability status operation managed asynchronously (Creation or Deletion)
1 property
1 required
SubscriptionId-DS-ROS-V080
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
CloudEvent-DS-ROS-V080
object
The notification callback
7 properties
5 required
Source-DS-ROS-V080
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
DateTime-DS-ROS-V080
string
Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and must have time zone.
EventRoamingStatus-DS-ROS-V080
event structure for roaming status change
EventRoamingOn-DS-ROS-V080
event structure for roaming on change
EventRoamingOff-DS-ROS-V080
event structure for roaming off change
EventRoamingChangeCountry-DS-ROS-V080
event structure for roaming change country
EventSubscriptionEnded-DS-ROS-V080
Event structure for sending subscription-ended event
EventSubscriptionStarted-DS-ROS-V080
Event structure for event subscription started
SubscriptionStarted-DS-ROS-V080
object
Event detail structure for subscription started event
4 properties
2 required
InitiationReason-DS-ROS-V080
string
- SUBSCRIPTIONCREATED - Subscription created by API Server
EventSubscriptionUpdated-DS-ROS-V080
Event structure for event subscription updated
SubscriptionUpdated-DS-ROS-V080
object
Event detail structure for subscription updated event
4 properties
2 required
UpdateReason-DS-ROS-V080
string
- SUBSCRIPTIONACTIVE - API server transitioned subscription status to ACTIVE - SUBSCRIPTIONINACTIVE - API server transitioned subscription status to INACTIVE
BasicDeviceEventData-DS-ROS-V080
object
Event detail structure for basic device events
2 properties
1 required
RoamingStatus-DS-ROS-V080
Event detail structure for org.camaraproject.device-roaming-status-subscriptions.v0.roaming-status event
RoamingChangeCountry-DS-ROS-V080
Event detail structure for org.camaraproject.device-roaming-status-subscriptions.v0.roaming-on event
SubscriptionEnded-DS-ROS-V080
object
Event detail structure for org.camaraproject.device-roaming-status-subscriptions.v0.subscription-ended event
2 properties
1 required
TerminationReason-DS-ROS-V080
string
- NETWORKTERMINATED - API server stopped sending notification - SUBSCRIPTIONEXPIRED - Subscription expire time (optionally set by the requester) has been reach…
HTTPSubscriptionRequest-DS-ROS-V080
HTTPSubscriptionResponse-DS-ROS-V080
HTTPSettings-DS-ROS-V080
object
2 properties
MQTTSubscriptionRequest-DS-ROS-V080
MQTTSubscriptionResponse-DS-ROS-V080
MQTTSettings-DS-ROS-V080
object
5 properties
1 required
AMQPSubscriptionRequest-DS-ROS-V080
AMQPSubscriptionResponse-DS-ROS-V080
AMQPSettings-DS-ROS-V080
object
4 properties
ApacheKafkaSubscriptionRequest-DS-ROS-V080
ApacheKafkaSubscriptionResponse-DS-ROS-V080
ApacheKafkaSettings-DS-ROS-V080
object
4 properties
1 required
NATSSubscriptionRequest-DS-ROS-V080
NATSSubscriptionResponse-DS-ROS-V080
NATSSettings-DS-ROS-V080
object
1 property
1 required
XCorrelator-DS-ROS-V080
string
RoamingStatusResponse-DS-V0
object
3 properties
1 required
ActiveRoaming-DS-V0
boolean
Roaming status. True, if it is roaming
ConnectivityStatusResponse-DS-V0
object
1 property
1 required
ConnectivityStatus-DS-V0
string
CONNECTEDDATA: The device is connected to the network for Data usage CONNECTEDSMS: The device is connected to the network for SMS usage NOTCONNECTED: The devic…
Device-DS-V0
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
PhoneNumber-DS-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
NetworkAccessIdentifier-DS-V0
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…
DeviceIpv4Addr-DS-V0
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
SingleIpv4Addr-DS-V0
string
A single IPv4 address with no subnet mask
Port-DS-V0
integer
TCP or UDP port number
DeviceIpv6Address-DS-V0
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…
CountryCode-DS-V0
integer
The Mobile country code (MCC) as an geographic region identifier for the country and the dependent areas.
CountryName-DS-V0
array
The ISO 3166 ALPHA-2 country-codes of mapped to mobile country code(MCC). If there is mapping of one MCC to multiple countries, then we have list of countries.…
RequestRoamingStatus-DS-V0
object
1 property
1 required
RequestConnectivityStatus-DS-V0
object
1 property
1 required
ErrorInfo-DS-V0
object
3 properties
3 required
CreateSubscription-DS-V0
object
The request for creating a Device Status event subscription
3 properties
2 required
Webhook-DS-V0
object
Webhook information for event channel
2 properties
1 required
SubscriptionDetail-DS-V0
object
The detail of the requested event subscription
2 properties
2 required
SubscriptionEventType-DS-V0
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
SubscriptionCreationEventType-DS-V0
string
roaming-status - Event triggered when the device switch from roaming ON to roaming OFF and conversely roaming-on - Event triggered when the device switch from…
SubscriptionInfo-DS-V0
Represents a device status subscription.
SubscriptionAsync-DS-V0
object
Response for a device status operation managed asynchronously (Creation or Deletion)
1 property
SubscriptionId-DS-V0
string
The event subscription identifier.
CloudEvent-DS-V0
object
The notification callback
7 properties
6 required
Source-DS-V0
string
Identifies the context in which an event happened in the specific Provider Implementation.
DateTime-DS-V0
string
Timestamp of when the occurrence happened. Must adhere to RFC 3339.
EventRoamingStatus-DS-V0
event structure for roaming status change
EventRoamingOn-DS-V0
event structure for roaming on change
EventRoamingOff-DS-V0
event structure for roaming off change
EventRoamingChangeCountry-DS-V0
event structure for roaming change country
EventConnectivityData-DS-V0
event structure for connectivity data usage
EventConnectivitySms-DS-V0
event structure for connectivity SMS usage
EventConnectivityDisconnected-DS-V0
event structure for disconnection
EventSubscriptionEnds-DS-V0
event structure for event subscription ends
BasicDeviceEventData-DS-V0
object
Event detail structure for basic device events
2 properties
1 required
RoamingStatus-DS-V0
object
Event detail structure for org.camaraproject.device-status.v0.roaming-status event
5 properties
2 required
RoamingChangeCountry-DS-V0
object
Event detail structure for org.camaraproject.device-status.v0.roaming-on event
4 properties
1 required
SubscriptionEnds-DS-V0
object
Event detail structure for org.camaraproject.device-status.v0.subscription-ends event
3 properties
2 required
NumberVerificationRequestBody-NV-V1
object
Payload to verify the phone number.
2 properties
NumberVerificationMatchResponse-NV-V1
object
Number verification result
1 property
1 required
NumberVerificationShareResponse-NV-V1
object
Number verification share result
1 property
1 required
DevicePhoneNumber-NV-V1
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DevicePhoneNumberVerified-NV-V1
boolean
Number verification. True, if it matches
ErrorInfo-NV-V1
object
3 properties
3 required
XCorrelator-NV-V2
string
NokiaNumberVerificationCredential-NV-V2
Nokia proprietary optional field. Encoded SD-JWT; when extracted and decoded, it may contain the TS.43 operator token and related claims.
NumberVerificationRequestBody-NV-V2
Payload to verify the phone number. Exactly one of phoneNumber or hashedPhoneNumber is required; credential is optional.
NumberVerificationMatchResponse-NV-V2
object
Number verification result
1 property
1 required
NumberVerificationShareResponse-NV-V2
object
Number verification share result
1 property
1 required
DevicePhoneNumber-NV-V2
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DevicePhoneNumberVerified-NV-V2
boolean
Number verification. True, if it matches
ErrorInfo-NV-V2
object
3 properties
3 required
VerifyRequestBody-KYC-AV-V0
object
Request to verify the age threshold provided.
12 properties
1 required
AgeThreshold-KYC-AV-V0
integer
The age to be verified. The indicated range is a global definition of maximum and minimum values allowed to be requested. It is important to note that this ran…
PhoneNumber-KYC-AV-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
IdDocument-KYC-AV-V0
string
Id number associated to the official identity document in the country. It may contain alphanumeric characters.
Name-KYC-AV-V0
string
Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give n…
GivenName-KYC-AV-V0
string
First/given name or compound first/given name of the customer.
FamilyName-KYC-AV-V0
string
Last name, family name, or surname of the customer.
MiddleNames-KYC-AV-V0
string
Middle name/s of the customer.
FamilyNameAtBirth-KYC-AV-V0
string
Last/family/sur- name at birth of the customer.
Birthdate-KYC-AV-V0
string
The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
Email-KYC-AV-V0
string
Email address of the customer in the RFC specified format (local-part@domain).
IncludeContentLock-KYC-AV-V0
boolean
If this parameter is included in the request with value true, the response property contentLock will be returned. If it is not included or its value is false,…
IncludeParentalControl-KYC-AV-V0
boolean
If this parameter is included in the request with value true, the response property parentalControl will be returned. If it is not included or its value is fal…
VerifyResponseBody-KYC-AV-V0
object
Response to an age verification request
5 properties
1 required
AgeCheck-KYC-AV-V0
string
Indicate "true" when the age of the user is the same age or older than the age threshold (age = age threshold), and "false" if not (age < age threshold). If th…
VerifiedStatus-KYC-AV-V0
boolean
Indicate true if the information provided has been compared against information based on an identification document legally accepted as an age verification doc…
IdentityMatchScore-KYC-AV-V0
integer
The overall score of identity information available in the API Provider, information either provided in the request body comparing it to the one that the API P…
ContentLock-KYC-AV-V0
string
Indicate "true" if the subscription associated with the phone number has any kind of content lock (i.e certain web content blocked) and "false" if not. If the…
ParentalControl-KYC-AV-V0
string
Indicate "true" if the subscription associated with the phone number has any kind of parental control activated and "false" if not. If the information is not a…
ErrorInfo-KYC-AV-V0
object
3 properties
3 required
KYC_MatchRequestBody-KYC-M-V0
object
Payload to validate the customer data.
20 properties
MatchResult-KYC-M-V0
string
MatchScoreResult-KYC-M-V0
integer
Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only b…
KYC_MatchResponse-KYC-M-V0
object
32 properties
ErrorInfo-KYC-M-V0
object
3 properties
3 required
Tenure-KYC-T-V0
object
Specifies date from which continuous tenure of the identified mobile subscriber is required to be confirmed
2 properties
1 required
PhoneNumber-KYC-T-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
TenureInfo-KYC-T-V0
object
2 properties
1 required
ErrorInfo-KYC-T-V0
object
3 properties
3 required
KYC_FillinRequest-KYC-FIN-V0
object
1 property
KYC_FillinResponse-KYC-FIN-V0
object
25 properties
ErrorInfo-KYC-FIN-V0
object
3 properties
3 required
XCorrelator-KYC-FIN-V0
string
CreateCheckNumRecycling-NUMR-RECYCL-V0
object
2 properties
1 required
PhoneNumber-NUMR-RECYCL-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
CheckNumRecyclingInfo-NUMR-RECYCL-V0
object
1 property
1 required
ErrorInfo-NUMR-RECYCL-V0
object
3 properties
3 required
XCorrelator-NUMR-RECYCL-V0
string
SimSwapInfo-SIM-V1
object
1 property
1 required
CheckSimSwapInfo-SIM-V1
object
1 property
1 required
PhoneNumber-SIM-V1
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
ErrorInfo-SIM-V1
object
3 properties
3 required
CreateCheckSimSwap-SIM-V1
object
2 properties
CreateSimSwapDate-SIM-V1
object
1 property
XCorrelator-DSWAP-V1
string
DeviceSwapInfo-DSWAP-V1
object
2 properties
1 required
CreateDeviceSwapDate-DSWAP-V1
object
1 property
CreateCheckDeviceSwap-DSWAP-V1
object
2 properties
PhoneNumber-DSWAP-V1
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
CheckDeviceSwapInfo-DSWAP-V1
object
1 property
1 required
ErrorInfo-DSWAP-V1
object
3 properties
3 required
SessionId-QoD-V0
string
Session ID in UUID format
BaseSessionInfo-QoD-V0
object
Common attributes of a QoD session
6 properties
3 required
SessionInfo-QoD-V0
Session related information.
CreateSession-QoD-V0
Attributes required to create a session
Port-QoD-V0
integer
TCP or UDP port number
ValidationError-QoD-V0
object
3 properties
3 required
HTTPValidationError-QoD-V0
object
1 property
PortsSpec-QoD-V0
object
2 properties
ExtendSessionDuration-QoD-V0
object
Attributes required to extend the duration of an active session
1 property
1 required
QosProfile-QoD-V0
object
Data type with attributes of a QosProfile
15 properties
2 required
QosProfileName-QoD-V0
string
A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options address…
Rate-QoD-V0
object
2 properties
Duration-QoD-V0
object
2 properties
TimeUnitEnum-QoD-V0
string
QosProfileStatusEnum-QoD-V0
string
The current status of the QoS Profile - ACTIVE- QoS Profile is available to be used - INACTIVE- QoS Profile is not currently available to be deployed - DEPRECA…
RateUnitEnum-QoD-V0
string
CloudEvent-QoD-V0
object
Event compliant with the CloudEvents specification
7 properties
5 required
EventQosStatusChanged-QoD-V0
StatusInfo-QoD-V0
string
Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'. DURATIONEXPIRED - Session terminated due to requested du…
Device-QoD-V0
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
ApplicationServer-QoD-V0
object
A server hosting backend applications to deliver some business logic to clients. The developer can choose to provide the below specified device identifiers: ip…
2 properties
NetworkAccessIdentifier-QoD-V0
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…
PhoneNumber-QoD-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DeviceIpv4Addr-QoD-V0
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
SingleIpv4Addr-QoD-V0
string
A single IPv4 address with no subnet mask
DeviceIpv6Address-QoD-V0
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…
ApplicationServerIpv4Address-QoD-V0
string
IPv4 address may be specified in form as: - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. -…
ApplicationServerIpv6Address-QoD-V0
string
IPv6 address may be specified in form as: - address - The /128 subnet is optional for single addresses: - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - 2001:db8:85a3:…
Message-QoD-V0
object
2 properties
2 required
QosStatus-QoD-V0
string
The current status of the requested QoS session. The status can be one of the following: REQUESTED - QoS has been requested by creating a session AVAILABLE - T…
RetrieveSessionInput-QoD-V0
object
1 property
1 required
EventQosStatus-QoD-V0
string
The current status of a requested or previously available session. Applicable values in the event are: AVAILABLE - The requested QoS has been provided by the n…
ErrorInfo-QoD-V0
object
3 properties
3 required
SessionId-QoD-V1
string
Session ID in UUID format
BaseSessionInfo-QoD-V1
object
Common attributes of a QoD session
7 properties
2 required
SessionInfo-QoD-V1
Session related information.
CreateSession-QoD-V1
Attributes required to create a session
Port-QoD-V1
integer
TCP or UDP port number
ValidationError-QoD-V1
object
3 properties
3 required
HTTPValidationError-QoD-V1
object
1 property
PortsSpec-QoD-V1
object
2 properties
SinkCredential-QoD-V1
object
1 property
1 required
AccessTokenCredential-QoD-V1
object
An access token credential.
ExtendSessionDuration-QoD-V1
object
Attributes required to extend the duration of an active session
1 property
1 required
QosProfileName-QoD-V1
string
A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options address…
CloudEvent-QoD-V1
object
Event compliant with the CloudEvents specification
7 properties
5 required
EventQosStatusChanged-QoD-V1
StatusInfo-QoD-V1
string
Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'. DURATIONEXPIRED - Session terminated due to requested du…
Device-QoD-V1
object
End-user equipment able to connect to a network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide the belo…
4 properties
ApplicationServer-QoD-V1
object
A server hosting backend applications to deliver some business logic to clients. The developer can choose to provide the below specified device identifiers: ip…
2 properties
NetworkAccessIdentifier-QoD-V1
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…
PhoneNumber-QoD-V1
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DeviceIpv4Addr-QoD-V1
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
SingleIpv4Addr-QoD-V1
string
A single IPv4 address with no subnet mask
DeviceIpv6Address-QoD-V1
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…
ApplicationServerIpv4Address-QoD-V1
string
IPv4 address may be specified in form as: - address - an IPv4 number in dotted-quad form 1.2.3.4. Only this exact IP number will match the flow control rule. -…
ApplicationServerIpv6Address-QoD-V1
string
IPv6 address may be specified in form as: - address - The /128 subnet is optional for single addresses: - 2001:db8:85a3:8d3:1319:8a2e:370:7344 - 2001:db8:85a3:…
Message-QoD-V1
object
2 properties
2 required
QosStatus-QoD-V1
string
The current status of the requested QoS session. The status can be one of the following: REQUESTED - QoS has been requested by creating a session AVAILABLE - T…
RetrieveSessionInput-QoD-V1
object
1 property
1 required
RetrieveSessionsOutput-QoD-V1
array
QoS session information for a given device
EventQosStatus-QoD-V1
string
The current status of a requested or previously available session. Applicable values in the event are: AVAILABLE - The requested QoS has been provided by the n…
ErrorInfo-QoD-V1
object
3 properties
3 required
UnconditionalCallForwardingSignal-Cfs-V0
object
resource containing the information about the Unconditional Call Forwarding Service for the given phone number (PhoneNumber)
1 property
CallForwardingSignal-Cfs-V0
array
resource containing the list of the Call Forwarding Services active for the given phone number (PhoneNumber). The possible states are, 'inactive' (no call forw…
CreateCallForwardingSignal-Cfs-V0
object
resource containing the phone number (PhoneNumber) regarding which the Call Forwarding Service must be checked. To be valorised only in case of two-legged auth…
1 property
PhoneNumber-Cfs-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
ErrorInfo-Cfs-V0
object
error info template
3 properties
3 required
XCorrelator-ConsentInfo-V0
string
Value for the x-correlator
PhoneNumber-ConsentInfo-V0
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
RetrieveStatusRequestBody-ConsentInfo-V0
object
The request body for the retrieve status request. It contains the requested scope(s), the Purpose for which the API Consumer intends to process the User's pers…
4 properties
3 required
Scopes-ConsentInfo-V0
array
List of requested scopes. The scope is a string that represents the access rights that the API Consumer is requesting from the User.
Purpose-ConsentInfo-V0
string
The reason for which personal data will be processed by the API Consumer. CAMARA defines a standard set of Purposes which can be used by API Consumers to speci…
RetrieveStatusResponseBody-ConsentInfo-V0
object
2 properties
1 required
statusInfo-ConsentInfo-V0
array
Provides information about the validity status of the requested data processing for the specified scope(s) and Purpose. It contains details of whether the proc…
statusInfoObject-ConsentInfo-V0
object
5 properties
3 required
ErrorInfo-ConsentInfo-V0
object
3 properties
3 required
Accepted-Slice-V1
object
1 property
AreaOfService-Slice-V1
object
1 property
1 required
CSMF_action-Slice-V1
string
Customer-Slice-V1
object
4 properties
1 required
HTTPValidationError-Slice-V1
object
1 property
IsolationLevel-Slice-V1
string
NetworkIdentifier-Slice-V1
object
2 properties
2 required
Point-Slice-V1
object
2 properties
ServiceOrderClientNotif-Slice-V1
object
4 properties
4 required
ServiceOrderStateType-Slice-V1
string
Slice-Input-Slice-V1
object
18 properties
3 required
Slice-Output-Slice-V1
object
18 properties
3 required
SliceData-Slice-V1
object
5 properties
4 required
SliceInfo-Slice-V1
object
2 properties
1 required
SliceState-Slice-V1
string
SliceTypeName-Slice-V1
string
Throughput-Slice-V1
object
2 properties
ValidationError-Slice-V1
object
3 properties
3 required
Apps-SliceAttach-V1
object
2 properties
2 required
AttachInfo-Input-SliceAttach-V1
object
5 properties
2 required
AttachInfo-Output-SliceAttach-V1
object
5 properties
2 required
AttachResource-Input-SliceAttach-V1
object
6 properties
2 required
AttachResource-Output-SliceAttach-V1
object
6 properties
2 required
AttachStatus-SliceAttach-V1
string
Customer-SliceAttach-V1
object
4 properties
1 required
DeviceIpv4Addr-SliceAttach-V1
object
3 properties
HTTPValidationError-SliceAttach-V1
object
1 property
MobileSubscribersDevice-SliceAttach-V1
object
5 properties
OrderState-SliceAttach-V1
string
TrafficCategories-SliceAttach-V1
object
1 property
1 required
ValidationError-SliceAttach-V1
object
3 properties
3 required
Webhook-SliceAttach-V1
object
2 properties
1 required
AnalyticsEvent-ConI-V1
string
AnalyticsEventNotif-ConI-V1
object
3 properties
2 required
AnalyticsEventNotification-ConI-V1
object
2 properties
2 required
CongestInfo-ConI-V1
object
1 property
1 required
CongestionAnalytics-ConI-V1
object
4 properties
3 required
CongestionData-ConI-V1
object
4 properties
3 required
CongestionLevel-ConI-V1
string
CongestionLevelDeprecated-ConI-V1
string
CongestionStatusDeprecated-ConI-V1
object
1 property
1 required
Device-ConI-V1
object
4 properties
DeviceIpv4Addr-ConI-V1
object
3 properties
FetchCongestion-ConI-V1
object
3 properties
1 required
HTTPValidationError-ConI-V1
object
1 property
SubscribeCongestionCreate-ConI-V1
object
3 properties
3 required
SubscriptionInfo-ConI-V1
object
6 properties
4 required
ThresholdLevel-ConI-V1
object
1 property
1 required
TimeAndDate-ConI-V1
object
2 properties
2 required
ValidationError-ConI-V1
object
3 properties
3 required
Webhook-ConI-V1
object
2 properties
1 required
ClientCredential-Auth-V1
object
2 properties
2 required
HTTPValidationError-Auth-V1
object
1 property
ValidationError-Auth-V1
object
3 properties
3 required
Metadata-WellKnown-V0
object
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Nokia Network as Code 6
Other APIs Nokia Network as Code publishes across the network.
Nokia Network as Code Platform API
Nokia Network as Code CAMARA API
Network as Code Digital Identity and Anti-Fraud APIs
Network as Code Device Intelligence APIs
Network as Code Programmable Connectivity APIs
Network as Code Authorization Server
#Network Intelligence#Congestion#Consent
Where this information came from
This is an independent, third-party profile of Network as Code Network Intelligence APIs, 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.