Skip to main content
Sandbox
  • Mobile
Available in
  • UK

VRS Network Usage Event API

0.1

The Vodafone Roaming Services (VRS) API provides secure, real‑time access to roaming SIM activity using IMSI as the primary identifier.

It enables authorised partners to retrieve accurate usage and location insights, while incorporating safeguards to detect spoofed locations and validate subscriber authenticity.

The API aligns with TMF635 usage management standards and uses OAuth2 for secure and compliant access control.

Try it out

Sandbox
  • Mobile
Available in
  • UK

VRS Network Usage Event API

0.1

The Vodafone Roaming Services (VRS) API provides secure, real‑time access to roaming SIM activity using IMSI as the primary identifier.

It enables authorised partners to retrieve accurate usage and location insights, while incorporating safeguards to detect spoofed locations and validate subscriber authenticity.

The API aligns with TMF635 usage management standards and uses OAuth2 for secure and compliant access control.

Try it out

Image
Lightbulb icon
It can be used for
  • Get last‑known device location for quick verification.
  • Check real‑time roaming status for smarter service logic.
  • Access secure network insights to enhance your apps.

API Information

Version 0.1
Protocol HTTPS
Sandbox URL
Live URL Coming soon
Version history Release Date Status Description
0.1 January 2025 Sandbox Only VRS Network Usage first Release

How it works

The Vodafone Roaming Services (VRS) API provides secure, real-time access to roaming SIM usage data using IMSI as the key identifier.  
The API complies with TMF635 standards and uses OAuth2 for secure access. 
Each B2B partner on-boarded to use the API will be issued a set of credentials which will be used to generate a temporary token as an authentication claim within a JWT bearer flow. These credentials will be rotated on a regular basis.  
The API will validate partner ownership of the IMSI before retrieving and returning details.  
The data returned will include fields such as below, as per the specification made available, of the current or last data session within the previous 2 hour period of API being invoked. No PII will be available. 

  • Usage Begin Period
  • Download bytes
  • Download througput kbps
  • Download throughput in Mbps
  • Upload Active Miliseconds
  • Upload bytes
  • Upload throughput kbps
  • Upload throughput in Mbps
  • MSISDN TAC
  • Visited Country
  • Visited Mobile Country Code
  • Visited Mobile Network Code
  • Visited Public Land Mobile Network
  • Visted TADIG
  • IMEI TAC
  • Radio Access Technology
  • IMSI TAC
  • Data used in current session if the consumer has an active session on
  • APN Name
  • Cell type (4G, 5G etc)
  • Handset Manufacturer
  • Handset Model
  • Handset OS

A partner will only have access to query IMSI’s assigned to them. 
The API is designed to only be invoked from a partner via an agent from a CRM like system, so it will not support a high TPS. Partners will have a n API call limit set per day.

Vodafone Developer Portal

Discover, try, and purchase our APIs to start building your own apps