API Reference
Libraries
API Overview
Customerinsights
CustomerinsightsScoring
Customer Insights
Retrieves Scoring information
POST/customerinsights/scoring/retrieve
Deviceswap
Device Swap
Get last device swap date
POST/deviceswap/retrieve-date
Check last device swap date
POST/deviceswap/check
Knowyourcustomerageverification
Know Your Customer Age Verification
Verify Age Threshold
POST/knowyourcustomerageverification/verify
Knowyourcustomerfill In
Know Your Customer Fill-in
Providing information related to a customer identity stored the account data bound to the customer's phone number.
POST/knowyourcustomerfill-in/fill-in
Knowyourcustomermatch
Know Your Customer Match
Matching a customer identity by checking a set of attributes related against the account data bound to their phone number.
POST/knowyourcustomermatch/match
Tenure
KYC Tenure
The KYC Tenure service API
POST/tenure/check-tenure
Numberrecycling
Number Recycling
Check whether the subscriber of the phone number has changed.
POST/numberrecycling/check
Otpvalidation
One Time Password SMS
Sends a message including an OTP code to the given phone number
POST/otpvalidation/send-code
Verifies the OTP received as input
POST/otpvalidation/validate-code
Callforwardingsignal
Call Forwarding Signal
Retrieve the information about the status of the unconditional call forwarding service on a phone number (PhoneNumber)
POST/callforwardingsignal/unconditional-call-forwardings
Retrieve the information about the type of call forwarding service active on a phone number (PhoneNumber)
POST/callforwardingsignal/call-forwardings
Devicelocation
DevicelocationSubscriptions
Device Geofencing Subscriptions
Create a geofencing subscription for a device
POST/devicelocation/subscriptions
Retrieve a list of geofencing event subscription
GET/devicelocation/subscriptions
Operation to retrieve a subscription based on the provided ID
GET/devicelocation/subscriptions/{subscriptionId}
Delete a Geofencing event subscription
DELETE/devicelocation/subscriptions/{subscriptionId}
Populationdensitydata
Population Density Data
Retrieves population density information in a specified area
POST/populationdensitydata/retrieve
Regiondevicecount
Region Device Count
API operation to get the device count in the specified area during a certain time interval.
POST/regiondevicecount/count
Webrtc
WebrtcSessions
WebRTC Call Handling
Creates voice and/or video session
POST/webrtc/sessions
Get the media session information
GET/webrtc/sessions/{mediaSessionId}
Cancel or Terminate the media session
DELETE/webrtc/sessions/{mediaSessionId}
Update the status of the media session
PUT/webrtc/sessions/{mediaSessionId}/status
Connectivityinsights
ConnectivityinsightsSubscriptions
Connectivity Insights Subscriptions
Create a Connectivity insights subscription for a device
POST/connectivityinsights/subscriptions
Retrieve a list of apiName event subscription
GET/connectivityinsights/subscriptions
Operation to retrieve a subscription based on the provided ID
GET/connectivityinsights/subscriptions/{subscriptionId}
Operation to delete a subscription
DELETE/connectivityinsights/subscriptions/{subscriptionId}
Qualityondemand
QoS Profiles
Retrieve QoS profiles
POST/qualityondemand/retrieve-qos-profiles
Get QoS Profile for a given name
GET/qualityondemand/qos-profiles/{name}
Deviceidentifier
Device Identifier
Get details about the specific device being used by a given mobile subscriber
POST/deviceidentifier/retrieve-identifier
Get details about the type of device being used by a given mobile subscriber
POST/deviceidentifier/retrieve-type
Get a pseudonymous identifier for device being used by a given mobile subscriber
POST/deviceidentifier/retrieve-ppid
Simswap
SimswapSubscriptions
Sim Swap Subscriptions
Create a sim swap event subscription for a phone number
POST/simswap/subscriptions
Retrieve a list of sim swap event subscription
GET/simswap/subscriptions
Retrieve a sim swap event subscription for a phone number
GET/simswap/subscriptions/{subscriptionId}
Delete a sim swap event subscription
DELETE/simswap/subscriptions/{subscriptionId}
Deviceroamingstatus
DeviceroamingstatusSubscriptions
Device Roaming Status Subscriptions
Create a device roaming status event subscription for a device
POST/deviceroamingstatus/subscriptions
Retrieve a list of device roaming status event subscription
GET/deviceroamingstatus/subscriptions
Retrieve a roaming status event subscription for a device
GET/deviceroamingstatus/subscriptions/{subscriptionId}
Delete a device-roaming-status event subscription for a device
DELETE/deviceroamingstatus/subscriptions/{subscriptionId}
Devicereachabilitystatus
DevicereachabilitystatusSubscriptions
Device Reachability Status Subscriptions
Create a device reachability status event subscription for a device
POST/devicereachabilitystatus/subscriptions
Retrieve a list of device reachability status event subscription
GET/devicereachabilitystatus/subscriptions
Retrieve a device reachability status event subscription for a device
GET/devicereachabilitystatus/subscriptions/{subscriptionId}
Delete a device reachability status event subscription for a device
DELETE/devicereachabilitystatus/subscriptions/{subscriptionId}
Connectednetworktype
ConnectednetworktypeSubscriptions
Connected Network Type Subscriptions
Create a subscription for receiving notifications on changes to the connected network type of a device
POST/connectednetworktype/subscriptions
Retrieve a list of device connected network type event subscription
GET/connectednetworktype/subscriptions
Retrieve a device connected network type event subscription for a device
GET/connectednetworktype/subscriptions/{subscriptionId}
Delete connected network type event subscription for a device
DELETE/connectednetworktype/subscriptions/{subscriptionId}