GET /ping — API Key Verification and Account Identity

Use GET /ping as your first call whenever you set up a new integration or rotate an API key. It confirms your key is active, tells you which account it belongs to, and lists the scopes it carries — all without touching any merchant data.

Authentication

Send your API key as a Bearer token or in the X-Api-Key header. No additional scope is needed.

Header	Value
`Authorization`	`Bearer nsk_live_YOUR_KEY`
`X-Api-Key`	`nsk_live_YOUR_KEY` (alternative)

When you include the X-Merchant-Id header, the response also contains an activeMerchant object with the resolved merchant’s details. This is useful for confirming that a merchant ID you intend to use is correctly linked to your company account.

Request

Basic health check

curl "https://now.com.eg/api/public/v1/ping" \
  -H "Authorization: Bearer nsk_live_YOUR_KEY"

With merchant context

curl "https://now.com.eg/api/public/v1/ping" \
  -H "Authorization: Bearer nsk_live_YOUR_KEY" \
  -H "X-Merchant-Id: shop_123"

Response

200 — Success

{
  "success": true,
  "data": {
    "message": "Now Shipping Public API v1",
    "account": {
      "id": "66e0a1b2c3d4e5f6a7b8c9d0",
      "name": "My Platform",
      "brandName": "My Platform",
      "businessAccountCode": "12345678",
      "isCompanyAccount": true
    },
    "scopes": ["orders", "pickups", "merchants"],
    "keyPrefix": "nsk_live"
  }
}

string

API version string — always "Now Shipping Public API v1".

object

Details of the business account associated with this API key.

Show account fields

string

MongoDB _id of the business account.

string

Full account name.

string

Public-facing brand name.

string

8-digit business code auto-assigned by Now Shipping.

boolean

true for multi-tenant company integrators. Company keys must send X-Merchant-Id on all order and pickup requests.

string[]

Scopes enabled on this key — any combination of orders, pickups, and merchants.

string

Key prefix, always nsk_live for production keys.

Errors

Status	Code	Cause
`401`	`UNAUTHORIZED`	API key is missing, malformed, or revoked.
`403`	`ACCOUNT_REMOVED`	The business account associated with this key has been deleted.

Run GET /ping as a startup check in your service. If it returns 401, stop immediately and alert your team — do not proceed to create orders with an invalid key.

System

Merchants

Fees

Orders

Pickups

Reference

GET /ping — API Key Verification and Account Identity

Authentication

Request

Basic health check

With merchant context

Response

200 — Success

Errors

​Authentication

​Request

​Basic health check

​With merchant context

​Response

​200 — Success

​Errors

Authentication

Request

Basic health check

With merchant context

Response

200 — Success

Errors