Search
K

Device Roaming Status API

Overview

The Device Roaming Status API determines whether a device is currently roaming and, if available, returns the visited country.

  • Version: 1.0.0
  • Base URL: https://api.pxg.konera.com/camara
  • Path: /device-roaming-status/v1/retrieve
  • OpenAPI: device-roaming-status.json

Typical use cases

  • Travel risk detection – Adjust fraud rules when a user is roaming in a different country.
  • Roaming offers – Trigger roaming bundles or notifications when a subscriber starts roaming.
  • Compliance and geo‑controls – Enforce country‑based restrictions when traffic originates from certain jurisdictions.

Security

  • OAuth2 Client Credentials
    • Token URL: https://auth.konera.com/oauth2/token
    • Scope: device-roaming-status.read – Read device roaming status

Headers

  • x-correlation-id (optional, string) – Correlation ID for request tracing.

Request

POST https://api.pxg.konera.com/camara/device-roaming-status/v1/retrieve

Body schema: RoamingStatusRequest

{
  "phoneNumber": "+919036499174"
}
  • phoneNumber (string, required) – MSISDN in E.164 format.

Responses

200 – Roaming status retrieved successfully

Body schema: RoamingStatusResponse

{
  "isRoaming": false,
  "visitedCountry": "AE",
  "assessedAt": "2026-02-05T10:30:00Z"
}
  • isRoaming (boolean) – Indicates whether the device is roaming.
  • visitedCountry (string, nullable) – ISO 3166-1 alpha-2 country code of the visited country when roaming.
  • assessedAt (string, date-time) – Time when roaming status was assessed.

HTTP status codes

Standard Error schema with:

  • 200 OK – Roaming status successfully retrieved.
  • 400 Bad Request – Invalid phone number or request payload.
  • 401 Unauthorized – Invalid/missing token.
  • 403 Forbidden – Caller not permitted to use roaming signals.
  • 429 Too Many Requests – Rate limit exceeded.
  • 500 Internal Server Error – Unexpected server error.