---
title: "Get order status"
method: GET
path: "/api/v1/customer/order/{orderId}"
tags: ["Customer API"]
---

# Get order status

`GET /api/v1/customer/order/{orderId}`

## Request

- Base URL: `https://virtualsms.io`
- URL: `https://virtualsms.io/api/v1/customer/order/{orderId}`
- Auth: API key in header `X-API-Key`

Get the current status of an order. Poll every 3-5 seconds until SMS arrives,
or use WebSocket for real-time delivery.

The `messages` array will be empty while waiting, and populated once SMS is received.

## Path parameters

- `orderId` string, uuid, required

## Response `200`

Order status

- object
  - `success` boolean
  - `order_id` string, uuid
  - `phone_number` string
  - `service` string
  - `country` string
  - `status` 'waiting' | 'completed' | 'cancelled' | 'expired'
  - `price` number, float
  - `sms_received` boolean
  - `created_at` string, date-time
  - `expires_at` string, date-time
  - `messages` object[]
    - `sender` string
    - `content` string
    - `received_at` string, date-time

## Other responses

- `401`: Invalid or missing API key
- `404`: Order not found

---

[API](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and.md) · [All operations](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/llms.txt) · [OpenAPI document](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/revisions/be89af981be1?raw)
