---
title: "Get roaming status for a device"
url: "https://developer.pxg.konera.com/apis/device-roaming-status-apiindia-1/versions/b461fc75-dd49-48b6-af61-51ff2d1ae5fe/operations/getRoamingStatus"
---

> Full API specification: https://developer.pxg.konera.com/apis/device-roaming-status-apiindia-1/versions/b461fc75-dd49-48b6-af61-51ff2d1ae5fe.md

# Get roaming status for a device

`POST` `/device-roaming-status/v1/status`

Operation ID: `getRoamingStatus`

## Header parameters

- `x-correlation-id` (string, optional) - Correlation ID for request tracing

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Roaming status retrieved successfully
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `500` - Internal server error

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Device Roaming Status
  version: 1.0.0
servers:
  - url: https://api.pxg.konera.com/camara
paths:
  /device-roaming-status/v1/status:
    post:
      tags:
        - Device Roaming Status
      summary: Get roaming status for a device
      operationId: getRoamingStatus
      parameters:
        - name: x-correlation-id
          in: header
          required: false
          description: Correlation ID for request tracing
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RoamingStatusRequest"
      responses:
        "200":
          description: Roaming status retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RoamingStatusResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
security:
  - OAuth2ClientCredentials:
      - device-roaming-status.read
components:
  schemas:
    RoamingStatusRequest:
      type: object
      required:
        - phoneNumber
      properties:
        phoneNumber:
          type: string
          description: MSISDN in E.164 format
          example: "+919036499174"
    RoamingStatusResponse:
      type: object
      required:
        - isRoaming
        - assessedAt
      properties:
        isRoaming:
          type: boolean
          description: Indicates whether the device is roaming
          example: false
        visitedCountry:
          type: string
          nullable: true
          description: ISO 3166-1 alpha-2 country code when roaming
          example: AE
        assessedAt:
          type: string
          format: date-time
          description: Time when roaming status was assessed
          example: 2026-02-05T10:30:00Z
    Error:
      type: object
      required:
        - status
        - code
        - message
      properties:
        status:
          type: integer
          example: 400
        code:
          type: string
          example: INVALID_ARGUMENT
        message:
          type: string
          example: Invalid request
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.example.com/oauth2/token
          scopes:
            device-roaming-status.read: Read device roaming status
```