Skip to main content
POST
/
api
/
v1
/
partner
/
account-status
Account Status
curl --request POST \
  --url https://api.example.com/api/v1/partner/account-status \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-ID: <x-partner-id>' \
  --header 'X-Signature: <x-signature>' \
  --data '
{
  "phone_number": "<string>",
  "card_serial": "<string>"
}
'

Get Account Status

Check if a subscriber account exists by phone number or card serial. Requires HMAC signature.

Endpoint

POST /api/v1/partner/account-status

Authentication

X-Signature
string
required
HMAC-SHA256 signature of request body
X-Partner-ID
string
required
Your partner identifier (e.g., VULT)

Request Body

phone_number
string
Phone number (e.g., 0771234567)
card_serial
string
Card serial number (e.g., OLIV0001)
Provide either phone_number or card_serial

Response

{
  "success": true,
  "exists": true,
  "status": "active"
}

HMAC Signature

Generate signature:
const signature = crypto
  .createHmac('sha256', yourSecretKey)
  .update(JSON.stringify(requestBody))
  .digest('hex');

Errors

CodeDescription
400Invalid request
401Invalid signature
404User not found