---
title: "Retrieve device reachability status"
url: "https://developer.pxg.konera.com/apis/number-verification-3-legged-1/versions/5ffb8ae3-90a4-4c8f-8160-45f4376bb69a/operations/deviceReachability"
---

> Full API specification: https://developer.pxg.konera.com/apis/number-verification-3-legged-1/versions/5ffb8ae3-90a4-4c8f-8160-45f4376bb69a.md

# Retrieve device reachability status

`POST` `/device-reachability-status/v1/retrieve`

Operation ID: `deviceReachability`

Indicates whether the specified device is currently reachable on the network.

## Header parameters

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

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Reachability status returned
- `400` - Bad request
- `401` - Unauthorized
- `403` - Forbidden
- `429` - Too Many Requests
- `500` - Internal server error

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Device Reachability Status API
  version: 1.0.0
servers:
  - url: https://api.pxg.konera.com/camara
    description: Production CAMARA API Gateway
paths:
  /device-reachability-status/v1/retrieve:
    post:
      tags:
        - Device Reachability Status
      summary: Retrieve device reachability status
      description: Indicates whether the specified device is currently reachable on
        the network.
      operationId: deviceReachability
      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/DeviceReachabilityRequest"
            example:
              phoneNumber: "+14155550123"
              maxAgeSeconds: 60
      responses:
        "200":
          description: Reachability status returned
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeviceReachabilityResponse"
              example:
                isReachable: true
                assessedAt: 2026-02-10T10:00:00Z
        "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"
        "429":
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
security:
  - OAuth2ClientCredentials:
      - device-reachability.read
components:
  schemas:
    DeviceReachabilityRequest:
      type: object
      required:
        - phoneNumber
      properties:
        phoneNumber:
          type: string
          description: MSISDN in E.164 format
          example: "+14155550123"
        maxAgeSeconds:
          type: integer
          minimum: 0
          nullable: true
          description: Maximum acceptable age of the reachability information in seconds
          example: 60
    DeviceReachabilityResponse:
      type: object
      required:
        - isReachable
        - assessedAt
      properties:
        isReachable:
          type: boolean
          description: Indicates whether the device is currently reachable
          example: true
        assessedAt:
          type: string
          format: date-time
          description: Time when reachability was assessed
          example: 2026-02-10T10:00: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.konera.com/auth/realms/konera/protocol/openid-connect/token
          scopes:
            device-reachability.read: Read device reachability signal
```